[Bug 1604936] Re: Please document command-line options with --help and when called incorrectly

[Mathieu Trudel-Lapierre]

Verification-done: update-secureboot-policy now correctly shows --help
text; which documents the default behavior and options.

** Tags removed: verification-needed
** Tags added: v-done-trusty v-done-xenial

** Tags removed: removal-candidate

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to shim-signed in Ubuntu.
https://bugs.launchpad.net/bugs/1604936

Title:
  Please document command-line options with --help and when called
  incorrectly

Status in shim-signed package in Ubuntu:
  Fix Released
Status in shim-signed source package in Precise:
  In Progress
Status in shim-signed source package in Trusty:
  Fix Committed
Status in shim-signed source package in Xenial:
  Fix Committed

Bug description:
  [Impact]
  update-secureboot-policy did not include any help text.

  [Test case]
  - verify 'sudo update-secureboot-policy' works as expected (prompts to disable Secure Boot if it's enabled)
  - verify 'sudo update-secureboot-policy --disable' works as expected (same as above)
  - verify 'sudo update-secureboot-policy --enable' re-enables Secure Boot after it has been disabled (ie. after a run with --disable and a reboot)
  - verify 'update-secureboot-policy --help' displays help text.

  [Regression Potential]
  None. The default behavior without a parameter remains to try to disable Secure Boot if it's not already disabled. --enable is documented behind a new parameter --help which displays usage information.

  ---

  Subject says it all.  Having to read the source to discover --enable
  was irksome.  There should probably also be an opposite explicit
  --disable.

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/shim-signed/+bug/1604936/+subscriptions