Patch 1572 format help for short options slightly more compact to save horizontal space

Title format help for short options slightly more compact to save horizontal space
Superseder Nosy List bf
Related Issues
Status accepted Assigned To

Created on 2017-08-09.11:57:59 by bf, last changed 2017-08-18.19:20:22 by gh.

File name Status Uploaded Type Edit Remove
format-help-for-short-options-slightly-more-compact-to-save-horizontal-space.dpatch bf, 2017-08-09.11:57:59 text/x-darcs-patch
See mailing list archives for discussion on individual patches.
msg19521 (view) Author: bf Date: 2017-08-09.11:57:59
1 patch for repository http://darcs.net/screened:

patch b90b134791d85b8266c570c25ec6ef65d808dcf7
Author: Ben Franksen <ben.franksen@online.de>
Date:   Sat Apr 22 02:13:59 CEST 2017
  * format help for short options slightly more compact to save
horizontal space
msg19542 (view) Author: gh Date: 2017-08-09.18:02:30
There is one detail I don't like, is that it is no longer obvious how to
use short flags with arguments. With this patch, we could think that,
eg, "darcs dist -d=version" is acceptable, while what we want is
actually "darcs dist -d version" (because "=version" gets passed as
msg19545 (view) Author: bf Date: 2017-08-10.15:26:07
There is certainly a trade-off. Indeed the old help output more clearly
shows how to use short switches with arguments. It doesn't tell the full
story, though: the space between short switch and argument is optional,
you can say 'darcs log -pissue1234'. We also support "bundling" of short
switches which works even with arguments (for the last bundled option)
as in 'darcs record -lamText'.

IMO these general command line syntax rules are easy to learn by trial
and error and aren't what --help is normally used for. In the long run,
you need it as a quick reference in case you forgot the name of an
option; or if you are looking for an option that might or might not
exist. For these use cases it is essential that the output can be easily
scanned with a quick glance, which is difficult if almost all of the
explanation lines wrap around in your terminal.
msg19605 (view) Author: gh Date: 2017-08-18.19:20:22
Yeah, after a couple of read I think I got used to it. Sorry for the
bikeshed blocking :)
Date User Action Args
2017-08-09 11:57:59bfcreate
2017-08-09 11:58:22bfsetstatus: needs-screening -> needs-review
2017-08-09 18:02:30ghsetmessages: + msg19542
2017-08-10 15:26:07bfsetmessages: + msg19545
2017-08-18 19:20:22ghsetstatus: needs-review -> accepted
messages: + msg19605