tests/test-help.t
author FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
Thu, 18 Oct 2012 10:31:15 +0900
changeset 17837 b623e323c561
parent 17717 009db477c9fb
child 17981 e689b0d91546
permissions -rw-r--r--
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12328
b63f6422d2a7 tests: fix a bunch of pointless #s in unified tests
Matt Mackall <mpm@selenic.com>
parents: 12316
diff changeset
     1
Short help:
331
55f63f3b6a54 Add a simple testing framework
mpm@selenic.com
parents:
diff changeset
     2
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
     3
  $ hg
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
     4
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
     5
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
     6
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
     7
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
     8
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
     9
   annotate      show changeset information by line for each file
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    10
   clone         make a copy of an existing repository
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    11
   commit        commit the specified files or all outstanding changes
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    12
   diff          diff repository (or selected files)
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    13
   export        dump the header and diffs for one or more changesets
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    14
   forget        forget the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    15
   init          create a new repository in the given directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    16
   log           show revision history of entire repository or files
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    17
   merge         merge working directory with another revision
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    18
   phase         set or show the current phase name
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    19
   pull          pull changes from the specified source
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    20
   push          push changes to the specified destination
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    21
   remove        remove the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    22
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    23
   status        show changed files in the working directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    24
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    25
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    26
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    27
  use "hg help" for the full list of commands or "hg -v" for details
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    28
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    29
  $ hg -q
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    30
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    31
   annotate      show changeset information by line for each file
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    32
   clone         make a copy of an existing repository
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    33
   commit        commit the specified files or all outstanding changes
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    34
   diff          diff repository (or selected files)
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    35
   export        dump the header and diffs for one or more changesets
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    36
   forget        forget the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    37
   init          create a new repository in the given directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    38
   log           show revision history of entire repository or files
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    39
   merge         merge working directory with another revision
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    40
   phase         set or show the current phase name
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    41
   pull          pull changes from the specified source
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    42
   push          push changes to the specified destination
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    43
   remove        remove the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    44
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    45
   status        show changed files in the working directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    46
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    47
   update        update working directory (or switch revisions)
10110
9ed13f718e53 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 896
diff changeset
    48
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    49
  $ hg help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    50
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    51
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    52
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    53
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    54
   add           add the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    55
   addremove     add all new files, delete all missing files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    56
   annotate      show changeset information by line for each file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    57
   archive       create an unversioned archive of a repository revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    58
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    59
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    60
   bookmarks     track a line of development with movable markers
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    61
   branch        set or show the current branch name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    62
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    63
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    64
   cat           output the current or given revision of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    65
   clone         make a copy of an existing repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    66
   commit        commit the specified files or all outstanding changes
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    67
   copy          mark files as copied for the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    68
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    69
   export        dump the header and diffs for one or more changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    70
   forget        forget the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    71
   graft         copy changes from other branches onto the current branch
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    72
   grep          search for a pattern in specified files and revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    73
   heads         show current repository heads or show branch heads
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    74
   help          show help for a given topic or a help overview
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    75
   identify      identify the working copy or specified revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    76
   import        import an ordered set of patches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    77
   incoming      show new changesets found in source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    78
   init          create a new repository in the given directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    79
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    80
   log           show revision history of entire repository or files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    81
   manifest      output the current or given revision of the project manifest
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    82
   merge         merge working directory with another revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    83
   outgoing      show changesets not found in the destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    84
   parents       show the parents of the working directory or revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    85
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    86
   phase         set or show the current phase name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    87
   pull          pull changes from the specified source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    88
   push          push changes to the specified destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    89
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    90
   remove        remove the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    91
   rename        rename files; equivalent of copy + remove
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    92
   resolve       redo merges or set/view the merge status of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    93
   revert        restore files to their checkout state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    94
   rollback      roll back the last transaction (dangerous)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    95
   root          print the root (top) of the current working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    96
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    97
   showconfig    show combined config settings from all hgrc files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    98
   status        show changed files in the working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    99
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   100
   tag           add one or more tags for the current or given revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   101
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   102
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   103
   unbundle      apply one or more changegroup files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   104
   update        update working directory (or switch revisions)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   105
   verify        verify the integrity of the repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   106
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   107
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   108
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   109
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   110
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   111
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   112
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   113
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   114
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   115
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   116
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   117
   hgignore      Syntax for Mercurial Ignore Files
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   118
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   119
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   120
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   121
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   122
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   123
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   124
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   125
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   126
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   127
   urls          URL Paths
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   128
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   129
  use "hg -v help" to show builtin aliases and global options
10446
a565a2445eb5 commands: add verbose example to help text for add
Martin Geisler <mg@lazybytes.net>
parents: 10144
diff changeset
   130
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   131
  $ hg -q help
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   132
   add           add the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   133
   addremove     add all new files, delete all missing files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   134
   annotate      show changeset information by line for each file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   135
   archive       create an unversioned archive of a repository revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   136
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   137
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   138
   bookmarks     track a line of development with movable markers
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   139
   branch        set or show the current branch name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   140
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   141
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   142
   cat           output the current or given revision of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   143
   clone         make a copy of an existing repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   144
   commit        commit the specified files or all outstanding changes
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   145
   copy          mark files as copied for the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   146
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   147
   export        dump the header and diffs for one or more changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   148
   forget        forget the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   149
   graft         copy changes from other branches onto the current branch
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   150
   grep          search for a pattern in specified files and revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   151
   heads         show current repository heads or show branch heads
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   152
   help          show help for a given topic or a help overview
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   153
   identify      identify the working copy or specified revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   154
   import        import an ordered set of patches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   155
   incoming      show new changesets found in source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   156
   init          create a new repository in the given directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   157
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   158
   log           show revision history of entire repository or files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   159
   manifest      output the current or given revision of the project manifest
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   160
   merge         merge working directory with another revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   161
   outgoing      show changesets not found in the destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   162
   parents       show the parents of the working directory or revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   163
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   164
   phase         set or show the current phase name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   165
   pull          pull changes from the specified source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   166
   push          push changes to the specified destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   167
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   168
   remove        remove the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   169
   rename        rename files; equivalent of copy + remove
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   170
   resolve       redo merges or set/view the merge status of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   171
   revert        restore files to their checkout state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   172
   rollback      roll back the last transaction (dangerous)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   173
   root          print the root (top) of the current working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   174
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   175
   showconfig    show combined config settings from all hgrc files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   176
   status        show changed files in the working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   177
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   178
   tag           add one or more tags for the current or given revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   179
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   180
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   181
   unbundle      apply one or more changegroup files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   182
   update        update working directory (or switch revisions)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   183
   verify        verify the integrity of the repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   184
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   185
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   186
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   187
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   188
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   189
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   190
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   191
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   192
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   193
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   194
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   195
   hgignore      Syntax for Mercurial Ignore Files
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   196
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   197
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   198
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   199
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   200
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   201
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   202
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   203
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   204
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   205
   urls          URL Paths
10121
ac212bcc852b test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10110
diff changeset
   206
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   207
Test short command list with verbose option
10139
d09bed527343 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10121
diff changeset
   208
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   209
  $ hg -v help shortlist
15020
607f1434501d help: drop with_version
Matt Mackall <mpm@selenic.com>
parents: 14849
diff changeset
   210
  Mercurial Distributed SCM
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   211
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   212
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   213
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   214
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   215
   annotate, blame
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   216
                 show changeset information by line for each file
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   217
   clone         make a copy of an existing repository
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   218
   commit, ci    commit the specified files or all outstanding changes
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   219
   diff          diff repository (or selected files)
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   220
   export        dump the header and diffs for one or more changesets
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   221
   forget        forget the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   222
   init          create a new repository in the given directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   223
   log, history  show revision history of entire repository or files
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   224
   merge         merge working directory with another revision
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   225
   phase         set or show the current phase name
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   226
   pull          pull changes from the specified source
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   227
   push          push changes to the specified destination
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   228
   remove, rm    remove the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   229
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   230
   status, st    show changed files in the working directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   231
   summary, sum  summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   232
   update, up, checkout, co
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   233
                 update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   234
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   235
  global options:
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   236
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   237
   -R --repository REPO   repository root directory or name of overlay bundle
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   238
                          file
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   239
      --cwd DIR           change working directory
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   240
   -y --noninteractive    do not prompt, automatically pick the first choice for
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   241
                          all prompts
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   242
   -q --quiet             suppress output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   243
   -v --verbose           enable additional output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   244
      --config CONFIG [+] set/override config option (use 'section.name=value')
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   245
      --debug             enable debugging output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   246
      --debugger          start debugger
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   247
      --encoding ENCODE   set the charset encoding (default: ascii)
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   248
      --encodingmode MODE set the charset encoding mode (default: strict)
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   249
      --traceback         always print a traceback on exception
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   250
      --time              time how long the command takes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   251
      --profile           print command execution profile
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   252
      --version           output version information and exit
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   253
   -h --help              display help and exit
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   254
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   255
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   256
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   257
  use "hg help" for the full list of commands
10140
5d868e0565f6 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10139
diff changeset
   258
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   259
  $ hg add -h
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   260
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   261
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   262
  add the specified files on the next commit
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   263
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   264
      Schedule files to be version controlled and added to the repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   265
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   266
      The files will be added to the repository at the next commit. To undo an
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   267
      add before that, see "hg forget".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   268
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   269
      If no names are given, add all files to the repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   270
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   271
      Returns 0 if all files are successfully added.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   272
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   273
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   274
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   275
   -I --include PATTERN [+] include names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   276
   -X --exclude PATTERN [+] exclude names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   277
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   278
   -n --dry-run             do not perform actions, just print output
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   279
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   280
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   281
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   282
  use "hg -v help add" to show more complete help and the global options
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   283
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   284
Verbose help for add
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   285
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   286
  $ hg add -hv
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   287
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   288
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   289
  add the specified files on the next commit
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   290
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   291
      Schedule files to be version controlled and added to the repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   292
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   293
      The files will be added to the repository at the next commit. To undo an
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   294
      add before that, see "hg forget".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   295
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   296
      If no names are given, add all files to the repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   297
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   298
      An example showing how new (unknown) files are added automatically by "hg
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   299
      add":
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   300
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   301
        $ ls
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   302
        foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   303
        $ hg status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   304
        ? foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   305
        $ hg add
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   306
        adding foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   307
        $ hg status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   308
        A foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   309
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   310
      Returns 0 if all files are successfully added.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   311
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   312
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   313
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   314
   -I --include PATTERN [+] include names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   315
   -X --exclude PATTERN [+] exclude names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   316
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   317
   -n --dry-run             do not perform actions, just print output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   318
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   319
  [+] marked option can be specified multiple times
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   320
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   321
  global options:
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   322
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   323
   -R --repository REPO   repository root directory or name of overlay bundle
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   324
                          file
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   325
      --cwd DIR           change working directory
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   326
   -y --noninteractive    do not prompt, automatically pick the first choice for
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   327
                          all prompts
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   328
   -q --quiet             suppress output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   329
   -v --verbose           enable additional output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   330
      --config CONFIG [+] set/override config option (use 'section.name=value')
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   331
      --debug             enable debugging output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   332
      --debugger          start debugger
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   333
      --encoding ENCODE   set the charset encoding (default: ascii)
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   334
      --encodingmode MODE set the charset encoding mode (default: strict)
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   335
      --traceback         always print a traceback on exception
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   336
      --time              time how long the command takes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   337
      --profile           print command execution profile
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   338
      --version           output version information and exit
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   339
   -h --help              display help and exit
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   340
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   341
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   342
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   343
Test help option with version option
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   344
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   345
  $ hg add -h --version
12376
97ffc68f71d3 tests: add glob matching for unified tests
Brodie Rao <brodie@bitheap.org>
parents: 12375
diff changeset
   346
  Mercurial Distributed SCM (version *) (glob)
12829
01145ee78c53 version: replace email address with url to reduce private mail
Matt Mackall <mpm@selenic.com>
parents: 12828
diff changeset
   347
  (see http://mercurial.selenic.com for more information)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   348
  
15834
65f7e986a0d0 commands: bump copyright year
Martin Geisler <mg@aragost.com>
parents: 15830
diff changeset
   349
  Copyright (C) 2005-2012 Matt Mackall and others
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   350
  This is free software; see the source for copying conditions. There is NO
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   351
  warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
331
55f63f3b6a54 Add a simple testing framework
mpm@selenic.com
parents:
diff changeset
   352
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   353
  $ hg add --skjdfks
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   354
  hg add: option --skjdfks not recognized
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   355
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   356
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   357
  add the specified files on the next commit
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   358
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   359
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   360
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   361
   -I --include PATTERN [+] include names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   362
   -X --exclude PATTERN [+] exclude names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   363
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   364
   -n --dry-run             do not perform actions, just print output
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   365
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   366
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   367
  
13950
14d0553bd48b help: do not show full help text for command on option errors
Adrian Buehlmann <adrian@cadifra.com>
parents: 13888
diff changeset
   368
  use "hg help add" to show the full help text
12316
4134686b83e1 tests: add exit codes to unified tests
Matt Mackall <mpm@selenic.com>
parents: 12270
diff changeset
   369
  [255]
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   370
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   371
Test ambiguous command help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   372
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   373
  $ hg help ad
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   374
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   375
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   376
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   377
   addremove     add all new files, delete all missing files
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   378
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   379
  use "hg -v help ad" to show builtin aliases and global options
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   380
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   381
Test command without options
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   382
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   383
  $ hg help verify
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   384
  hg verify
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   385
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   386
  verify the integrity of the repository
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   387
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   388
      Verify the integrity of the current repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   389
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   390
      This will perform an extensive check of the repository's integrity,
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   391
      validating the hashes and checksums of each entry in the changelog,
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   392
      manifest, and tracked files, as well as the integrity of their crosslinks
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   393
      and indices.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   394
  
17717
009db477c9fb help: add information about recovery from corruption to help of "verify"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17648
diff changeset
   395
      Please see http://mercurial.selenic.com/wiki/RepositoryCorruption for more
009db477c9fb help: add information about recovery from corruption to help of "verify"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17648
diff changeset
   396
      information about recovery from corruption of the repository.
009db477c9fb help: add information about recovery from corruption to help of "verify"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17648
diff changeset
   397
  
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   398
      Returns 0 on success, 1 if errors are encountered.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   399
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   400
  use "hg -v help verify" to show the global options
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   401
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   402
  $ hg help diff
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   403
  hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   404
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   405
  diff repository (or selected files)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   406
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   407
      Show differences between revisions for the specified files.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   408
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   409
      Differences between files are shown using the unified diff format.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   410
  
12389
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   411
      Note:
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   412
         diff may generate unexpected results for merges, as it will default to
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   413
         comparing against the working directory's first parent changeset if no
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   414
         revisions are specified.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   415
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   416
      When two revision arguments are given, then changes are shown between
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   417
      those revisions. If only one revision is specified then that revision is
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   418
      compared to the working directory, and, when no revisions are specified,
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   419
      the working directory files are compared to its parent.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   420
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   421
      Alternatively you can specify -c/--change with a revision to see the
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   422
      changes in that changeset relative to its first parent.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   423
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   424
      Without the -a/--text option, diff will avoid generating diffs of files it
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   425
      detects as binary. With -a, diff will generate a diff anyway, probably
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   426
      with undesirable results.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   427
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   428
      Use the -g/--git option to generate diffs in the git extended diff format.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   429
      For more information, read "hg help diffs".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   430
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   431
      Returns 0 on success.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   432
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   433
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   434
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   435
   -r --rev REV [+]         revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   436
   -c --change REV          change made by revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   437
   -a --text                treat all files as text
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   438
   -g --git                 use git extended diff format
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   439
      --nodates             omit dates from diff headers
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   440
   -p --show-function       show which function each change is in
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   441
      --reverse             produce a diff that undoes the changes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   442
   -w --ignore-all-space    ignore white space when comparing lines
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   443
   -b --ignore-space-change ignore changes in the amount of white space
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   444
   -B --ignore-blank-lines  ignore changes whose lines are all blank
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   445
   -U --unified NUM         number of lines of context to show
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   446
      --stat                output diffstat-style summary of changes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   447
   -I --include PATTERN [+] include names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   448
   -X --exclude PATTERN [+] exclude names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   449
   -S --subrepos            recurse into subrepositories
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   450
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   451
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   452
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   453
  use "hg -v help diff" to show more complete help and the global options
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   454
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   455
  $ hg help status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   456
  hg status [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   457
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   458
  aliases: st
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   459
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   460
  show changed files in the working directory
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   461
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   462
      Show status of files in the repository. If names are given, only files
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   463
      that match are shown. Files that are clean or ignored or the source of a
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   464
      copy/move operation, are not listed unless -c/--clean, -i/--ignored,
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   465
      -C/--copies or -A/--all are given. Unless options described with "show
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   466
      only ..." are given, the options -mardu are used.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   467
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   468
      Option -q/--quiet hides untracked (unknown and ignored) files unless
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   469
      explicitly requested with -u/--unknown or -i/--ignored.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   470
  
12390
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   471
      Note:
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   472
         status may appear to disagree with diff if permissions have changed or
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   473
         a merge has occurred. The standard diff format does not report
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   474
         permission changes and diff only reports changes relative to one merge
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   475
         parent.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   476
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   477
      If one revision is given, it is used as the base revision. If two
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   478
      revisions are given, the differences between them are shown. The --change
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   479
      option can also be used as a shortcut to list the changed files of a
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   480
      revision from its first parent.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   481
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   482
      The codes used to show the status of files are:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   483
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   484
        M = modified
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   485
        A = added
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   486
        R = removed
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   487
        C = clean
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   488
        ! = missing (deleted by non-hg command, but still tracked)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   489
        ? = not tracked
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   490
        I = ignored
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   491
          = origin of the previous file listed as A (added)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   492
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   493
      Returns 0 on success.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   494
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   495
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   496
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   497
   -A --all                 show status of all files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   498
   -m --modified            show only modified files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   499
   -a --added               show only added files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   500
   -r --removed             show only removed files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   501
   -d --deleted             show only deleted (but tracked) files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   502
   -c --clean               show only files without changes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   503
   -u --unknown             show only unknown (not tracked) files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   504
   -i --ignored             show only ignored files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   505
   -n --no-status           hide status prefix
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   506
   -C --copies              show source of copied files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   507
   -0 --print0              end filenames with NUL, for use with xargs
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   508
      --rev REV [+]         show difference from revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   509
      --change REV          list the changed files of a revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   510
   -I --include PATTERN [+] include names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   511
   -X --exclude PATTERN [+] exclude names matching the given patterns
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   512
   -S --subrepos            recurse into subrepositories
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   513
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   514
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   515
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   516
  use "hg -v help status" to show more complete help and the global options
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   517
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   518
  $ hg -q help status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   519
  hg status [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   520
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   521
  show changed files in the working directory
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   522
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   523
  $ hg help foo
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   524
  hg: unknown command 'foo'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   525
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   526
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   527
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   528
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   529
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   530
   annotate      show changeset information by line for each file
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   531
   clone         make a copy of an existing repository
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   532
   commit        commit the specified files or all outstanding changes
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   533
   diff          diff repository (or selected files)
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   534
   export        dump the header and diffs for one or more changesets
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   535
   forget        forget the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   536
   init          create a new repository in the given directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   537
   log           show revision history of entire repository or files
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   538
   merge         merge working directory with another revision
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   539
   phase         set or show the current phase name
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   540
   pull          pull changes from the specified source
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   541
   push          push changes to the specified destination
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   542
   remove        remove the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   543
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   544
   status        show changed files in the working directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   545
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   546
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   547
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   548
  use "hg help" for the full list of commands or "hg -v" for details
12316
4134686b83e1 tests: add exit codes to unified tests
Matt Mackall <mpm@selenic.com>
parents: 12270
diff changeset
   549
  [255]
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   550
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   551
  $ hg skjdfks
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   552
  hg: unknown command 'skjdfks'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   553
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   554
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   555
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   556
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   557
   add           add the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   558
   annotate      show changeset information by line for each file
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   559
   clone         make a copy of an existing repository
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   560
   commit        commit the specified files or all outstanding changes
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   561
   diff          diff repository (or selected files)
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   562
   export        dump the header and diffs for one or more changesets
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   563
   forget        forget the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   564
   init          create a new repository in the given directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   565
   log           show revision history of entire repository or files
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   566
   merge         merge working directory with another revision
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   567
   phase         set or show the current phase name
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   568
   pull          pull changes from the specified source
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   569
   push          push changes to the specified destination
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   570
   remove        remove the specified files on the next commit
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   571
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   572
   status        show changed files in the working directory
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   573
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   574
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   575
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   576
  use "hg help" for the full list of commands or "hg -v" for details
12316
4134686b83e1 tests: add exit codes to unified tests
Matt Mackall <mpm@selenic.com>
parents: 12270
diff changeset
   577
  [255]
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   578
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   579
  $ cat > helpext.py <<EOF
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   580
  > import os
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   581
  > from mercurial import commands
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   582
  > 
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   583
  > def nohelp(ui, *args, **kwargs):
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   584
  >     pass
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   585
  > 
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   586
  > cmdtable = {
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   587
  >     "nohelp": (nohelp, [], "hg nohelp"),
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   588
  > }
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   589
  > 
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   590
  > commands.norepo += ' nohelp'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   591
  > EOF
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   592
  $ echo '[extensions]' >> $HGRCPATH
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   593
  $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   594
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   595
Test command with no help text
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   596
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   597
  $ hg help nohelp
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   598
  hg nohelp
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   599
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   600
  (no help text available)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   601
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   602
  use "hg -v help nohelp" to show the global options
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   603
16884
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   604
  $ hg help -k nohelp
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   605
  Commands:
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   606
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   607
   nohelp hg nohelp
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   608
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   609
  Extension Commands:
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   610
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   611
   nohelp (no help text available)
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   612
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   613
Test that default list of commands omits extension commands
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   614
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   615
  $ hg help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   616
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   617
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   618
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   619
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   620
   add           add the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   621
   addremove     add all new files, delete all missing files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   622
   annotate      show changeset information by line for each file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   623
   archive       create an unversioned archive of a repository revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   624
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   625
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   626
   bookmarks     track a line of development with movable markers
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   627
   branch        set or show the current branch name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   628
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   629
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   630
   cat           output the current or given revision of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   631
   clone         make a copy of an existing repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   632
   commit        commit the specified files or all outstanding changes
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   633
   copy          mark files as copied for the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   634
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   635
   export        dump the header and diffs for one or more changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   636
   forget        forget the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   637
   graft         copy changes from other branches onto the current branch
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   638
   grep          search for a pattern in specified files and revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   639
   heads         show current repository heads or show branch heads
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   640
   help          show help for a given topic or a help overview
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   641
   identify      identify the working copy or specified revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   642
   import        import an ordered set of patches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   643
   incoming      show new changesets found in source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   644
   init          create a new repository in the given directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   645
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   646
   log           show revision history of entire repository or files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   647
   manifest      output the current or given revision of the project manifest
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   648
   merge         merge working directory with another revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   649
   outgoing      show changesets not found in the destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   650
   parents       show the parents of the working directory or revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   651
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   652
   phase         set or show the current phase name
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   653
   pull          pull changes from the specified source
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   654
   push          push changes to the specified destination
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   655
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   656
   remove        remove the specified files on the next commit
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   657
   rename        rename files; equivalent of copy + remove
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   658
   resolve       redo merges or set/view the merge status of files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   659
   revert        restore files to their checkout state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   660
   rollback      roll back the last transaction (dangerous)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   661
   root          print the root (top) of the current working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   662
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   663
   showconfig    show combined config settings from all hgrc files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   664
   status        show changed files in the working directory
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   665
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   666
   tag           add one or more tags for the current or given revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   667
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   668
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   669
   unbundle      apply one or more changegroup files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   670
   update        update working directory (or switch revisions)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   671
   verify        verify the integrity of the repository
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   672
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   673
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   674
  enabled extensions:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   675
  
15861
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   676
   helpext       (no help text available)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   677
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   678
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   679
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   680
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   681
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   682
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   683
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   684
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   685
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   686
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   687
   hgignore      Syntax for Mercurial Ignore Files
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   688
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   689
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   690
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   691
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   692
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   693
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   694
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   695
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   696
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   697
   urls          URL Paths
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   698
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   699
  use "hg -v help" to show builtin aliases and global options
10142
44fa0e205ec9 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10141
diff changeset
   700
13888
9e5407a67dea help: sort help topics to make the output more readable (issue2751)
Yun Lee <yunlee.bj@gmail.com>
parents: 13584
diff changeset
   701
9e5407a67dea help: sort help topics to make the output more readable (issue2751)
Yun Lee <yunlee.bj@gmail.com>
parents: 13584
diff changeset
   702
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   703
Test list of commands with command with no help text
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   704
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   705
  $ hg help helpext
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   706
  helpext extension - no help text available
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   707
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   708
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   709
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   710
   nohelp        (no help text available)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   711
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   712
  use "hg -v help helpext" to show builtin aliases and global options
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   713
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   714
Test a help topic
10143
f6ac05b5684b test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10142
diff changeset
   715
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   716
  $ hg help revs
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   717
  Specifying Single Revisions
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   718
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   719
      Mercurial supports several ways to specify individual revisions.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   720
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   721
      A plain integer is treated as a revision number. Negative integers are
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   722
      treated as sequential offsets from the tip, with -1 denoting the tip, -2
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   723
      denoting the revision prior to the tip, and so forth.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   724
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   725
      A 40-digit hexadecimal string is treated as a unique revision identifier.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   726
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   727
      A hexadecimal string less than 40 characters long is treated as a unique
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   728
      revision identifier and is referred to as a short-form identifier. A
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   729
      short-form identifier is only valid if it is the prefix of exactly one
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   730
      full-length identifier.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   731
  
16740
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   732
      Any other string is treated as a bookmark, tag, or branch name. A bookmark
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   733
      is a movable pointer to a revision. A tag is a permanent name associated
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   734
      with a revision. A branch name denotes the tipmost revision of that
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   735
      branch. Bookmark, tag, and branch names must not contain the ":"
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   736
      character.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   737
  
16740
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   738
      The reserved name "tip" always identifies the most recent revision.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   739
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   740
      The reserved name "null" indicates the null revision. This is the revision
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   741
      of an empty repository, and the parent of revision 0.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   742
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   743
      The reserved name "." indicates the working directory parent. If no
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   744
      working directory is checked out, it is equivalent to null. If an
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   745
      uncommitted merge is in progress, "." is the revision of the first parent.
12820
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   746
13584
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   747
Test templating help
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   748
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   749
  $ hg help templating | egrep '(desc|diffstat|firstline|nonempty)  '
15861
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   750
      desc          String. The text of the changeset description.
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   751
      diffstat      String. Statistics of changes with the following format:
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   752
      firstline     Any text. Returns the first line of text.
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   753
      nonempty      Any text. Returns '(none)' if the string is empty.
13584
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   754
12820
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   755
Test help hooks
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   756
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   757
  $ cat > helphook1.py <<EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   758
  > from mercurial import help
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   759
  > 
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   760
  > def rewrite(topic, doc):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   761
  >     return doc + '\nhelphook1\n'
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   762
  > 
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   763
  > def extsetup(ui):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   764
  >     help.addtopichook('revsets', rewrite)
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   765
  > EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   766
  $ cat > helphook2.py <<EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   767
  > from mercurial import help
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   768
  > 
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   769
  > def rewrite(topic, doc):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   770
  >     return doc + '\nhelphook2\n'
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   771
  > 
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   772
  > def extsetup(ui):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   773
  >     help.addtopichook('revsets', rewrite)
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   774
  > EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   775
  $ echo '[extensions]' >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   776
  $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   777
  $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   778
  $ hg help revsets | grep helphook
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   779
      helphook1
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   780
      helphook2
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   781
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   782
Test keyword search help
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   783
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   784
  $ hg help -k clone
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   785
  Topics:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   786
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   787
   config     Configuration Files
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   788
   extensions Using Additional Features
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   789
   glossary   Glossary
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   790
   phases     Working with Phases
17322
7124f984dc8d help: use the first topic name from helptable, not the longest alias
Mads Kiilerich <mads@kiilerich.com>
parents: 16949
diff changeset
   791
   subrepos   Subrepositories
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   792
   urls       URL Paths
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   793
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   794
  Commands:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   795
  
16949
66721a0d2249 help: sort results from keyword search
Mads Kiilerich <mads@kiilerich.com>
parents: 16942
diff changeset
   796
   clone  make a copy of an existing repository
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   797
   paths  show aliases for remote repositories
16949
66721a0d2249 help: sort results from keyword search
Mads Kiilerich <mads@kiilerich.com>
parents: 16942
diff changeset
   798
   update update working directory (or switch revisions)
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   799
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   800
  Extensions:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   801
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   802
   relink recreates hardlinks between repository clones
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   803
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   804
  Extension Commands:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   805
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   806
   qclone clone main and patch repository at same time
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   807
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   808
Test omit indicating for help
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   809
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   810
  $ cat > addverboseitems.py <<EOF
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   811
  > '''extension to test omit indicating.
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   812
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   813
  > This paragraph is never omitted (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   814
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   815
  > .. container:: verbose
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   816
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   817
  >   This paragraph is omitted,
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   818
  >   if :hg:\`help\` is invoked witout \`\`-v\`\` (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   819
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   820
  > This paragraph is never omitted, too (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   821
  > '''
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   822
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   823
  > from mercurial import help, commands
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   824
  > testtopic = """This paragraph is never omitted (for topic).
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   825
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   826
  > .. container:: verbose
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   827
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   828
  >   This paragraph is omitted,
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   829
  >   if :hg:\`help\` is invoked witout \`\`-v\`\` (for topic)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   830
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   831
  > This paragraph is never omitted, too (for topic)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   832
  > """
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   833
  > def extsetup(ui):
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   834
  >     help.helptable.append((["topic-containing-verbose"],
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   835
  >                            "This is the topic to test omit indicating.",
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   836
  >                            lambda : testtopic))
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   837
  > EOF
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   838
  $ echo '[extensions]' >> $HGRCPATH
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   839
  $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   840
  $ hg help addverboseitems
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   841
  addverboseitems extension - extension to test omit indicating.
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   842
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   843
  This paragraph is never omitted (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   844
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   845
  This paragraph is never omitted, too (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   846
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   847
  use "hg help -v addverboseitems" to show more complete help
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   848
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   849
  no commands defined
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   850
  $ hg help -v addverboseitems
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   851
  addverboseitems extension - extension to test omit indicating.
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   852
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   853
  This paragraph is never omitted (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   854
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   855
  This paragraph is omitted, if "hg help" is invoked witout "-v" (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   856
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   857
  This paragraph is never omitted, too (for extension)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   858
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   859
  no commands defined
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   860
  $ hg help topic-containing-verbose
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   861
  This is the topic to test omit indicating.
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   862
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   863
      This paragraph is never omitted (for topic).
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   864
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   865
      This paragraph is never omitted, too (for topic)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   866
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   867
  use "hg help -v topic-containing-verbose" to show more complete help
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   868
  $ hg help -v topic-containing-verbose
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   869
  This is the topic to test omit indicating.
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   870
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   871
      This paragraph is never omitted (for topic).
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   872
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   873
      This paragraph is omitted, if "hg help" is invoked witout "-v" (for topic)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   874
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   875
      This paragraph is never omitted, too (for topic)
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   876
17648
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   877
Test usage of section marks in help documents
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   878
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   879
  $ cd "$TESTDIR"/../doc
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   880
  $ python check-seclevel.py