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

[Mathieu Trudel-Lapierre]

** Description changed:

+ [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.

** Also affects: shim-signed (Ubuntu Trusty)
   Importance: Undecided
       Status: New

** Also affects: shim-signed (Ubuntu Xenial)
   Importance: Undecided
       Status: New

** Also affects: shim-signed (Ubuntu Precise)
   Importance: Undecided
       Status: New

** Changed in: shim-signed (Ubuntu Precise)
       Status: New => In Progress

** Changed in: shim-signed (Ubuntu Trusty)
       Status: New => In Progress

** Changed in: shim-signed (Ubuntu Xenial)
       Status: New => In Progress

** Changed in: shim-signed (Ubuntu Precise)
   Importance: Undecided => Medium

** Changed in: shim-signed (Ubuntu Trusty)
   Importance: Undecided => Medium

** Changed in: shim-signed (Ubuntu Xenial)
   Importance: Undecided => Medium

** Changed in: shim-signed (Ubuntu Precise)
     Assignee: (unassigned) => Mathieu Trudel-Lapierre (cyphermox)

** Changed in: shim-signed (Ubuntu Trusty)
     Assignee: (unassigned) => Mathieu Trudel-Lapierre (cyphermox)

** Changed in: shim-signed (Ubuntu Xenial)
     Assignee: (unassigned) => Mathieu Trudel-Lapierre (cyphermox)

-- 
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:
  In Progress
Status in shim-signed source package in Xenial:
  In Progress

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