** Description changed:
+ [ Impact ]
+
+ The primary effect on users from this bug is confusion. According to the
+ manpage, the shortform of "--prompt" is supposed to "p", which breaks
+ conventions of using a dash before shortform arguments. This is a typo and not
+ an intentional formatting.
+
+ The fix is to append a dash ('-') to the shortform. It could only ever be
+ justified to include this fix amongst more important fixes as it is primarily
a
+ correctness and quality of life error.
+
+ [ Test Plan ]
+
+ * Detailed instructions on how to reproduce the bug.
+
+ * These should allow someone who is not familiar with the affected
+ package to reproduce the bug and verify that the updated package
+ fixes the problem.
+
+ * If other testing is appropriate to perform before landing this
+ update, this should also be described here.
+
+ Reproduce the bug
+ -----------------
+
+ * Open the manpage for sudo-rs:
+
+ man sudo-rs
+
+ * Find the --prompt section
+ * Verify the incorrect shortform:
+ ↓
+ p, --prompt=prompt
+ Use a custom authentication prompt with optional escape
sequences.
+
+ Testing proposed
+ ----------------
+
+ * Install the fixed version:
+
+ sudo apt install -t resolute-proposed rust-sudo-rs
+
+ * Open the manpage for sudo-rs:
+
+ man sudo-rs
+
+ * Find the --prompt section
+ * Verify the correct shortform:
+ ↓
+ -p, --prompt=prompt
+ Use a custom authentication prompt with optional escape
sequences.
+
+ [ Where problems could occur ]
+
+ This fix is strictly formatting related and has no code changes. The largest
+ risk is if the formatting fix istelf were to be incorrect, in which case it
+ would most likely surface as the dash being missing once again.
+
+ [ Other Info ]
+
+ * This SRU is part of a larger merge proposal for 26.04.1
+
+ * The fix is also natively part of the 0.2.14-1 upload to Stonking, currently
+ in proposed-migration
+
+ [ Original Description ]
+
--prompt section is missing a dash for the short-form
## Steps to reproduce
1. Open the manpage for sudo:
$ man sudo
2. Go to the --prompt section (search with '/' + --prompt)
## Expected behaviour
Short-form of --prompt has a dash, i.e.:
- -p, --prompt=prompt
- Use a custom authentication prompt with optional escape
sequences.
+ -p, --prompt=prompt
+ Use a custom authentication prompt with optional escape
sequences.
## Actual behaviour
Short-form of --prompt incorrectly has no dash:
- p, --prompt=prompt
- Use a custom authentication prompt with optional escape
sequences.
+ p, --prompt=prompt
+ Use a custom authentication prompt with optional escape
sequences.
** Summary changed:
- --prompt manpage section is missing a dash for the short-form
+ [SRU] --prompt manpage section is missing a dash for the short-form
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/2160220
Title:
[SRU] --prompt manpage section is missing a dash for the short-form
To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/rust-sudo-rs/+bug/2160220/+subscriptions
--
ubuntu-bugs mailing list
[email protected]
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs
