tests/test-help.t
author Mads Kiilerich <mads@kiilerich.com>
Wed, 12 Dec 2012 02:38:14 +0100
changeset 18369 2150e70c0ee1
parent 18267 5bb610f87d1d
child 18475 075143f60807
permissions -rw-r--r--
churn: sort users with same churn by name This makes the output order well-defined and improves code readability.
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
   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
    19
   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
    20
   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
    21
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    22
   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
    23
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    24
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    25
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    26
  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
    27
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    28
  $ hg -q
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    29
   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
    30
   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
    31
   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
    32
   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
    33
   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
    34
   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
    35
   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
    36
   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
    37
   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
    38
   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
    39
   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
    40
   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
    41
   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
    42
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    43
   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
    44
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
    45
   update        update working directory (or switch revisions)
10110
9ed13f718e53 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 896
diff changeset
    46
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    47
  $ hg help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    48
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    49
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    50
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
    51
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    52
   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
    53
   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
    54
   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
    55
   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
    56
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    57
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    58
   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
    59
   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
    60
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    61
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    62
   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
    63
   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
    64
   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
    65
   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
    66
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    67
   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
    68
   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
    69
   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
    70
   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
    71
   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
    72
   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
    73
   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
    74
   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
    75
   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
    76
   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
    77
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    78
   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
    79
   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
    80
   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
    81
   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
    82
   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
    83
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    84
   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
    85
   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
    86
   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
    87
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    88
   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
    89
   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
    90
   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
    91
   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
    92
   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
    93
   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
    94
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    95
   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
    96
   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
    97
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
    98
   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
    99
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   100
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   101
   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
   102
   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
   103
   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
   104
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   105
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   106
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   107
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   108
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   109
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   110
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   111
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   112
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   113
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   114
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   115
   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
   116
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   117
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   118
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   119
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   120
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   121
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   122
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   123
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   124
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   125
   urls          URL Paths
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   126
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   127
  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
   128
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   129
  $ hg -q help
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   130
   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
   131
   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
   132
   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
   133
   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
   134
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   135
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   136
   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
   137
   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
   138
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   139
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   140
   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
   141
   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
   142
   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
   143
   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
   144
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   145
   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
   146
   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
   147
   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
   148
   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
   149
   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
   150
   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
   151
   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
   152
   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
   153
   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
   154
   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
   155
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   156
   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
   157
   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
   158
   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
   159
   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
   160
   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
   161
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   162
   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
   163
   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
   164
   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
   165
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   166
   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
   167
   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
   168
   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
   169
   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
   170
   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
   171
   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
   172
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   173
   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
   174
   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
   175
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   176
   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
   177
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   178
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   179
   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
   180
   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
   181
   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
   182
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   183
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   184
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   185
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   186
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   187
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   188
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   189
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   190
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   191
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   192
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   193
   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
   194
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   195
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   196
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   197
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   198
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   199
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   200
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   201
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   202
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   203
   urls          URL Paths
10121
ac212bcc852b test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10110
diff changeset
   204
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   205
Test short command list with verbose option
10139
d09bed527343 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10121
diff changeset
   206
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   207
  $ hg -v help shortlist
15020
607f1434501d help: drop with_version
Matt Mackall <mpm@selenic.com>
parents: 14849
diff changeset
   208
  Mercurial Distributed SCM
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   209
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   210
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   211
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   212
   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
   213
   annotate, blame
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   214
                 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
   215
   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
   216
   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
   217
   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
   218
   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
   219
   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
   220
   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
   221
   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
   222
   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
   223
   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
   224
   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
   225
   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
   226
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   227
   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
   228
   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
   229
   update, up, checkout, co
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   230
                 update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   231
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   232
  global options:
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   233
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   234
   -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
   235
                          file
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   236
      --cwd DIR           change working directory
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   237
   -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
   238
                          all prompts
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   239
   -q --quiet             suppress output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   240
   -v --verbose           enable additional output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   241
      --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
   242
      --debug             enable debugging output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   243
      --debugger          start debugger
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   244
      --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
   245
      --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
   246
      --traceback         always print a traceback on exception
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   247
      --time              time how long the command takes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   248
      --profile           print command execution profile
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   249
      --version           output version information and exit
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   250
   -h --help              display help and exit
18267
5bb610f87d1d clfilter: enforce hidden changeset globally
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 17981
diff changeset
   251
      --hidden            consider hidden changesets
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   252
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   253
  [+] marked option can be specified multiple times
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
  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
   256
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   257
  $ hg add -h
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   258
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   259
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   260
  add the specified files on the next commit
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
      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
   263
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   264
      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
   265
      add before that, see "hg forget".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   266
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   267
      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
   268
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   269
      Returns 0 if all files are successfully added.
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
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   272
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   273
   -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
   274
   -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
   275
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   276
   -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
   277
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   278
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   279
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   280
  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
   281
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   282
Verbose help for add
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
  $ hg add -hv
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   285
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   286
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   287
  add the specified files on the next commit
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
      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
   290
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   291
      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
   292
      add before that, see "hg forget".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   293
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   294
      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
   295
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   296
      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
   297
      add":
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   298
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   299
        $ ls
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   300
        foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   301
        $ hg status
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 add
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   304
        adding foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   305
        $ hg status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   306
        A foo.c
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   307
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   308
      Returns 0 if all files are successfully added.
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
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   311
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   312
   -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
   313
   -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
   314
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   315
   -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
   316
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   317
  [+] marked option can be specified multiple times
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   318
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   319
  global options:
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   320
  
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   321
   -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
   322
                          file
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   323
      --cwd DIR           change working directory
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   324
   -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
   325
                          all prompts
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   326
   -q --quiet             suppress output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   327
   -v --verbose           enable additional output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   328
      --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
   329
      --debug             enable debugging output
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   330
      --debugger          start debugger
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   331
      --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
   332
      --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
   333
      --traceback         always print a traceback on exception
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   334
      --time              time how long the command takes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   335
      --profile           print command execution profile
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   336
      --version           output version information and exit
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   337
   -h --help              display help and exit
18267
5bb610f87d1d clfilter: enforce hidden changeset globally
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents: 17981
diff changeset
   338
      --hidden            consider hidden changesets
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   339
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   340
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   341
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   342
Test help option with version option
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   343
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   344
  $ hg add -h --version
12376
97ffc68f71d3 tests: add glob matching for unified tests
Brodie Rao <brodie@bitheap.org>
parents: 12375
diff changeset
   345
  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
   346
  (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
   347
  
15834
65f7e986a0d0 commands: bump copyright year
Martin Geisler <mg@aragost.com>
parents: 15830
diff changeset
   348
  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
   349
  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
   350
  warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
331
55f63f3b6a54 Add a simple testing framework
mpm@selenic.com
parents:
diff changeset
   351
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   352
  $ hg add --skjdfks
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   353
  hg add: option --skjdfks not recognized
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   354
  hg add [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   355
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   356
  add the specified files on the next commit
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   357
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   358
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   359
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   360
   -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
   361
   -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
   362
   -S --subrepos            recurse into subrepositories
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   363
   -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
   364
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   365
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   366
  
13950
14d0553bd48b help: do not show full help text for command on option errors
Adrian Buehlmann <adrian@cadifra.com>
parents: 13888
diff changeset
   367
  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
   368
  [255]
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   369
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   370
Test ambiguous command help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   371
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   372
  $ hg help ad
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   373
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   374
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   375
   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
   376
   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
   377
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   378
  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
   379
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   380
Test command without options
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   381
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   382
  $ hg help verify
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   383
  hg verify
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   384
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   385
  verify the integrity of the repository
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   386
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   387
      Verify the integrity of the current repository.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   388
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   389
      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
   390
      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
   391
      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
   392
      and indices.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   393
  
17717
009db477c9fb help: add information about recovery from corruption to help of "verify"
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17648
diff changeset
   394
      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
   395
      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
   396
  
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   397
      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
   398
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   399
  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
   400
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   401
  $ hg help diff
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   402
  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
   403
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   404
  diff repository (or selected files)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   405
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   406
      Show differences between revisions for the specified files.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   407
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   408
      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
   409
  
12389
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   410
      Note:
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   411
         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
   412
         comparing against the working directory's first parent changeset if no
4ac734b9b3fd Use note admonition
Erik Zielke <ez@aragost.com>
parents: 12376
diff changeset
   413
         revisions are specified.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   414
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   415
      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
   416
      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
   417
      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
   418
      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
   419
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   420
      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
   421
      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
   422
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   423
      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
   424
      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
   425
      with undesirable results.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   426
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   427
      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
   428
      For more information, read "hg help diffs".
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   429
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   430
      Returns 0 on success.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   431
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   432
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   433
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   434
   -r --rev REV [+]         revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   435
   -c --change REV          change made by revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   436
   -a --text                treat all files as text
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   437
   -g --git                 use git extended diff format
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   438
      --nodates             omit dates from diff headers
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   439
   -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
   440
      --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
   441
   -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
   442
   -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
   443
   -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
   444
   -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
   445
      --stat                output diffstat-style summary of changes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   446
   -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
   447
   -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
   448
   -S --subrepos            recurse into subrepositories
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   449
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   450
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   451
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   452
  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
   453
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   454
  $ hg help status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   455
  hg status [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   456
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   457
  aliases: st
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   458
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   459
  show changed files in the working directory
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   460
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   461
      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
   462
      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
   463
      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
   464
      -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
   465
      only ..." are given, the options -mardu are used.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   466
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   467
      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
   468
      explicitly requested with -u/--unknown or -i/--ignored.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   469
  
12390
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   470
      Note:
aff4afdcfd2b Use more note admonitions in help texts
Christian Ebert <blacktrash@gmx.net>
parents: 12389
diff changeset
   471
         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
   472
         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
   473
         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
   474
         parent.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   475
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   476
      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
   477
      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
   478
      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
   479
      revision from its first parent.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   480
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   481
      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
   482
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   483
        M = modified
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   484
        A = added
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   485
        R = removed
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   486
        C = clean
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   487
        ! = 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
   488
        ? = not tracked
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   489
        I = ignored
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   490
          = 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
   491
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   492
      Returns 0 on success.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   493
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   494
  options:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   495
  
15145
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   496
   -A --all                 show status of all files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   497
   -m --modified            show only modified files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   498
   -a --added               show only added files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   499
   -r --removed             show only removed files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   500
   -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
   501
   -c --clean               show only files without changes
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   502
   -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
   503
   -i --ignored             show only ignored files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   504
   -n --no-status           hide status prefix
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   505
   -C --copies              show source of copied files
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   506
   -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
   507
      --rev REV [+]         show difference from revision
ff26712a0c50 help: use RST to format option lists
Matt Mackall <mpm@selenic.com>
parents: 15120
diff changeset
   508
      --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
   509
   -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
   510
   -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
   511
   -S --subrepos            recurse into subrepositories
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   512
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   513
  [+] marked option can be specified multiple times
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   514
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   515
  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
   516
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   517
  $ hg -q help status
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   518
  hg status [OPTION]... [FILE]...
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   519
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   520
  show changed files in the working directory
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   521
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   522
  $ hg help foo
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   523
  hg: unknown command 'foo'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   524
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   525
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   526
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   527
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   528
   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
   529
   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
   530
   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
   531
   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
   532
   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
   533
   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
   534
   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
   535
   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
   536
   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
   537
   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
   538
   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
   539
   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
   540
   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
   541
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   542
   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
   543
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   544
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   545
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   546
  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
   547
  [255]
10141
827b7d6f9016 test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10140
diff changeset
   548
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   549
  $ hg skjdfks
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   550
  hg: unknown command 'skjdfks'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   551
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   552
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   553
  basic commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   554
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   555
   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
   556
   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
   557
   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
   558
   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
   559
   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
   560
   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
   561
   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
   562
   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
   563
   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
   564
   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
   565
   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
   566
   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
   567
   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
   568
   serve         start stand-alone webserver
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   569
   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
   570
   summary       summarize working directory state
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   571
   update        update working directory (or switch revisions)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   572
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   573
  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
   574
  [255]
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
  $ cat > helpext.py <<EOF
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   577
  > import os
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   578
  > from mercurial import commands
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   579
  > 
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   580
  > def nohelp(ui, *args, **kwargs):
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   581
  >     pass
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
  > cmdtable = {
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   584
  >     "nohelp": (nohelp, [], "hg nohelp"),
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
  > 
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   587
  > commands.norepo += ' nohelp'
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   588
  > EOF
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   589
  $ echo '[extensions]' >> $HGRCPATH
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   590
  $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   591
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   592
Test command with no help text
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   593
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   594
  $ hg help nohelp
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   595
  hg nohelp
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
  (no help text available)
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   598
  
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   599
  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
   600
16884
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   601
  $ 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
   602
  Commands:
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   603
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   604
   nohelp hg nohelp
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   605
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   606
  Extension Commands:
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   607
  
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs
Thomas Arendsen Hein <thomas@intevation.de>
parents: 16853
diff changeset
   608
   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
   609
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   610
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
   611
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   612
  $ hg help
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   613
  Mercurial Distributed SCM
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   614
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   615
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   616
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   617
   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
   618
   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
   619
   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
   620
   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
   621
   backout       reverse effect of earlier changeset
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   622
   bisect        subdivision search of changesets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   623
   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
   624
   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
   625
   branches      list repository named branches
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   626
   bundle        create a changegroup file
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   627
   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
   628
   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
   629
   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
   630
   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
   631
   diff          diff repository (or selected files)
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   632
   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
   633
   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
   634
   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
   635
   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
   636
   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
   637
   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
   638
   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
   639
   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
   640
   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
   641
   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
   642
   locate        locate files matching specific patterns
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   643
   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
   644
   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
   645
   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
   646
   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
   647
   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
   648
   paths         show aliases for remote repositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   649
   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
   650
   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
   651
   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
   652
   recover       roll back an interrupted transaction
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   653
   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
   654
   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
   655
   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
   656
   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
   657
   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
   658
   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
   659
   serve         start stand-alone webserver
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   660
   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
   661
   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
   662
   summary       summarize working directory state
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   663
   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
   664
   tags          list repository tags
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   665
   tip           show the tip revision
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   666
   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
   667
   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
   668
   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
   669
   version       output version and copyright information
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   670
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   671
  enabled extensions:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   672
  
15861
ee8f5e4ce7b8 minirst: simplify and standardize field list formatting
Olav Reinert <seroton10@gmail.com>
parents: 15834
diff changeset
   673
   helpext       (no help text available)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   674
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   675
  additional help topics:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   676
  
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   677
   config        Configuration Files
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   678
   dates         Date Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   679
   diffs         Diff Formats
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   680
   environment   Environment Variables
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   681
   extensions    Using Additional Features
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   682
   filesets      Specifying File Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   683
   glossary      Glossary
16547
23072be2eaa3 help: consistently use title capitalization for help topics
Martin Geisler <mg@aragost.com>
parents: 15996
diff changeset
   684
   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
   685
   hgweb         Configuring hgweb
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   686
   merge-tools   Merge Tools
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   687
   multirevs     Specifying Multiple Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   688
   patterns      File Name Patterns
15996
0455463655e0 help: add phases topic
Matt Mackall <mpm@selenic.com>
parents: 15862
diff changeset
   689
   phases        Working with Phases
15862
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   690
   revisions     Specifying Single Revisions
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   691
   revsets       Specifying Revision Sets
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   692
   subrepos      Subrepositories
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   693
   templating    Template Usage
d0f2a89c8cfa help: fix column alignment in "hg help" output
Olav Reinert <seroton10@gmail.com>
parents: 15861
diff changeset
   694
   urls          URL Paths
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   695
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   696
  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
   697
13888
9e5407a67dea help: sort help topics to make the output more readable (issue2751)
Yun Lee <yunlee.bj@gmail.com>
parents: 13584
diff changeset
   698
9e5407a67dea help: sort help topics to make the output more readable (issue2751)
Yun Lee <yunlee.bj@gmail.com>
parents: 13584
diff changeset
   699
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   700
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
   701
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   702
  $ hg help helpext
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   703
  helpext extension - no help text available
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
  list of commands:
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   706
  
16853
7863ff383894 help: format command and option list help using RST
Olav Reinert <seroton10@gmail.com>
parents: 16740
diff changeset
   707
   nohelp        (no help text available)
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   708
  
13230
827a1cc127bf commands: clarify which aliases "hg help -v" show (issue2572)
Martin Geisler <mg@aragost.com>
parents: 12829
diff changeset
   709
  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
   710
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   711
Test a help topic
10143
f6ac05b5684b test-help: improve test coverage
Henri Wiechers <hwiechers@gmail.com>
parents: 10142
diff changeset
   712
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   713
  $ hg help revs
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   714
  Specifying Single Revisions
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   715
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   716
      Mercurial supports several ways to specify individual revisions.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   717
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   718
      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
   719
      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
   720
      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
   721
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   722
      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
   723
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   724
      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
   725
      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
   726
      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
   727
      full-length identifier.
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   728
  
16740
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   729
      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
   730
      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
   731
      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
   732
      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
   733
      character.
12073
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   734
  
16740
43cfe56121d3 help: include bookmarks in 'help revisions' and simplify wording
Kevin Bullock <kbullock@ringworld.org>
parents: 16547
diff changeset
   735
      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
   736
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   737
      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
   738
      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
   739
  
adfff89e6058 tests: unify test-help
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 10446
diff changeset
   740
      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
   741
      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
   742
      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
   743
13584
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   744
Test templating help
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   745
02f507ce61f2 test-help: test a sample of 'templates' topic help
Patrick Mezard <pmezard@gmail.com>
parents: 13472
diff changeset
   746
  $ 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
   747
      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
   748
      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
   749
      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
   750
      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
   751
12820
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   752
Test help hooks
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   753
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   754
  $ cat > helphook1.py <<EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   755
  > from mercurial import help
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
  > def rewrite(topic, doc):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   758
  >     return doc + '\nhelphook1\n'
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 extsetup(ui):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   761
  >     help.addtopichook('revsets', rewrite)
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   762
  > EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   763
  $ cat > helphook2.py <<EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   764
  > from mercurial import help
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   765
  > 
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   766
  > def rewrite(topic, doc):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   767
  >     return doc + '\nhelphook2\n'
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 extsetup(ui):
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   770
  >     help.addtopichook('revsets', rewrite)
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   771
  > EOF
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   772
  $ echo '[extensions]' >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   773
  $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   774
  $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   775
  $ hg help revsets | grep helphook
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   776
      helphook1
0edc0aa7432d help: add topic rewriting hooks
Patrick Mezard <pmezard@gmail.com>
parents: 12787
diff changeset
   777
      helphook2
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   778
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   779
Test keyword search help
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   780
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   781
  $ hg help -k clone
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   782
  Topics:
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
   config     Configuration Files
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   785
   extensions Using Additional Features
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   786
   glossary   Glossary
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   787
   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
   788
   subrepos   Subrepositories
16942
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   789
   urls       URL Paths
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   790
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   791
  Commands:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   792
  
16949
66721a0d2249 help: sort results from keyword search
Mads Kiilerich <mads@kiilerich.com>
parents: 16942
diff changeset
   793
   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
   794
   paths  show aliases for remote repositories
16949
66721a0d2249 help: sort results from keyword search
Mads Kiilerich <mads@kiilerich.com>
parents: 16942
diff changeset
   795
   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
   796
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   797
  Extensions:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   798
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   799
   relink recreates hardlinks between repository clones
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   800
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   801
  Extension Commands:
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   802
  
87882c8753d4 help: fix extension commands help in keyword search
Olav Reinert <seroton10@gmail.com>
parents: 16884
diff changeset
   803
   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
   804
17837
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   805
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
   806
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   807
  $ 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
   808
  > '''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
   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
  > 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
   811
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   812
  > .. 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
   813
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   814
  >   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
   815
  >   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
   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 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
   818
  > '''
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
  > 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
   821
  > 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
   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
  > .. 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
   824
  > 
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   825
  >   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
   826
  >   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
   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 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
   829
  > """
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   830
  > 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
   831
  >     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
   832
  >                            "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
   833
  >                            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
   834
  > EOF
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   835
  $ 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
   836
  $ 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
   837
  $ 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
   838
  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
   839
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   840
  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
   841
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   842
  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
   843
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   844
  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
   845
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   846
  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
   847
  $ 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
   848
  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
   849
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   850
  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
   851
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   852
  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
   853
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   854
  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
   855
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   856
  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
   857
  $ 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
   858
  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
   859
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   860
      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
   861
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   862
      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
   863
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   864
  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
   865
  $ 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
   866
  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
   867
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   868
      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
   869
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   870
      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
   871
  
b623e323c561 help: indicate help omitting if help document is not fully displayed
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17717
diff changeset
   872
      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
   873
17648
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   874
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
   875
07f1ac17b722 doc: add the tool to check section marks in help documents
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents: 17322
diff changeset
   876
  $ 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
   877
  $ python check-seclevel.py