Mercurial: tests/test-help.t comparison

comparison tests/test-help.t @ 30152:d65e246100ed

help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)

author	Pierre-Yves David <pierre-yves.david@ens-lyon.org>
date	Sun, 09 Oct 2016 03:11:18 +0200
parents	cd7276f7ea83
children	ff7df4bb75de

comparison

equal deleted inserted replaced

-:381293e1135e
+:d65e246100ed
 -R --repository REPO   repository root directory or name of overlay bundle
 file
 --cwd DIR           change working directory
 -y --noninteractive    do not prompt, automatically pick the first choice for
 all prompts
--q --[no-]quiet        suppress output
+-q --quiet             suppress output
--v --[no-]verbose      enable additional output
+-v --verbose           enable additional output
 --config CONFIG [+] set/override config option (use 'section.name=value')
---[no-]debug        enable debugging output
+--debug             enable debugging output
---[no-]debugger     start debugger
+--debugger          start debugger
 --encoding ENCODE   set the charset encoding (default: ascii)
 --encodingmode MODE set the charset encoding mode (default: strict)
---[no-]traceback    always print a traceback on exception
+--traceback         always print a traceback on exception
---[no-]time         time how long the command takes
+--time              time how long the command takes
---[no-]profile      print command execution profile
+--profile           print command execution profile
 --version           output version information and exit
 -h --help              display help and exit
---[no-]hidden       consider hidden changesets
+--hidden            consider hidden changesets
 (use 'hg help' for the full list of commands)
 $ hg add -h
 hg add [OPTION]... [FILE]...
 options ([+] can be repeated):
 -I --include PATTERN [+] include names matching the given patterns
 -X --exclude PATTERN [+] exclude names matching the given patterns
--S --[no-]subrepos       recurse into subrepositories
+-S --subrepos            recurse into subrepositories
--n --[no-]dry-run        do not perform actions, just print output
+-n --dry-run             do not perform actions, just print output
 (some details hidden, use --verbose to show complete help)
 Verbose help for add
 options ([+] can be repeated):
 -I --include PATTERN [+] include names matching the given patterns
 -X --exclude PATTERN [+] exclude names matching the given patterns
--S --[no-]subrepos       recurse into subrepositories
+-S --subrepos            recurse into subrepositories
--n --[no-]dry-run        do not perform actions, just print output
+-n --dry-run             do not perform actions, just print output
 global options ([+] can be repeated):
 -R --repository REPO   repository root directory or name of overlay bundle
 file
 --cwd DIR           change working directory
 -y --noninteractive    do not prompt, automatically pick the first choice for
 all prompts
--q --[no-]quiet        suppress output
+-q --quiet             suppress output
--v --[no-]verbose      enable additional output
+-v --verbose           enable additional output
 --config CONFIG [+] set/override config option (use 'section.name=value')
---[no-]debug        enable debugging output
+--debug             enable debugging output
---[no-]debugger     start debugger
+--debugger          start debugger
 --encoding ENCODE   set the charset encoding (default: ascii)
 --encodingmode MODE set the charset encoding mode (default: strict)
---[no-]traceback    always print a traceback on exception
+--traceback         always print a traceback on exception
---[no-]time         time how long the command takes
+--time              time how long the command takes
---[no-]profile      print command execution profile
+--profile           print command execution profile
 --version           output version information and exit
 -h --help              display help and exit
---[no-]hidden       consider hidden changesets
+--hidden            consider hidden changesets
 Test the textwidth config option
 $ hg root -h  --config ui.textwidth=50
 hg root
 options ([+] can be repeated):
 -I --include PATTERN [+] include names matching the given patterns
 -X --exclude PATTERN [+] exclude names matching the given patterns
--S --[no-]subrepos       recurse into subrepositories
+-S --subrepos            recurse into subrepositories
--n --[no-]dry-run        do not perform actions, just print output
+-n --dry-run             do not perform actions, just print output
 (use 'hg add -h' to show more help)
 [255]
 Test ambiguous command help
 Returns 0 on success.
 options ([+] can be repeated):
--r --rev REV [+]              revision
+-r --rev REV [+]         revision
--c --change REV               change made by revision
+-c --change REV          change made by revision
--a --[no-]text                treat all files as text
+-a --text                treat all files as text
--g --[no-]git                 use git extended diff format
+-g --git                 use git extended diff format
---[no-]nodates             omit dates from diff headers
+--nodates             omit dates from diff headers
---[no-]noprefix            omit a/ and b/ prefixes from filenames
+--noprefix            omit a/ and b/ prefixes from filenames
--p --[no-]show-function       show which function each change is in
+-p --show-function       show which function each change is in
---[no-]reverse             produce a diff that undoes the changes
+--reverse             produce a diff that undoes the changes
--w --[no-]ignore-all-space    ignore white space when comparing lines
+-w --ignore-all-space    ignore white space when comparing lines
--b --[no-]ignore-space-change ignore changes in the amount of white space
+-b --ignore-space-change ignore changes in the amount of white space
--B --[no-]ignore-blank-lines  ignore changes whose lines are all blank
+-B --ignore-blank-lines  ignore changes whose lines are all blank
--U --unified NUM              number of lines of context to show
+-U --unified NUM         number of lines of context to show
---[no-]stat                output diffstat-style summary of changes
+--stat                output diffstat-style summary of changes
---root DIR                 produce diffs relative to subdirectory
+--root DIR            produce diffs relative to subdirectory
--I --include PATTERN [+]      include names matching the given patterns
+-I --include PATTERN [+] include names matching the given patterns
--X --exclude PATTERN [+]      exclude names matching the given patterns
+-X --exclude PATTERN [+] exclude names matching the given patterns
--S --[no-]subrepos            recurse into subrepositories
+-S --subrepos            recurse into subrepositories
 (some details hidden, use --verbose to show complete help)
 $ hg help status
 hg status [OPTION]... [FILE]...
 Returns 0 on success.
 options ([+] can be repeated):
--A --[no-]all            show status of all files
+-A --all                 show status of all files
--m --[no-]modified       show only modified files
+-m --modified            show only modified files
--a --[no-]added          show only added files
+-a --added               show only added files
--r --[no-]removed        show only removed files
+-r --removed             show only removed files
--d --[no-]deleted        show only deleted (but tracked) files
+-d --deleted             show only deleted (but tracked) files
--c --[no-]clean          show only files without changes
+-c --clean               show only files without changes
--u --[no-]unknown        show only unknown (not tracked) files
+-u --unknown             show only unknown (not tracked) files
--i --[no-]ignored        show only ignored files
+-i --ignored             show only ignored files
--n --[no-]status         hide status prefix
+-n --no-status           hide status prefix
--C --[no-]copies         show source of copied files
+-C --copies              show source of copied files
--0 --[no-]print0         end filenames with NUL, for use with xargs
+-0 --print0              end filenames with NUL, for use with xargs
 --rev REV [+]         show difference from revision
 --change REV          list the changed files of a revision
 -I --include PATTERN [+] include names matching the given patterns
 -X --exclude PATTERN [+] exclude names matching the given patterns
--S --[no-]subrepos       recurse into subrepositories
+-S --subrepos            recurse into subrepositories
 (some details hidden, use --verbose to show complete help)
 $ hg -q help status
 hg status [OPTION]... [FILE]...
 defined by: helpext
 options:
---[no-]remote check for push and pull
+--remote check for push and pull
 (some details hidden, use --verbose to show complete help)
 $ hg help shellalias
 hg shellalias
 options:
 --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
--n --[no-]          normal desc
+-n --               normal desc
 --newline VALUE  line1 line2
 (some details hidden, use --verbose to show complete help)
 $ hg help -k nohelp
 (some details hidden, use --verbose to show complete help)
 test deprecated and experimental options is shown with -v
 $ hg help -v debugoptDEP | grep dopt
---[no-]dopt option is (DEPRECATED)
+--dopt option is (DEPRECATED)
 $ hg help -v debugoptEXP | grep eopt
---[no-]eopt option is (EXPERIMENTAL)
+--eopt option is (EXPERIMENTAL)
 #if gettext
 test deprecated option is hidden with translation with untranslated description
 (use many globy for not failing on changed transaction)
 $ LANGUAGE=sv hg help debugoptDEP
 <td>include names matching the given patterns</td></tr>
 <tr><td>-X</td>
 <td>--exclude PATTERN [+]</td>
 <td>exclude names matching the given patterns</td></tr>
 <tr><td>-S</td>
-<td>--[no-]subrepos</td>
+<td>--subrepos</td>
 <td>recurse into subrepositories</td></tr>
 <tr><td>-n</td>
-<td>--[no-]dry-run</td>
+<td>--dry-run</td>
 <td>do not perform actions, just print output</td></tr>
 </table>
 <p>
 global options ([+] can be repeated):
 </p>
 <td>change working directory</td></tr>
 <tr><td>-y</td>
 <td>--noninteractive</td>
 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
 <tr><td>-q</td>
-<td>--[no-]quiet</td>
+<td>--quiet</td>
 <td>suppress output</td></tr>
 <tr><td>-v</td>
-<td>--[no-]verbose</td>
+<td>--verbose</td>
 <td>enable additional output</td></tr>
 <tr><td></td>
 <td>--config CONFIG [+]</td>
 <td>set/override config option (use 'section.name=value')</td></tr>
 <tr><td></td>
-<td>--[no-]debug</td>
+<td>--debug</td>
 <td>enable debugging output</td></tr>
 <tr><td></td>
-<td>--[no-]debugger</td>
+<td>--debugger</td>
 <td>start debugger</td></tr>
 <tr><td></td>
 <td>--encoding ENCODE</td>
 <td>set the charset encoding (default: ascii)</td></tr>
 <tr><td></td>
 <td>--encodingmode MODE</td>
 <td>set the charset encoding mode (default: strict)</td></tr>
 <tr><td></td>
-<td>--[no-]traceback</td>
+<td>--traceback</td>
 <td>always print a traceback on exception</td></tr>
 <tr><td></td>
-<td>--[no-]time</td>
+<td>--time</td>
 <td>time how long the command takes</td></tr>
 <tr><td></td>
-<td>--[no-]profile</td>
+<td>--profile</td>
 <td>print command execution profile</td></tr>
 <tr><td></td>
 <td>--version</td>
 <td>output version information and exit</td></tr>
 <tr><td>-h</td>
 <td>--help</td>
 <td>display help and exit</td></tr>
 <tr><td></td>
-<td>--[no-]hidden</td>
+<td>--hidden</td>
 <td>consider hidden changesets</td></tr>
 </table>
 </div>
 </div>
 <p>
 options ([+] can be repeated):
 </p>
 <table>
 <tr><td>-A</td>
-<td>--[no-]after</td>
+<td>--after</td>
 <td>record delete for missing files</td></tr>
 <tr><td>-f</td>
-<td>--[no-]force</td>
+<td>--force</td>
 <td>forget added files, delete modified files</td></tr>
 <tr><td>-S</td>
-<td>--[no-]subrepos</td>
+<td>--subrepos</td>
 <td>recurse into subrepositories</td></tr>
 <tr><td>-I</td>
 <td>--include PATTERN [+]</td>
 <td>include names matching the given patterns</td></tr>
 <tr><td>-X</td>
 <td>change working directory</td></tr>
 <tr><td>-y</td>
 <td>--noninteractive</td>
 <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
 <tr><td>-q</td>
-<td>--[no-]quiet</td>
+<td>--quiet</td>
 <td>suppress output</td></tr>
 <tr><td>-v</td>
-<td>--[no-]verbose</td>
+<td>--verbose</td>
 <td>enable additional output</td></tr>
 <tr><td></td>
 <td>--config CONFIG [+]</td>
 <td>set/override config option (use 'section.name=value')</td></tr>
 <tr><td></td>
-<td>--[no-]debug</td>
+<td>--debug</td>
 <td>enable debugging output</td></tr>
 <tr><td></td>
-<td>--[no-]debugger</td>
+<td>--debugger</td>
 <td>start debugger</td></tr>
 <tr><td></td>
 <td>--encoding ENCODE</td>
 <td>set the charset encoding (default: ascii)</td></tr>
 <tr><td></td>
 <td>--encodingmode MODE</td>
 <td>set the charset encoding mode (default: strict)</td></tr>
 <tr><td></td>
-<td>--[no-]traceback</td>
+<td>--traceback</td>
 <td>always print a traceback on exception</td></tr>
 <tr><td></td>
-<td>--[no-]time</td>
+<td>--time</td>
 <td>time how long the command takes</td></tr>
 <tr><td></td>
-<td>--[no-]profile</td>
+<td>--profile</td>
 <td>print command execution profile</td></tr>
 <tr><td></td>
 <td>--version</td>
 <td>output version information and exit</td></tr>
 <tr><td>-h</td>
 <td>--help</td>
 <td>display help and exit</td></tr>
 <tr><td></td>
-<td>--[no-]hidden</td>
+<td>--hidden</td>
 <td>consider hidden changesets</td></tr>
 </table>
 </div>
 </div>

Mercurial > hg

comparison tests/test-help.t @ 30152:d65e246100ed