##// END OF EJS Templates
encoding: alias cp65001 to utf-8 on Windows...
encoding: alias cp65001 to utf-8 on Windows As far as I can tell, cp65001 is the Windows name for UTF-8. I don't know how different it is from the UTF-8, but Python 3 appears to have introduced new codec for cp65001, so the alias is enabled only for Python 2. https://bugs.python.org/issue13216 This patch is untested, but hopefully fixes the following issue. https://bitbucket.org/tortoisehg/thg/issues/5127/

File last commit:

r38257:ead71b15 merge default
r38633:44302901 stable
Show More
test-help.t
3610 lines | 112.8 KiB | text/troff | Tads3Lexer
Matt Mackall
tests: fix a bunch of pointless #s in unified tests
r12328 Short help:
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg
Mercurial Distributed SCM
basic commands:
Olav Reinert
help: format command and option list help using RST...
r16853 add add the specified files on the next commit
annotate show changeset information by line for each file
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit
init create a new repository in the given directory
log show revision history of entire repository or files
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: format command and option list help using RST...
r16853 pull pull changes from the specified source
push push changes to the specified destination
remove remove the specified files on the next commit
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
update update working directory (or switch revisions)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help' for the full list of commands or 'hg -v' for details)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg -q
Olav Reinert
help: format command and option list help using RST...
r16853 add add the specified files on the next commit
annotate show changeset information by line for each file
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit
init create a new repository in the given directory
log show revision history of entire repository or files
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: format command and option list help using RST...
r16853 pull pull changes from the specified source
push push changes to the specified destination
remove remove the specified files on the next commit
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
update update working directory (or switch revisions)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Gregory Szorc
tests: conditionalize tests based on presence of custom extensions...
r37360 Extra extensions will be printed in help output in a non-reliable order since
the extension is unknown.
#if no-extraextensions
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 $ hg help
Mercurial Distributed SCM
list of commands:
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 add add the specified files on the next commit
addremove add all new files, delete all missing files
annotate show changeset information by line for each file
archive create an unversioned archive of a repository revision
backout reverse effect of earlier changeset
bisect subdivision search of changesets
Matt Mackall
bookmarks: improve the bookmark help (issue4244)
r21762 bookmarks create a new bookmark or list existing bookmarks
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 branch set or show the current branch name
branches list repository named branches
Gregory Szorc
commands: update help for "bundle"...
r31794 bundle create a bundle file
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 cat output the current or given revision of files
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
Matt Mackall
config: move showconfig code and add config as primary alias...
r20570 config show combined config settings from all hgrc files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 copy mark files as copied for the next commit
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
Matt Mackall
files: add new command unifying locate and manifest functionality
r22423 files list tracked files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
Kevin Bullock
grep: rewrite help to better document current (confusing) behavior
r30009 grep search revision history for a pattern in specified files
Matt Mackall
heads: modernize documentation (issue3992)...
r19469 heads show branch heads
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 help show help for a given topic or a help overview
Yuya Nishihara
commands: replace "working copy" with "working directory" in help/messages...
r24364 identify identify the working directory or specified revision
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 import import an ordered set of patches
incoming show new changesets found in source
init create a new repository in the given directory
log show revision history of entire repository or files
manifest output the current or given revision of the project manifest
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 outgoing show changesets not found in the destination
paths show aliases for remote repositories
phase set or show the current phase name
pull pull changes from the specified source
push push changes to the specified destination
recover roll back an interrupted transaction
remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files
revert restore files to their checkout state
root print the root (top) of the current working directory
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
tag add one or more tags for the current or given revision
tags list repository tags
Gregory Szorc
commands: update help for "unbundle"...
r31795 unbundle apply one or more bundle files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
additional help topics:
Gregory Szorc
help: document bundle specifications...
r31793 bundlespec Bundle File Formats
Pierre-Yves David
color: update the help table...
r31129 color Colorizing Outputs
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
Martin Geisler
help: consistently use title capitalization for help topics
r16547 extensions Using Additional Features
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 filesets Specifying File Sets
Rodrigo Damazio Bovendorp
help: adding a topic on flags...
r35036 flags Command-line flags
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 glossary Glossary
Martin Geisler
help: consistently use title capitalization for help topics
r16547 hgignore Syntax for Mercurial Ignore Files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 hgweb Configuring hgweb
Gregory Szorc
help: add "internals" topic...
r27376 internals Technical implementation topics
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 merge-tools Merge Tools
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 pager Pager Support
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 patterns File Name Patterns
Matt Mackall
help: add phases topic
r15996 phases Working with Phases
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 revisions Specifying Revisions
Gregory Szorc
help: scripting help topic...
r25881 scripting Using Mercurial from scripts and automation
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 subrepos Subrepositories
templating Template Usage
urls URL Paths
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help -v' to show built-in aliases and global options)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg -q help
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 add add the specified files on the next commit
addremove add all new files, delete all missing files
annotate show changeset information by line for each file
archive create an unversioned archive of a repository revision
backout reverse effect of earlier changeset
bisect subdivision search of changesets
Matt Mackall
bookmarks: improve the bookmark help (issue4244)
r21762 bookmarks create a new bookmark or list existing bookmarks
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 branch set or show the current branch name
branches list repository named branches
Gregory Szorc
commands: update help for "bundle"...
r31794 bundle create a bundle file
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 cat output the current or given revision of files
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
Matt Mackall
config: move showconfig code and add config as primary alias...
r20570 config show combined config settings from all hgrc files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 copy mark files as copied for the next commit
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
Matt Mackall
files: add new command unifying locate and manifest functionality
r22423 files list tracked files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
Kevin Bullock
grep: rewrite help to better document current (confusing) behavior
r30009 grep search revision history for a pattern in specified files
Matt Mackall
heads: modernize documentation (issue3992)...
r19469 heads show branch heads
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 help show help for a given topic or a help overview
Yuya Nishihara
commands: replace "working copy" with "working directory" in help/messages...
r24364 identify identify the working directory or specified revision
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 import import an ordered set of patches
incoming show new changesets found in source
init create a new repository in the given directory
log show revision history of entire repository or files
manifest output the current or given revision of the project manifest
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 outgoing show changesets not found in the destination
paths show aliases for remote repositories
phase set or show the current phase name
pull pull changes from the specified source
push push changes to the specified destination
recover roll back an interrupted transaction
remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files
revert restore files to their checkout state
root print the root (top) of the current working directory
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
tag add one or more tags for the current or given revision
tags list repository tags
Gregory Szorc
commands: update help for "unbundle"...
r31795 unbundle apply one or more bundle files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
additional help topics:
Gregory Szorc
help: document bundle specifications...
r31793 bundlespec Bundle File Formats
Pierre-Yves David
color: update the help table...
r31129 color Colorizing Outputs
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
Martin Geisler
help: consistently use title capitalization for help topics
r16547 extensions Using Additional Features
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 filesets Specifying File Sets
Rodrigo Damazio Bovendorp
help: adding a topic on flags...
r35036 flags Command-line flags
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 glossary Glossary
Martin Geisler
help: consistently use title capitalization for help topics
r16547 hgignore Syntax for Mercurial Ignore Files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 hgweb Configuring hgweb
Gregory Szorc
help: add "internals" topic...
r27376 internals Technical implementation topics
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 merge-tools Merge Tools
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 pager Pager Support
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 patterns File Name Patterns
Matt Mackall
help: add phases topic
r15996 phases Working with Phases
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 revisions Specifying Revisions
Gregory Szorc
help: scripting help topic...
r25881 scripting Using Mercurial from scripts and automation
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 subrepos Subrepositories
templating Template Usage
urls URL Paths
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 Test extension help:
Matt Mackall
extensions: remove the inotify extension (BC)...
r20622 $ hg help extensions --config extensions.rebase= --config extensions.children=
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 Using Additional Features
"""""""""""""""""""""""""
Mercurial has the ability to add new features through the use of
extensions. Extensions may add new commands, add options to existing
commands, change the default behavior of commands, or implement hooks.
To enable the "foo" extension, either shipped with Mercurial or in the
Python search path, create an entry for it in your configuration file,
like this:
[extensions]
foo =
You may also specify the full path to an extension:
[extensions]
myfeature = ~/.hgext/myfeature.py
timeless
minirst: change hgrole to use single quotes...
r27729 See 'hg help config' for more information on configuration files.
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581
Extensions are not loaded by default for a variety of reasons: they can
increase startup overhead; they may be meant for advanced usage only; they
may provide potentially dangerous abilities (such as letting you destroy
or modify history); they might not be ready for prime time; or they may
alter some usual behaviors of stock Mercurial. It is thus up to the user
to activate extensions as needed.
To explicitly disable an extension enabled in a configuration file of
broader scope, prepend its path with !:
[extensions]
# disabling extension bar residing in /path/to/extension/bar.py
bar = !/path/to/extension/bar.py
# ditto, but no path was supplied for extension baz
baz = !
enabled extensions:
children command to display child changesets (DEPRECATED)
rebase command to move sets of revisions to a different ancestor
disabled extensions:
acl hooks for controlling repository access
blackbox log repository events to a blackbox for debugging
bugzilla hooks for integrating with the Bugzilla bug tracker
Mike Edgar
censor: add censor command to hgext with basic client-side tests...
r24347 censor erase file content at a given revision
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 churn command to display statistics about repository history
Gregory Szorc
clonebundles: rewrite documentation...
r26762 clonebundles advertise pre-generated bundles to seed clones
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 convert import revisions from foreign VCS repositories into
Mercurial
eol automatically manage newlines in repository files
extdiff command to allow external programs to compare revisions
factotum http authentication with factotum
Gregory Szorc
githelp: vendor Facebook authored extension...
r35732 githelp try mapping git commands to Mercurial commands
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 gpg commands to sign and verify changesets
hgk browse the repository in a graphical way
highlight syntax highlighting for hgweb (requires Pygments)
histedit interactive history editing
keyword expand keywords in tracked files
largefiles track large binary files
mq manage a stack of patches
notify hooks for sending email push notifications
patchbomb command to send changesets as (a series of) patch emails
purge command to delete untracked files from the working
directory
relink recreates hardlinks between repository clones
schemes extend schemes with shortcuts to repository swarms
share share a common history between several working directories
shelve save and restore changes to the working directory
Mads Kiilerich
spelling: fixes from proofreading of spell checker issues
r23139 strip strip changesets and their descendants from history
Augie Fackler
test-help.t: add test for 'hg help extensions'...
r20581 transplant command to transplant changesets from another branch
win32mbcs allow the use of MBCS paths with problematic encodings
zeroconf discover and advertise repositories on the local network
timeless@mozdev.org
test-help: verify that extension keywords appear in help templates...
r26487
Gregory Szorc
tests: conditionalize tests based on presence of custom extensions...
r37360 #endif
Yuya Nishihara
help: list deprecated and experimental extensions if --verbose...
r36263 Verify that deprecated extensions are included if --verbose:
$ hg -v help extensions | grep children
children command to display child changesets (DEPRECATED)
timeless@mozdev.org
test-help: verify that extension keywords appear in help templates...
r26487 Verify that extension keywords appear in help templates
$ hg help --config extensions.transplant= templating|grep transplant > /dev/null
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test short command list with verbose option
$ hg -v help shortlist
Matt Mackall
help: drop with_version...
r15020 Mercurial Distributed SCM
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
basic commands:
Olav Reinert
help: format command and option list help using RST...
r16853 add add the specified files on the next commit
annotate, blame
show changeset information by line for each file
clone make a copy of an existing repository
commit, ci commit the specified files or all outstanding changes
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit
init create a new repository in the given directory
log, history show revision history of entire repository or files
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: format command and option list help using RST...
r16853 pull pull changes from the specified source
push push changes to the specified destination
remove, rm remove the specified files on the next commit
serve start stand-alone webserver
status, st show changed files in the working directory
summary, sum summarize working directory state
update, up, checkout, co
update working directory (or switch revisions)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: fold repeatable option message into option table header...
r22117 global options ([+] can be repeated):
Matt Mackall
help: use RST to format option lists
r15145
-R --repository REPO repository root directory or name of overlay bundle
file
--cwd DIR change working directory
-y --noninteractive do not prompt, automatically pick the first choice for
all prompts
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -q --quiet suppress output
-v --verbose enable additional output
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 --color TYPE when to colorize (boolean, always, auto, never, or
Pierre-Yves David
color: update main documentation...
r31123 debug)
Matt Mackall
help: use RST to format option lists
r15145 --config CONFIG [+] set/override config option (use 'section.name=value')
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --debug enable debugging output
--debugger start debugger
Matt Mackall
help: use RST to format option lists
r15145 --encoding ENCODE set the charset encoding (default: ascii)
--encodingmode MODE set the charset encoding mode (default: strict)
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --traceback always print a traceback on exception
--time time how long the command takes
--profile print command execution profile
Matt Mackall
help: use RST to format option lists
r15145 --version output version information and exit
-h --help display help and exit
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --hidden consider hidden changesets
Augie Fackler
pager: move more behavior into core...
r30993 --pager TYPE when to paginate (boolean, always, auto, or never)
(default: auto)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help' for the full list of commands)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg add -h
hg add [OPTION]... [FILE]...
add the specified files on the next commit
Schedule files to be version controlled and added to the repository.
The files will be added to the repository at the next commit. To undo an
timeless
minirst: change hgrole to use single quotes...
r27729 add before that, see 'hg forget'.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
add: mention .hgignore in help
r27424 If no names are given, add all files to the repository (except files
matching ".hgignore").
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Returns 0 if all files are successfully added.
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: use RST to format option lists
r15145 -I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Verbose help for add
$ hg add -hv
hg add [OPTION]... [FILE]...
add the specified files on the next commit
Schedule files to be version controlled and added to the repository.
The files will be added to the repository at the next commit. To undo an
timeless
minirst: change hgrole to use single quotes...
r27729 add before that, see 'hg forget'.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
add: mention .hgignore in help
r27424 If no names are given, add all files to the repository (except files
matching ".hgignore").
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Mathias De Maré
commands: add example for 'hg add'
r27143 Examples:
timeless
minirst: change hgrole to use single quotes...
r27729 - New (unknown) files are added automatically by 'hg add':
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Mathias De Maré
commands: add example for 'hg add'
r27143 $ ls
foo.c
$ hg status
? foo.c
$ hg add
adding foo.c
$ hg status
A foo.c
- Specific files to be added can be specified:
$ ls
bar.c foo.c
$ hg status
? bar.c
? foo.c
$ hg add bar.c
$ hg status
A bar.c
? foo.c
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Returns 0 if all files are successfully added.
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: use RST to format option lists
r15145 -I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
Matt Mackall
help: use RST to format option lists
r15145
Matt Mackall
help: fold repeatable option message into option table header...
r22117 global options ([+] can be repeated):
Matt Mackall
help: use RST to format option lists
r15145
-R --repository REPO repository root directory or name of overlay bundle
file
--cwd DIR change working directory
-y --noninteractive do not prompt, automatically pick the first choice for
all prompts
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -q --quiet suppress output
-v --verbose enable additional output
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 --color TYPE when to colorize (boolean, always, auto, never, or
Pierre-Yves David
color: update main documentation...
r31123 debug)
Matt Mackall
help: use RST to format option lists
r15145 --config CONFIG [+] set/override config option (use 'section.name=value')
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --debug enable debugging output
--debugger start debugger
Matt Mackall
help: use RST to format option lists
r15145 --encoding ENCODE set the charset encoding (default: ascii)
--encodingmode MODE set the charset encoding mode (default: strict)
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --traceback always print a traceback on exception
--time time how long the command takes
--profile print command execution profile
Matt Mackall
help: use RST to format option lists
r15145 --version output version information and exit
-h --help display help and exit
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --hidden consider hidden changesets
Augie Fackler
pager: move more behavior into core...
r30993 --pager TYPE when to paginate (boolean, always, auto, or never)
(default: auto)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Jun Wu
ui: add new config option for help text width...
r29070 Test the textwidth config option
$ hg root -h --config ui.textwidth=50
hg root
print the root (top) of the current working
directory
Print the root directory of the current
repository.
Returns 0 on success.
(some details hidden, use --verbose to show
complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test help option with version option
$ hg add -h --version
Brodie Rao
tests: add glob matching for unified tests...
r12376 Mercurial Distributed SCM (version *) (glob)
Matt Mackall
urls: bulk-change primary website URLs
r26421 (see https://mercurial-scm.org for more information)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
FUJIWARA Katsunori
misc: update year in copyright lines...
r30907 Copyright (C) 2005-* Matt Mackall and others (glob)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
$ hg add --skjdfks
hg add: option --skjdfks not recognized
hg add [OPTION]... [FILE]...
add the specified files on the next commit
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: use RST to format option lists
r15145 -I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg add -h' to show more help)
Matt Mackall
tests: add exit codes to unified tests
r12316 [255]
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Test ambiguous command help
$ hg help ad
list of commands:
Olav Reinert
help: format command and option list help using RST...
r16853 add add the specified files on the next commit
addremove add all new files, delete all missing files
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help -v ad' to show built-in aliases and global options)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Test command without options
$ hg help verify
hg verify
verify the integrity of the repository
Verify the integrity of the current repository.
This will perform an extensive check of the repository's integrity,
validating the hashes and checksums of each entry in the changelog,
manifest, and tracked files, as well as the integrity of their crosslinks
and indices.
Matt Mackall
urls: bulk-change primary website URLs
r26421 Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
FUJIWARA Katsunori
help: add information about recovery from corruption to help of "verify"...
r17717 information about recovery from corruption of the repository.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Returns 0 on success, 1 if errors are encountered.
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg help diff
hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
diff repository (or selected files)
Show differences between revisions for the specified files.
Differences between files are shown using the unified diff format.
Erik Zielke
Use note admonition
r12389 Note:
timeless
minirst: change hgrole to use single quotes...
r27729 'hg diff' may generate unexpected results for merges, as it will
timeless
commands: the first word of each note should be capital or `hg`
r27476 default to comparing against the working directory's first parent
changeset if no revisions are specified.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
When two revision arguments are given, then changes are shown between
those revisions. If only one revision is specified then that revision is
compared to the working directory, and, when no revisions are specified,
timeless
diff: clarify comparison as first parent
r27452 the working directory files are compared to its first parent.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Alternatively you can specify -c/--change with a revision to see the
changes in that changeset relative to its first parent.
Without the -a/--text option, diff will avoid generating diffs of files it
detects as binary. With -a, diff will generate a diff anyway, probably
with undesirable results.
Use the -g/--git option to generate diffs in the git extended diff format.
timeless
minirst: change hgrole to use single quotes...
r27729 For more information, read 'hg help diffs'.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Returns 0 on success.
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -r --rev REV [+] revision
-c --change REV change made by revision
-a --text treat all files as text
-g --git use git extended diff format
Alexander Fomin
diff: add --binary option for git mode diffs...
r31822 --binary generate binary diffs in git mode (default)
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --nodates omit dates from diff headers
--noprefix omit a/ and b/ prefixes from filenames
-p --show-function show which function each change is in
--reverse produce a diff that undoes the changes
-w --ignore-all-space ignore white space when comparing lines
-b --ignore-space-change ignore changes in the amount of white space
-B --ignore-blank-lines ignore changes whose lines are all blank
David Soria Parra
mdiff: add a --ignore-space-at-eol option...
r34015 -Z --ignore-space-at-eol ignore changes in whitespace at EOL
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -U --unified NUM number of lines of context to show
--stat output diffstat-style summary of changes
--root DIR produce diffs relative to subdirectory
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
-S --subrepos recurse into subrepositories
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg help status
hg status [OPTION]... [FILE]...
aliases: st
show changed files in the working directory
Show status of files in the repository. If names are given, only files
that match are shown. Files that are clean or ignored or the source of a
copy/move operation, are not listed unless -c/--clean, -i/--ignored,
-C/--copies or -A/--all are given. Unless options described with "show
only ..." are given, the options -mardu are used.
Option -q/--quiet hides untracked (unknown and ignored) files unless
explicitly requested with -u/--unknown or -i/--ignored.
Christian Ebert
Use more note admonitions in help texts
r12390 Note:
timeless
minirst: change hgrole to use single quotes...
r27729 'hg status' may appear to disagree with diff if permissions have
timeless
commands: the first word of each note should be capital or `hg`
r27476 changed or a merge has occurred. The standard diff format does not
report permission changes and diff only reports changes relative to one
merge parent.
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
If one revision is given, it is used as the base revision. If two
revisions are given, the differences between them are shown. The --change
option can also be used as a shortcut to list the changed files of a
revision from its first parent.
The codes used to show the status of files are:
M = modified
A = added
R = removed
C = clean
! = missing (deleted by non-hg command, but still tracked)
? = not tracked
I = ignored
Matt Mackall
status: improve explanation of ' ' status...
r20660 = origin of the previous file (with --copies)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Returns 0 on success.
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -A --all show status of all files
-m --modified show only modified files
-a --added show only added files
-r --removed show only removed files
-d --deleted show only deleted (but tracked) files
-c --clean show only files without changes
-u --unknown show only unknown (not tracked) files
-i --ignored show only ignored files
-n --no-status hide status prefix
-C --copies show source of copied files
-0 --print0 end filenames with NUL, for use with xargs
Matt Mackall
help: use RST to format option lists
r15145 --rev REV [+] show difference from revision
--change REV list the changed files of a revision
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 -S --subrepos recurse into subrepositories
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg -q help status
hg status [OPTION]... [FILE]...
show changed files in the working directory
$ hg help foo
Pierre-Yves David
help: suggest keyword search when no topic is found...
r21289 abort: no such help topic: foo
timeless
help: use single quotes in use warning
r29974 (try 'hg help --keyword foo')
Matt Mackall
tests: add exit codes to unified tests
r12316 [255]
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
$ hg skjdfks
hg: unknown command 'skjdfks'
Mercurial Distributed SCM
basic commands:
Olav Reinert
help: format command and option list help using RST...
r16853 add add the specified files on the next commit
annotate show changeset information by line for each file
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit
init create a new repository in the given directory
log show revision history of entire repository or files
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: format command and option list help using RST...
r16853 pull pull changes from the specified source
push push changes to the specified destination
remove remove the specified files on the next commit
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
update update working directory (or switch revisions)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help' for the full list of commands or 'hg -v' for details)
Matt Mackall
tests: add exit codes to unified tests
r12316 [255]
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Martin von Zweigbergk
tests: add tests for typoed commands...
r33326 Typoed command gives suggestion
$ hg puls
hg: unknown command 'puls'
(did you mean one of pull, push?)
[255]
Not enabled extension gets suggested
$ hg rebase
hg: unknown command 'rebase'
'rebase' is provided by the following extension:
rebase command to move sets of revisions to a different ancestor
(use 'hg help extensions' for information on enabling extensions)
[255]
Disabled extension gets suggested
$ hg --config extensions.rebase=! rebase
hg: unknown command 'rebase'
Martin von Zweigbergk
dispatch: fix typo suggestion for disabled extension...
r33327 'rebase' is provided by the following extension:
rebase command to move sets of revisions to a different ancestor
(use 'hg help extensions' for information on enabling extensions)
Martin von Zweigbergk
tests: add tests for typoed commands...
r33326 [255]
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Jordi Gutiérrez Hermoso
dispatch: don't stack trace on commands like `hg .log`...
r26364 Make sure that we don't run afoul of the help system thinking that
this is a section and erroring out weirdly.
$ hg .log
hg: unknown command '.log'
Bryan O'Sullivan
dispatch: report similar names consistently
r27623 (did you mean log?)
Jordi Gutiérrez Hermoso
dispatch: don't stack trace on commands like `hg .log`...
r26364 [255]
$ hg log.
hg: unknown command 'log.'
Bryan O'Sullivan
dispatch: report similar names consistently
r27623 (did you mean log?)
Jordi Gutiérrez Hermoso
dispatch: don't stack trace on commands like `hg .log`...
r26364 [255]
$ hg pu.lh
hg: unknown command 'pu.lh'
(did you mean one of pull, push?)
[255]
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 $ cat > helpext.py <<EOF
> import os
Daniel Ploch
fancyopts: fix rendering of customopt defaults in help text...
r37109 > from mercurial import commands, fancyopts, registrar
Gregory Szorc
tests: declare commands using decorator
r21254 >
Daniel Ploch
fancyopts: fix rendering of customopt defaults in help text...
r37109 > def func(arg):
> return '%sfoo' % arg
> class customopt(fancyopts.customopt):
> def newstate(self, oldstate, newparam, abort):
> return '%sbar' % oldstate
Gregory Szorc
tests: declare commands using decorator
r21254 > cmdtable = {}
Yuya Nishihara
registrar: move cmdutil.command to registrar module (API)...
r32337 > command = registrar.command(cmdtable)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 >
Augie Fackler
tests: port test extension in test-help.t to python 3...
r32545 > @command(b'nohelp',
Daniel Ploch
fancyopts: fix rendering of customopt defaults in help text...
r37109 > [(b'', b'longdesc', 3, b'x'*67),
Augie Fackler
tests: port test extension in test-help.t to python 3...
r32545 > (b'n', b'', None, b'normal desc'),
Daniel Ploch
fancyopts: fix rendering of customopt defaults in help text...
r37109 > (b'', b'newline', b'', b'line1\nline2'),
> (b'', b'callableopt', func, b'adds foo'),
> (b'', b'customopt', customopt(''), b'adds bar'),
> (b'', b'customopt-withdefault', customopt('foo'), b'adds bar')],
Augie Fackler
tests: port test extension in test-help.t to python 3...
r32545 > b'hg nohelp',
Gregory Szorc
tests: define norepo in command decorator
r21773 > norepo=True)
Augie Fackler
tests: port test extension in test-help.t to python 3...
r32545 > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
> @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
> @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 > def nohelp(ui, *args, **kwargs):
> pass
>
timeless
help: report source of aliases
r28828 > def uisetup(ui):
Augie Fackler
tests: port test extension in test-help.t to python 3...
r32545 > ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
> ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
timeless
help: report source of aliases
r28828 >
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 > EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
timeless
help: report source of aliases
r28828 Test for aliases
$ hg help hgalias
hg hgalias [--remote]
alias for: hg summary
summarize working directory state
This generates a brief summary of the working directory state, including
parents, branch, commit status, phase and available updates.
With the --remote option, this will check the default paths for incoming
and outgoing changes. This can be time-consuming.
Returns 0 on success.
defined by: helpext
options:
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --remote check for push and pull
timeless
help: report source of aliases
r28828
(some details hidden, use --verbose to show complete help)
$ hg help shellalias
hg shellalias
Rodrigo Damazio
help: supporting both help and doc for aliases...
r37152 shell alias for: echo hi
(no help text available)
timeless
help: report source of aliases
r28828
defined by: helpext
(some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test command with no help text
$ hg help nohelp
hg nohelp
(no help text available)
Simon Heimberg
minirst: create valid output when table data contains a newline...
r20654 options:
Daniel Ploch
fancyopts: fix rendering of customopt defaults in help text...
r37109 --longdesc VALUE
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxx (default: 3)
-n -- normal desc
--newline VALUE line1 line2
--callableopt VALUE adds foo
--customopt VALUE adds bar
--customopt-withdefault VALUE adds bar (default: foo)
Simon Heimberg
minirst: create valid output when table data contains a newline...
r20654
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Thomas Arendsen Hein
help: fix 'hg help -k' matching an extension without docs...
r16884 $ hg help -k nohelp
Commands:
nohelp hg nohelp
Extension Commands:
nohelp (no help text available)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test that default list of commands omits extension commands
Gregory Szorc
tests: conditionalize tests based on presence of custom extensions...
r37360 #if no-extraextensions
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 $ hg help
Mercurial Distributed SCM
list of commands:
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 add add the specified files on the next commit
addremove add all new files, delete all missing files
annotate show changeset information by line for each file
archive create an unversioned archive of a repository revision
backout reverse effect of earlier changeset
bisect subdivision search of changesets
Matt Mackall
bookmarks: improve the bookmark help (issue4244)
r21762 bookmarks create a new bookmark or list existing bookmarks
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 branch set or show the current branch name
branches list repository named branches
Gregory Szorc
commands: update help for "bundle"...
r31794 bundle create a bundle file
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 cat output the current or given revision of files
clone make a copy of an existing repository
commit commit the specified files or all outstanding changes
Matt Mackall
config: move showconfig code and add config as primary alias...
r20570 config show combined config settings from all hgrc files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 copy mark files as copied for the next commit
diff diff repository (or selected files)
export dump the header and diffs for one or more changesets
Matt Mackall
files: add new command unifying locate and manifest functionality
r22423 files list tracked files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
Kevin Bullock
grep: rewrite help to better document current (confusing) behavior
r30009 grep search revision history for a pattern in specified files
Matt Mackall
heads: modernize documentation (issue3992)...
r19469 heads show branch heads
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 help show help for a given topic or a help overview
Yuya Nishihara
commands: replace "working copy" with "working directory" in help/messages...
r24364 identify identify the working directory or specified revision
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 import import an ordered set of patches
incoming show new changesets found in source
init create a new repository in the given directory
log show revision history of entire repository or files
manifest output the current or given revision of the project manifest
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge merge another revision into working directory
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 outgoing show changesets not found in the destination
paths show aliases for remote repositories
phase set or show the current phase name
pull pull changes from the specified source
push push changes to the specified destination
recover roll back an interrupted transaction
remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files
revert restore files to their checkout state
root print the root (top) of the current working directory
serve start stand-alone webserver
status show changed files in the working directory
summary summarize working directory state
tag add one or more tags for the current or given revision
tags list repository tags
Gregory Szorc
commands: update help for "unbundle"...
r31795 unbundle apply one or more bundle files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
enabled extensions:
Olav Reinert
minirst: simplify and standardize field list formatting...
r15861 helpext (no help text available)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
additional help topics:
Gregory Szorc
help: document bundle specifications...
r31793 bundlespec Bundle File Formats
Pierre-Yves David
color: update the help table...
r31129 color Colorizing Outputs
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
Martin Geisler
help: consistently use title capitalization for help topics
r16547 extensions Using Additional Features
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 filesets Specifying File Sets
Rodrigo Damazio Bovendorp
help: adding a topic on flags...
r35036 flags Command-line flags
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 glossary Glossary
Martin Geisler
help: consistently use title capitalization for help topics
r16547 hgignore Syntax for Mercurial Ignore Files
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 hgweb Configuring hgweb
Gregory Szorc
help: add "internals" topic...
r27376 internals Technical implementation topics
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 merge-tools Merge Tools
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 pager Pager Support
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 patterns File Name Patterns
Matt Mackall
help: add phases topic
r15996 phases Working with Phases
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 revisions Specifying Revisions
Gregory Szorc
help: scripting help topic...
r25881 scripting Using Mercurial from scripts and automation
Olav Reinert
help: fix column alignment in "hg help" output...
r15862 subrepos Subrepositories
templating Template Usage
urls URL Paths
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help -v' to show built-in aliases and global options)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Gregory Szorc
tests: conditionalize tests based on presence of custom extensions...
r37360 #endif
Yun Lee
help: sort help topics to make the output more readable (issue2751)
r13888
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 Test list of internal help commands
$ hg help debug
debug commands (internal and unsupported):
debugancestor
find the ancestor revision of two revisions in a given index
Gregory Szorc
commands: support consuming stream clone bundles...
r26758 debugapplystreamclonebundle
apply a stream clone bundle file
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugbuilddag
builds a repo with a given DAG from scratch in the current
empty repo
debugbundle lists the contents of a bundle
Boris Feld
debug: add a debugcapabilities commands...
r34960 debugcapabilities
lists the capabilities of a remote peer
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugcheckstate
validate the correctness of the current dirstate
Pierre-Yves David
color: move 'debugcolor' into the 'debugcommands' modules...
r31120 debugcolor show available color, effects or style
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugcommands
list all available commands and options
debugcomplete
returns the completion list associated with the given command
Gregory Szorc
commands: support creating stream clone bundles...
r26757 debugcreatestreamclonebundle
create a stream clone bundle file
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugdag format the changelog or an index DAG as a concise textual
description
debugdata dump the contents of a data file revision
debugdate parse and display a date
Gregory Szorc
commands: add debugdeltachain command...
r27263 debugdeltachain
dump information about delta chains in a revlog
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugdirstate
show the contents of the current dirstate
debugdiscovery
runs the changeset discovery protocol in isolation
Boris Feld
debug: add a 'debugdownload' command...
r35578 debugdownload
download a resource using Mercurial logic and config
liscju
mercurial: add debugextensions command (issue4676)...
r26351 debugextensions
show information about active extensions
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugfileset parse and apply a fileset specification
Boris Feld
debugformat: add a 'debugformat' command...
r35337 debugformat display format information about the current repository
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugfsinfo show information detected about current filesystem
debuggetbundle
retrieves a bundle from a repo
Laurent Charignon
debugignore: find out if a file is being ignored...
r27671 debugignore display the combined ignore pattern and information about
ignored files
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugindex dump the contents of an index file
debugindexdot
dump an index DAG as a graphviz dot file
debuginstall test Mercurial installation
debugknown test whether node ids are known to a repo
Matt Mackall
commands: add debuglocks to report/clear lock state
r22559 debuglocks show or modify state of locks
Siddharth Agarwal
commands: add a new debug command to print merge state...
r26501 debugmergestate
print merge state
Sean Farley
debugnamecomplete: rename from debuglabelcomplete...
r23762 debugnamecomplete
complete "names" - tags, open branch names, bookmark names
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugobsolete
create arbitrary obsolete marker
Jun Wu
help: hide command line options marked as "advanced"...
r31080 debugoptADV (no help text available)
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugoptDEP (no help text available)
Siddharth Agarwal
help: also hide options marked EXPERIMENTAL...
r24871 debugoptEXP (no help text available)
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugpathcomplete
complete part or all of a tracked path
Gregory Szorc
debugcommands: introduce debugpeer command...
r35947 debugpeer establish a connection to a peer repository
FUJIWARA Katsunori
debugcommands: add debugpickmergetool to examine which merge tool is chosen...
r32256 debugpickmergetool
examine which merge tool is chosen for specified file
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugpushkey access the pushkey key/value protocol
debugpvec (no help text available)
debugrebuilddirstate
rebuild the dirstate as it would look like for the given
revision
Gregory Szorc
repair: add functionality to rebuild fncache...
r25652 debugrebuildfncache
rebuild the fncache file
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugrename dump rename information
debugrevlog show data and statistics about a revlog
debugrevspec parse and apply a revision specification
Gregory Szorc
debugcommands: add debugserve command...
r36544 debugserve run a server with advanced settings
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugsetparents
manually set the parents of the current working directory
Matt Harbison
debug: add a method to check the state of, and built an SSL cert chain...
r33493 debugssl test a secure connection to a server
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugsub (no help text available)
debugsuccessorssets
show set of successors for revision
Yuya Nishihara
templater: add debugtemplate command...
r28548 debugtemplate
parse and apply a template
Yuya Nishihara
ui: add debug commands to test interactive prompt...
r36810 debuguigetpass
show prompt to type password
debuguiprompt
show plain prompt
Pierre-Yves David
caches: introduce a 'debugupdatecaches' command...
r32265 debugupdatecaches
warm all known caches in the repository
Gregory Szorc
debugcommands: stub for debugupgraderepo command...
r30774 debugupgraderepo
upgrade a repository to use different features
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugwalk show how files match on given patterns
av6
debug: add debugwhyunstable that explains instabilities...
r36972 debugwhyunstable
explain instabilities of a changeset
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822 debugwireargs
(no help text available)
Gregory Szorc
debugcommands: add debugwireproto command...
r36545 debugwireproto
send wire protocol commands to a server
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822
timeless
help: use single quotes in use warning
r29974 (use 'hg help -v debug' to show built-in aliases and global options)
Mads Kiilerich
help: let 'hg help debug' show the list of secret debug commands...
r20822
Gregory Szorc
help: add "internals" topic...
r27376 internals topic renders index of available sub-topics
$ hg help internals
Technical implementation topics
"""""""""""""""""""""""""""""""
Matt DeVore
help: explain how to access subtopics in internals
r32076 To access a subtopic, use "hg help internals.{subtopic-name}"
Gregory Szorc
internals: document bundle2 format...
r36469 bundle2 Bundle2
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 bundles Bundles
Augie Fackler
help: update help.internalstable for new censor docs
r31293 censor Censor
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 changegroups Changegroups
Kevin Bullock
internals: update test-help.t for config registrar copy-edit
r34953 config Config Registrar
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 requirements Repository Requirements
revlogs Revision Logs
Gregory Szorc
help: internals topic for wire protocol...
r29859 wireprotocol Wire Protocol
Yun Lee
help: sort help topics to make the output more readable (issue2751)
r13888
Gregory Szorc
help: support loading sub-topics...
r27379 sub-topics can be accessed
$ hg help internals.changegroups
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 Changegroups
""""""""""""
Gregory Szorc
help: support loading sub-topics...
r27379
Changegroups are representations of repository revlog data, specifically
Kyle Lippincott
help: fix internals.changegroups...
r31213 the changelog data, root/flat manifest data, treemanifest data, and
filelogs.
Gregory Szorc
help: support loading sub-topics...
r27379
Augie Fackler
changegroups: add documentation for cg3
r27434 There are 3 versions of changegroups: "1", "2", and "3". From a high-
level, versions "1" and "2" are almost exactly the same, with the only
Kyle Lippincott
help: fix internals.changegroups...
r31213 difference being an additional item in the *delta header*. Version "3"
adds support for revlog flags in the *delta header* and optionally
exchanging treemanifests (enabled by setting an option on the
"changegroup" part in the bundle2).
Changegroups when not exchanging treemanifests consist of 3 logical
segments:
Gregory Szorc
help: support loading sub-topics...
r27379
+---------------------------------+
| | | |
| changeset | manifest | filelogs |
| | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | | | |
Gregory Szorc
help: support loading sub-topics...
r27379 +---------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213 When exchanging treemanifests, there are 4 logical segments:
+-------------------------------------------------+
| | | | |
| changeset | root | treemanifests | filelogs |
| | manifest | | |
| | | | |
+-------------------------------------------------+
Gregory Szorc
help: support loading sub-topics...
r27379 The principle building block of each segment is a *chunk*. A *chunk* is a
framed piece of data:
+---------------------------------------+
| | |
| length | data |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | (4 bytes) | (<length - 4> bytes) |
Gregory Szorc
help: support loading sub-topics...
r27379 | | |
+---------------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213 All integers are big-endian signed integers. Each chunk starts with a
32-bit integer indicating the length of the entire chunk (including the
length field itself).
There is a special case chunk that has a value of 0 for the length
("0x00000000"). We call this an *empty chunk*.
Gregory Szorc
help: support loading sub-topics...
r27379
Delta Groups
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 ============
Gregory Szorc
help: support loading sub-topics...
r27379
A *delta group* expresses the content of a revlog as a series of deltas,
or patches against previous revisions.
Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
to signal the end of the delta group:
+------------------------------------------------------------------------+
| | | | | |
| chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
Gregory Szorc
help: support loading sub-topics...
r27379 | | | | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 +------------------------------------------------------------------------+
Gregory Szorc
help: support loading sub-topics...
r27379
Each *chunk*'s data consists of the following:
Kyle Lippincott
help: fix internals.changegroups...
r31213 +---------------------------------------+
| | |
| delta header | delta data |
| (various by version) | (various) |
| | |
+---------------------------------------+
The *delta data* is a series of *delta*s that describe a diff from an
existing entry (either that the recipient already has, or previously
Matt Harbison
help: spelling fixes
r32139 specified in the bundle/changegroup).
Gregory Szorc
help: support loading sub-topics...
r27379
Augie Fackler
changegroups: add documentation for cg3
r27434 The *delta header* is different between versions "1", "2", and "3" of the
Gregory Szorc
help: support loading sub-topics...
r27379 changegroup format.
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 1 (headerlen=80):
Gregory Szorc
help: support loading sub-topics...
r27379
+------------------------------------------------------+
| | | | |
| node | p1 node | p2 node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | |
+------------------------------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 2 (headerlen=100):
Gregory Szorc
help: support loading sub-topics...
r27379
+------------------------------------------------------------------+
| | | | | |
| node | p1 node | p2 node | base node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | | |
+------------------------------------------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 3 (headerlen=102):
Augie Fackler
changegroups: add documentation for cg3
r27434
+------------------------------------------------------------------------------+
| | | | | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | node | p1 node | p2 node | base node | link node | flags |
Augie Fackler
changegroups: add documentation for cg3
r27434 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
| | | | | | |
+------------------------------------------------------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
contain a series of *delta*s, densely packed (no separators). These deltas
describe a diff from an existing entry (either that the recipient already
has, or previously specified in the bundle/changegroup). The format is
described more fully in "hg help internals.bdiff", but briefly:
Yuya Nishihara
help: fix layout of pre-formatted text
r31287 +---------------------------------------------------------------+
| | | | |
| start offset | end offset | new length | content |
| (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
| | | | |
+---------------------------------------------------------------+
Kyle Lippincott
help: fix internals.changegroups...
r31213
Please note that the length field in the delta data does *not* include
itself.
Gregory Szorc
help: support loading sub-topics...
r27379
In version 1, the delta is always applied against the previous node from
the changegroup or the first parent if this is the first entry in the
changegroup.
Kyle Lippincott
help: fix internals.changegroups...
r31213 In version 2 and up, the delta base node is encoded in the entry in the
Gregory Szorc
help: support loading sub-topics...
r27379 changegroup. This allows the delta to be expressed against any parent,
which can result in smaller deltas and more efficient encoding of data.
Changeset Segment
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 =================
Gregory Szorc
help: support loading sub-topics...
r27379
The *changeset segment* consists of a single *delta group* holding
Kyle Lippincott
help: fix internals.changegroups...
r31213 changelog data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the *manifest segment*.
Gregory Szorc
help: support loading sub-topics...
r27379
Manifest Segment
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 ================
Gregory Szorc
help: support loading sub-topics...
r27379
The *manifest segment* consists of a single *delta group* holding manifest
Kyle Lippincott
help: fix internals.changegroups...
r31213 data. If treemanifests are in use, it contains only the manifest for the
root directory of the repository. Otherwise, it contains the entire
manifest data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the next segment (either the *treemanifests segment* or
the *filelogs segment*, depending on version and the request options).
Treemanifests Segment
---------------------
The *treemanifests segment* only exists in changegroup version "3", and
only if the 'treemanifest' param is part of the bundle2 changegroup part
(it is not possible to use changegroup version 3 outside of bundle2).
Aside from the filenames in the *treemanifests segment* containing a
trailing "/" character, it behaves identically to the *filelogs segment*
(see below). The final sub-segment is followed by an *empty chunk*
(logically, a sub-segment with filename size 0). This denotes the boundary
to the *filelogs segment*.
Gregory Szorc
help: support loading sub-topics...
r27379
Filelogs Segment
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 ================
Gregory Szorc
help: support loading sub-topics...
r27379
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *filelogs segment* consists of multiple sub-segments, each
Gregory Szorc
help: support loading sub-topics...
r27379 corresponding to an individual file whose data is being described:
Kyle Lippincott
help: fix internals.changegroups...
r31213 +--------------------------------------------------+
| | | | | |
| filelog0 | filelog1 | filelog2 | ... | 0x0 |
| | | | | (4 bytes) |
| | | | | |
+--------------------------------------------------+
The final filelog sub-segment is followed by an *empty chunk* (logically,
a sub-segment with filename size 0). This denotes the end of the segment
and of the overall changegroup.
Gregory Szorc
help: support loading sub-topics...
r27379
Each filelog sub-segment consists of the following:
Kyle Lippincott
help: fix internals.changegroups...
r31213 +------------------------------------------------------+
| | | |
| filename length | filename | delta group |
| (4 bytes) | (<length - 4> bytes) | (various) |
| | | |
+------------------------------------------------------+
Gregory Szorc
help: support loading sub-topics...
r27379
That is, a *chunk* consisting of the filename (not terminated or padded)
Kyle Lippincott
help: fix internals.changegroups...
r31213 followed by N chunks constituting the *delta group* for this file. The
*empty chunk* at the end of each *delta group* denotes the boundary to the
next filelog sub-segment.
Gregory Szorc
help: support loading sub-topics...
r27379
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test list of commands with command with no help text
$ hg help helpext
helpext extension - no help text available
list of commands:
Olav Reinert
help: format command and option list help using RST...
r16853 nohelp (no help text available)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
timeless
help: use single quotes in use warning
r29974 (use 'hg help -v helpext' to show built-in aliases and global options)
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Jun Wu
help: hide command line options marked as "advanced"...
r31080 test advanced, deprecated and experimental options are hidden in command help
$ hg help debugoptADV
hg debugoptADV
(no help text available)
options:
(some details hidden, use --verbose to show complete help)
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743 $ hg help debugoptDEP
hg debugoptDEP
(no help text available)
options:
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Siddharth Agarwal
help: also hide options marked EXPERIMENTAL...
r24871 $ hg help debugoptEXP
hg debugoptEXP
(no help text available)
options:
(some details hidden, use --verbose to show complete help)
Jun Wu
help: hide command line options marked as "advanced"...
r31080 test advanced, deprecated and experimental options are shown with -v
$ hg help -v debugoptADV | grep aopt
--aopt option is (ADVANCED)
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743 $ hg help -v debugoptDEP | grep dopt
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --dopt option is (DEPRECATED)
Siddharth Agarwal
help: also hide options marked EXPERIMENTAL...
r24871 $ hg help -v debugoptEXP | grep eopt
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 --eopt option is (EXPERIMENTAL)
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Kent Frazier
tests: mark test in tests/test-help.t as contingent on gettext being available
r21039 #if gettext
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743 test deprecated option is hidden with translation with untranslated description
(use many globy for not failing on changed transaction)
$ LANGUAGE=sv hg help debugoptDEP
hg debugoptDEP
(*) (glob)
Matt Mackall
help: roll option list header into option formatter
r22116 options:
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Matt Mackall
help: tweak --verbose command help hint...
r22110 (some details hidden, use --verbose to show complete help)
Kent Frazier
tests: mark test in tests/test-help.t as contingent on gettext being available
r21039 #endif
Simon Heimberg
help: filter out deprecated options with untranslated descriptions...
r20743
Matt Mackall
help: always show command help with -h (issue4240)...
r21961 Test commands that collide with topics (issue4240)
$ hg config -hq
hg config [-u] [NAME]...
show combined config settings from all hgrc files
$ hg showconfig -hq
hg config [-u] [NAME]...
show combined config settings from all hgrc files
Dan Villiom Podlaski Christiansen
tests: unify test-help
r12073 Test a help topic
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 $ hg help dates
Date Formats
""""""""""""
Some commands allow the user to specify a date, e.g.:
- backout, commit, import, tag: Specify the commit date.
- log, revert, update: Select revision(s) by date.
Many date formats are valid. Here are some examples:
- "Wed Dec 6 13:18:29 2006" (local timezone assumed)
- "Dec 6 13:18 -0600" (year assumed, time offset provided)
- "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
- "Dec 6" (midnight)
- "13:18" (today assumed)
- "3:39" (3:39AM assumed)
- "3:39pm" (15:39)
- "2006-12-06 13:18:29" (ISO 8601 format)
- "2006-12-6 13:18"
- "2006-12-6"
- "12-6"
- "12/6"
- "12/6/6" (Dec 6 2006)
- "today" (midnight)
- "yesterday" (midnight)
- "now" - right now
Lastly, there is Mercurial's internal format:
- "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
This is the internal representation format for dates. The first number is
the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
is the offset of the local timezone, in seconds west of UTC (negative if
the timezone is east of UTC).
The log command also accepts date ranges:
- "<DATE" - at or before a given date/time
- ">DATE" - on or after a given date/time
- "DATE to DATE" - a date range, inclusive
- "-DAYS" - within a given number of days of today
Patrick Mezard
help: add topic rewriting hooks...
r12820
timeless@mozdev.org
help: distinguish sections when multiple match (issue4802)
r26113 Test repeated config section name
$ hg help config.host
"http_proxy.host"
Host name and (optional) port of the proxy server, for example
"myproxy:8000".
"smtp.host"
Host name of mail server, e.g. "mail.example.com".
timeless@mozdev.org
minirst: handle edge in hunting for parents...
r26170 Unrelated trailing paragraphs shouldn't be included
$ hg help config.extramsg | grep '^$'
timeless@mozdev.org
commands: support hg help scripting.HGPLAIN...
r26159 Test capitalized section name
$ hg help scripting.HGPLAIN > /dev/null
timeless@mozdev.org
minirst: don't treat top level item as children of last item (issue4803)...
r26157 Help subsection:
$ hg help config.charsets |grep "Email example:" > /dev/null
[1]
timeless@mozdev.org
minirst: establish leveling for nested definitions
r26237 Show nested definitions
("profiling.type"[break]"ls"[break]"stat"[break])
$ hg help config.type | egrep '^$'|wc -l
\s*3 (re)
timeless
help: include section heading if section depth changes...
r27614 Separate sections from subsections
$ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
"format"
--------
"usegeneraldelta"
"dotencode"
"usefncache"
"usestore"
"profiling"
-----------
"format"
"progress"
----------
"format"
timeless@mozdev.org
minirst: don't treat top level item as children of last item (issue4803)...
r26157 Last item in help config.*:
$ hg help config.`hg help config|grep '^ "'| \
> tail -1|sed 's![ "]*!!g'`| \
timeless
tests: favor single quotes for wrapping hg help ...
r29979 > grep 'hg help -c config' > /dev/null
timeless@mozdev.org
minirst: don't treat top level item as children of last item (issue4803)...
r26157 [1]
note to use help -c for general hg help config:
timeless
tests: favor single quotes for wrapping hg help ...
r29979 $ hg help config |grep 'hg help -c config' > /dev/null
timeless@mozdev.org
minirst: don't treat top level item as children of last item (issue4803)...
r26157
Patrick Mezard
test-help: test a sample of 'templates' topic help
r13584 Test templating help
$ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
Olav Reinert
minirst: simplify and standardize field list formatting...
r15861 desc String. The text of the changeset description.
diffstat String. Statistics of changes with the following format:
firstline Any text. Returns the first line of text.
nonempty Any text. Returns '(none)' if the string is empty.
Patrick Mezard
test-help: test a sample of 'templates' topic help
r13584
Yuya Nishihara
help: hide deprecated filesets, revsets and template items if not verbose...
r26415 Test deprecated items
$ hg help -v templating | grep currentbookmark
currentbookmark
$ hg help templating | (grep currentbookmark || true)
Patrick Mezard
help: add topic rewriting hooks...
r12820 Test help hooks
$ cat > helphook1.py <<EOF
> from mercurial import help
>
Yuya Nishihara
help: pass around ui to rewriter hooks (API)...
r26414 > def rewrite(ui, topic, doc):
Patrick Mezard
help: add topic rewriting hooks...
r12820 > return doc + '\nhelphook1\n'
>
> def extsetup(ui):
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 > help.addtopichook('revisions', rewrite)
Patrick Mezard
help: add topic rewriting hooks...
r12820 > EOF
$ cat > helphook2.py <<EOF
> from mercurial import help
>
Yuya Nishihara
help: pass around ui to rewriter hooks (API)...
r26414 > def rewrite(ui, topic, doc):
Patrick Mezard
help: add topic rewriting hooks...
r12820 > return doc + '\nhelphook2\n'
>
> def extsetup(ui):
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 > help.addtopichook('revisions', rewrite)
Patrick Mezard
help: add topic rewriting hooks...
r12820 > EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
$ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
$ hg help revsets | grep helphook
helphook1
helphook2
Olav Reinert
help: fix extension commands help in keyword search...
r16942
timeless
help: call filtercmd from topicmatch...
r27324 help -c should only show debug --debug
timeless
help: fix help -c/help -e/help -k...
r27325 $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
timeless
help: call filtercmd from topicmatch...
r27324 [1]
help -c should only show deprecated for -v
timeless
help: fix help -c/help -e/help -k...
r27325 $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
timeless
help: call filtercmd from topicmatch...
r27324 [1]
timeless
help: add --system flag to get help for various platform(s)
r27763 Test -s / --system
$ hg help config.files -s windows |grep 'etc/mercurial' | \
> wc -l | sed -e 's/ //g'
0
$ hg help config.files --system unix | grep 'USER' | \
> wc -l | sed -e 's/ //g'
0
timeless@mozdev.org
help: fix help argument parsing and documentation...
r26238 Test -e / -c / -k combinations
timeless
test-help: tighten grep patterns...
r27386 $ hg help -c|egrep '^[A-Z].*:|^ debug'
timeless
help: fix help -c/help -e/help -k...
r27325 Commands:
timeless
test-help: tighten grep patterns...
r27386 $ hg help -e|egrep '^[A-Z].*:|^ debug'
timeless
help: fix help -c/help -e/help -k...
r27325 Extensions:
timeless
help: filter extension commands
r27387 $ hg help -k|egrep '^[A-Z].*:|^ debug'
timeless
help: fix help -c/help -e/help -k...
r27325 Topics:
Commands:
Extensions:
Extension Commands:
Yuya Nishihara
test-help: don't use progress extension for the test of argument parsing...
r27115 $ hg help -c schemes
abort: no such help topic: schemes
timeless
help: use single quotes in use warning
r29974 (try 'hg help --keyword schemes')
timeless@mozdev.org
help: fix help argument parsing and documentation...
r26238 [255]
Yuya Nishihara
test-help: don't use progress extension for the test of argument parsing...
r27115 $ hg help -e schemes |head -1
schemes extension - extend schemes with shortcuts to repository swarms
timeless@mozdev.org
help: fix help argument parsing and documentation...
r26238 $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
Commands:
$ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
Extensions:
$ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
Extensions:
Commands:
$ hg help -c commit > /dev/null
$ hg help -e -c commit > /dev/null
$ hg help -e commit > /dev/null
abort: no such help topic: commit
timeless
help: use single quotes in use warning
r29974 (try 'hg help --keyword commit')
timeless@mozdev.org
help: fix help argument parsing and documentation...
r26238 [255]
Olav Reinert
help: fix extension commands help in keyword search...
r16942 Test keyword search help
FUJIWARA Katsunori
help: use full name of extensions to look up them for keyword search...
r19769 $ cat > prefixedname.py <<EOF
> '''matched against word "clone"
> '''
> EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
Olav Reinert
help: fix extension commands help in keyword search...
r16942 $ hg help -k clone
Topics:
config Configuration Files
extensions Using Additional Features
glossary Glossary
phases Working with Phases
Mads Kiilerich
help: use the first topic name from helptable, not the longest alias...
r17322 subrepos Subrepositories
Olav Reinert
help: fix extension commands help in keyword search...
r16942 urls URL Paths
Commands:
timeless
help: call filtercmd from topicmatch...
r27324 bookmarks create a new bookmark or list existing bookmarks
clone make a copy of an existing repository
paths show aliases for remote repositories
Joerg Sonnenberger
wireproto: support for pullbundles...
r37516 pull pull changes from the specified source
timeless
help: call filtercmd from topicmatch...
r27324 update update working directory (or switch revisions)
Olav Reinert
help: fix extension commands help in keyword search...
r16942
Extensions:
Gregory Szorc
exchange: make clone bundles non-experimental and enabled by default...
r27738 clonebundles advertise pre-generated bundles to seed clones
Augie Fackler
narrow: import experimental extension from narrowhg revision cb51d673e9c5...
r36096 narrow create clones which fetch history data for subset of files
(EXPERIMENTAL)
FUJIWARA Katsunori
help: use full name of extensions to look up them for keyword search...
r19769 prefixedname matched against word "clone"
relink recreates hardlinks between repository clones
Olav Reinert
help: fix extension commands help in keyword search...
r16942
Extension Commands:
qclone clone main and patch repository at same time
Pierre-Yves David
help: suggest keyword search when no topic is found...
r21289 Test unfound topic
$ hg help nonexistingtopicthatwillneverexisteverever
abort: no such help topic: nonexistingtopicthatwillneverexisteverever
timeless
help: use single quotes in use warning
r29974 (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
Pierre-Yves David
help: suggest keyword search when no topic is found...
r21289 [255]
Pierre-Yves David
help: provide a more helpful message when no keyword are matched...
r21288 Test unfound keyword
$ hg help --keyword nonexistingwordthatwillneverexisteverever
abort: no matches
timeless
help: use single quotes in use warning
r29974 (try 'hg help' for a list of topics)
Pierre-Yves David
help: provide a more helpful message when no keyword are matched...
r21288 [255]
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 Test omit indicating for help
$ cat > addverboseitems.py <<EOF
> '''extension to test omit indicating.
>
> This paragraph is never omitted (for extension)
>
> .. container:: verbose
>
> This paragraph is omitted,
André Sintzoff
test: fix typo in test-help.t
r23612 > if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 >
> This paragraph is never omitted, too (for extension)
> '''
Augie Fackler
tests: update test-help to pass our import checker
r33961 > from __future__ import absolute_import
> from mercurial import commands, help
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 > testtopic = """This paragraph is never omitted (for topic).
>
> .. container:: verbose
>
> This paragraph is omitted,
André Sintzoff
test: fix typo in test-help.t
r23612 > if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 >
> This paragraph is never omitted, too (for topic)
> """
> def extsetup(ui):
> help.helptable.append((["topic-containing-verbose"],
> "This is the topic to test omit indicating.",
Yuya Nishihara
help: pass around ui to doc loader (API)...
r26413 > lambda ui: testtopic))
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 > EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
$ hg help addverboseitems
addverboseitems extension - extension to test omit indicating.
This paragraph is never omitted (for extension)
This paragraph is never omitted, too (for extension)
Matt Mackall
help: normalize topic and extension verbose hints
r22114 (some details hidden, use --verbose to show complete help)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837
no commands defined
$ hg help -v addverboseitems
addverboseitems extension - extension to test omit indicating.
This paragraph is never omitted (for extension)
timeless
minirst: change hgrole to use single quotes...
r27729 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
André Sintzoff
test: fix typo in test-help.t
r23612 extension)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837
This paragraph is never omitted, too (for extension)
no commands defined
$ hg help topic-containing-verbose
This is the topic to test omit indicating.
Dan Villiom Podlaski Christiansen
help: use a full header for topic titles...
r18748 """"""""""""""""""""""""""""""""""""""""""
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837
This paragraph is never omitted (for topic).
This paragraph is never omitted, too (for topic)
Matt Mackall
help: normalize topic and extension verbose hints
r22114 (some details hidden, use --verbose to show complete help)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837 $ hg help -v topic-containing-verbose
This is the topic to test omit indicating.
Dan Villiom Podlaski Christiansen
help: use a full header for topic titles...
r18748 """"""""""""""""""""""""""""""""""""""""""
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837
This paragraph is never omitted (for topic).
timeless
minirst: change hgrole to use single quotes...
r27729 This paragraph is omitted, if 'hg help' is invoked without "-v" (for
André Sintzoff
test: fix typo in test-help.t
r23612 topic)
FUJIWARA Katsunori
help: indicate help omitting if help document is not fully displayed...
r17837
This paragraph is never omitted, too (for topic)
Matt Mackall
help: basic support for showing only specified topic sections...
r22587 Test section lookup
$ hg help revset.merge
"merge()"
Changeset is a merge changeset.
$ hg help glossary.dag
DAG
The repository of changesets of a distributed version control system
(DVCS) can be described as a directed acyclic graph (DAG), consisting
of nodes and edges, where nodes correspond to changesets and edges
imply a parent -> child relation. This graph can be visualized by
timeless
minirst: change hgrole to use single quotes...
r27729 graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
Matt Mackall
help: basic support for showing only specified topic sections...
r22587 limited by the requirement for children to have at most two parents.
Jordi Gutiérrez Hermoso
help: show all nested subsections of a section with `hg help foo.section`...
r22770
$ hg help hgrc.paths
"paths"
-------
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 Assigns symbolic names and behavior to repositories.
Options are symbolic names defining the URL or directory that is the
location of the repository. Example:
[paths]
my_server = https://example.com/my_repo
local_path = /home/me/repo
These symbolic names can be used from the command line. To pull from
timeless
minirst: change hgrole to use single quotes...
r27729 "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
local_path'.
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266
Options containing colons (":") denote sub-options that can influence
behavior for that specific path. Example:
[paths]
my_server = https://example.com/my_path
my_server:pushurl = ssh://example.com/my_path
The following sub-options can be defined:
"pushurl"
The URL to use for push operations. If not defined, the location
defined by the path's main entry is used.
Gregory Szorc
ui: path option to declare which revisions to push by default...
r29413 "pushrev"
A revset defining which revisions to push by default.
When 'hg push' is executed without a "-r" argument, the revset defined
by this sub-option is evaluated to determine what to push.
For example, a value of "." will push the working directory's revision
by default.
Revsets specifying bookmarks will not result in the bookmark being
pushed.
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 The following special named paths exist:
Jordi Gutiérrez Hermoso
help: show all nested subsections of a section with `hg help foo.section`...
r22770
"default"
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 The URL or directory to use when no source or remote is specified.
timeless
minirst: change hgrole to use single quotes...
r27729 'hg clone' will automatically define this path to the location the
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 repository was cloned from.
Jordi Gutiérrez Hermoso
help: show all nested subsections of a section with `hg help foo.section`...
r22770
"default-push"
timeless
minirst: change hgrole to use single quotes...
r27729 (deprecated) The URL or directory for the default 'hg push' location.
Gregory Szorc
ui: support declaring path push urls as sub-options...
r27266 "default:pushurl" should be used instead.
Jordi Gutiérrez Hermoso
help: show all nested subsections of a section with `hg help foo.section`...
r22770
Matt Mackall
help: basic support for showing only specified topic sections...
r22587 $ hg help glossary.mcguffin
Yuya Nishihara
help: show section that couldn't be found...
r30878 abort: help section not found: glossary.mcguffin
Matt Mackall
help: basic support for showing only specified topic sections...
r22587 [255]
Mads Kiilerich
help: don't crash on help for 'sections' with multiple '.'
r23122 $ hg help glossary.mc.guffin
Yuya Nishihara
help: show section that couldn't be found...
r30878 abort: help section not found: glossary.mc.guffin
Mads Kiilerich
help: don't crash on help for 'sections' with multiple '.'
r23122 [255]
Matt Harbison
help: support 'hg help template.somekeyword'...
r25723 $ hg help template.files
files List of strings. All files modified, added, or removed by
this changeset.
Hannes Oldenburg
templates: add built-in files() function...
r30008 files(pattern)
All files of the current changeset matching the pattern. See
'hg help patterns'.
Matt Harbison
help: support 'hg help template.somekeyword'...
r25723
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 Test section lookup by translated message
str.lower() instead of encoding.lower(str) on translated message might
make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
as the second or later byte of multi-byte character.
For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
replacement makes message meaningless.
This tests that section lookup by translated string isn't broken by
such str.lower().
Augie Fackler
tests: replace yet more calls to `python` with $PYTHON...
r33262 $ $PYTHON <<EOF
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > def escape(s):
> return ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
> # translation of "record" in ja_JP.cp932
> upper = "\x8bL\x98^"
> # str.lower()-ed section name should be treated as different one
> lower = "\x8bl\x98^"
> with open('ambiguous.py', 'w') as fp:
> fp.write("""# ambiguous section names in ja_JP.cp932
> u'''summary of extension
>
> %s
> ----
>
> Upper name should show only this message
>
> %s
> ----
>
> Lower name should show only this message
>
> subsequent section
> ------------------
>
timeless
tests: favor single quotes for wrapping hg help ...
r29979 > This should be hidden at 'hg help ambiguous' with section name.
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > '''
> """ % (escape(upper), escape(lower)))
> EOF
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = ./ambiguous.py
> EOF
Augie Fackler
tests: replace yet more calls to `python` with $PYTHON...
r33262 $ $PYTHON <<EOF | sh
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > upper = "\x8bL\x98^"
Augie Fackler
tests: clean up many print statements to be print functions instead...
r33687 > print("hg --encoding cp932 help -e ambiguous.%s" % upper)
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > EOF
\x8bL\x98^ (esc)
----
Upper name should show only this message
Augie Fackler
tests: replace yet more calls to `python` with $PYTHON...
r33262 $ $PYTHON <<EOF | sh
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > lower = "\x8bl\x98^"
Augie Fackler
tests: clean up many print statements to be print functions instead...
r33687 > print("hg --encoding cp932 help -e ambiguous.%s" % lower)
FUJIWARA Katsunori
help: search section of help topic by translated section name correctly...
r29155 > EOF
\x8bl\x98^ (esc)
----
Lower name should show only this message
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = !
> EOF
liscju
help: show content for explicitly disabled extension (issue5228)
r29895 Show help content of disabled extensions
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = !./ambiguous.py
> EOF
$ hg help -e ambiguous
ambiguous extension - (no help text available)
timeless
help: use single quotes in use warning
r29974 (use 'hg help extensions' for information on enabling extensions)
liscju
help: show content for explicitly disabled extension (issue5228)
r29895
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 Test dynamic list of merge tools only shows up once
$ hg help merge-tools
Merge Tools
"""""""""""
To merge files Mercurial uses merge tools.
A merge tool combines two different versions of a file into a merged file.
Merge tools are given the two files and the greatest common ancestor of
the two file versions, so they can determine the changes made on both
branches.
timeless
minirst: change hgrole to use single quotes...
r27729 Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
backout' and in several extensions.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100
Usually, the merge tool tries to automatically reconcile the files by
combining all non-overlapping changes that occurred separately in the two
different evolutions of the same initial base file. Furthermore, some
interactive merge programs make it easier to manually resolve conflicting
merges, either in a graphical way, or by inserting some conflict markers.
Mercurial does not include any interactive merge programs but relies on
external tools for that.
Available merge tools
=====================
External merge tools and their properties are configured in the merge-
tools configuration section - see hgrc(5) - but they can often just be
named by their executable.
A merge tool is generally usable if its executable can be found on the
system and if it can handle the merge. The executable is found if it is an
absolute or relative executable path or the name of an application in the
executable search path. The tool is assumed to be able to handle the merge
if it can handle symlinks if the file is a symlink, if it can handle
binary files if the file is binary, and if a GUI is available if the tool
requires a GUI.
There are some internal merge tools which can be used. The internal merge
tools are:
":dump"
Creates three versions of the files to merge, containing the contents of
local, other and base. These files can then be used to perform a merge
manually. If the file to be merged is named "a.txt", these files will
accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
they will be placed in the same directory as "a.txt".
Joe Blaylock
help: fix typo in hg merge documentation
r34916 This implies premerge. Therefore, files aren't dumped, if premerge runs
FUJIWARA Katsunori
filemerge: add internal merge tool to dump files forcibly...
r32255 successfully. Use :forcedump to forcibly write files out.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 ":fail"
Rather than attempting to merge files that were modified on both
branches, it marks them as unresolved. The resolve command must be used
to resolve these conflicts.
FUJIWARA Katsunori
filemerge: add internal merge tool to dump files forcibly...
r32255 ":forcedump"
Creates three versions of the files as same as :dump, but omits
premerge.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 ":local"
timeless
filemerge: use revset notation for p1/p2 of local/other descriptions
r28640 Uses the local 'p1()' version of files as the merged version.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100
":merge"
Uses the internal non-interactive simple merge algorithm for merging
files. It will fail if there are any conflicts and leave markers in the
partially merged file. Markers will have two sections, one for each side
of merge.
Jordi Gutiérrez Hermoso
filemerge: add non-interactive :merge-local and :merge-other...
r26224 ":merge-local"
Like :merge, but resolve all conflicts non-interactively in favor of the
timeless
filemerge: use revset notation for p1/p2 of local/other descriptions
r28640 local 'p1()' changes.
Jordi Gutiérrez Hermoso
filemerge: add non-interactive :merge-local and :merge-other...
r26224
":merge-other"
Like :merge, but resolve all conflicts non-interactively in favor of the
timeless
filemerge: use revset notation for p1/p2 of local/other descriptions
r28640 other 'p2()' changes.
Jordi Gutiérrez Hermoso
filemerge: add non-interactive :merge-local and :merge-other...
r26224
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 ":merge3"
Uses the internal non-interactive simple merge algorithm for merging
files. It will fail if there are any conflicts and leave markers in the
partially merged file. Marker will have three sections, one from each
side of the merge and one for the base content.
":other"
timeless
filemerge: use revset notation for p1/p2 of local/other descriptions
r28640 Uses the other 'p2()' version of files as the merged version.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100
":prompt"
timeless
filemerge: use revset notation for p1/p2 of local/other descriptions
r28640 Asks the user which of the local 'p1()' or the other 'p2()' version to
keep as the merged version.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100
":tagmerge"
Uses the internal tag merge algorithm (experimental).
Erik Huelsmann
filemerge: add 'union' merge to internal merge tool...
r26071 ":union"
Uses the internal non-interactive simple merge algorithm for merging
files. It will use both left and right sides for conflict regions. No
markers are inserted.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 Internal tools are always available and do not require a GUI but will by
default not handle symlinks or binary files.
Choosing a merge tool
=====================
Mercurial uses these rules when deciding which merge tool to use:
1. If a tool has been specified with the --tool option to merge or
resolve, it is used. If it is the name of a tool in the merge-tools
configuration, its configuration is used. Otherwise the specified tool
must be executable by the shell.
2. If the "HGMERGE" environment variable is present, its value is used and
must be executable by the shell.
3. If the filename of the file to be merged matches any of the patterns in
the merge-patterns configuration section, the first usable merge tool
corresponding to a matching pattern is used. Here, binary capabilities
of the merge tool are not considered.
4. If ui.merge is set it will be considered next. If the value is not the
name of a configured tool, the specified value is used and must be
executable by the shell. Otherwise the named tool is used if it is
usable.
5. If any usable merge tools are present in the merge-tools configuration
section, the one with the highest priority is used.
6. If a program named "hgmerge" can be found on the system, it is used -
but it will by default not be used for symlinks and binary files.
7. If the file to be merged is not binary and is not a symlink, then
internal ":merge" is used.
FUJIWARA Katsunori
help: describe about choice of :prompt as a fallback merge tool explicitly...
r32179 8. Otherwise, ":prompt" is used.
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100
Note:
After selecting a merge program, Mercurial will by default attempt to
merge the files using a simple merge algorithm first. Only if it
Matt Harbison
help: minor copy editing for grammar
r34950 doesn't succeed because of conflicting changes will Mercurial actually
Augie Fackler
test-help: add test to demonstrate that 'hg help merge-tools' is sane
r24100 execute the merge program. Whether to use the simple merge algorithm
first can be controlled by the premerge setting of the merge tool.
Premerge is enabled by default unless the file is binary or a symlink.
See the merge-tools and ui sections of hgrc(5) for details on the
configuration of merge tools.
Gregory Szorc
help: document bundle specifications...
r31793 Compression engines listed in `hg help bundlespec`
$ hg help bundlespec | grep gzip
"v1" bundles can only use the "gzip", "bzip2", and "none" compression
An algorithm that produces smaller bundles than "gzip".
This engine will likely produce smaller bundles than "gzip" but will be
"gzip"
Augie Fackler
tests: make zstd-related output optional...
r31817 better compression than "gzip". It also frequently yields better (?)
Gregory Szorc
help: document bundle specifications...
r31793
FUJIWARA Katsunori
doc: add the tool to check section marks in help documents...
r17648 Test usage of section marks in help documents
$ cd "$TESTDIR"/../doc
Augie Fackler
cleanup: use $PYTHON to run python in many more tests...
r32940 $ $PYTHON check-seclevel.py
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 $ cd $TESTTMP
#if serve
Test the help pages in hgweb.
Dish up an empty repo; serve it cold.
$ hg init "$TESTTMP/test"
$ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
$ cat hg.pid >> $DAEMON_PIDS
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help"
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: Index</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
Matt Mackall
urls: bulk-change primary website URLs
r26421 <a href="https://mercurial-scm.org/">
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active">help</li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
Gregory Szorc
hgweb: consolidate search form for paper...
r32758
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Alexander Plavin
paper: edit search hint to include new feature description
r19796 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </form>
<table class="bigtable">
av6
hgweb: make anchor name actually match its href on help index page
r30019 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745
<tr><td>
Gregory Szorc
help: document bundle specifications...
r31793 <a href="/help/bundlespec">
bundlespec
</a>
</td><td>
Bundle File Formats
</td></tr>
<tr><td>
Pierre-Yves David
color: update the help table...
r31129 <a href="/help/color">
color
</a>
</td><td>
Colorizing Outputs
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/config">
config
</a>
</td><td>
Configuration Files
</td></tr>
<tr><td>
<a href="/help/dates">
dates
</a>
</td><td>
Date Formats
</td></tr>
<tr><td>
<a href="/help/diffs">
diffs
</a>
</td><td>
Diff Formats
</td></tr>
<tr><td>
<a href="/help/environment">
environment
</a>
</td><td>
Environment Variables
</td></tr>
<tr><td>
<a href="/help/extensions">
extensions
</a>
</td><td>
Using Additional Features
</td></tr>
<tr><td>
<a href="/help/filesets">
filesets
</a>
</td><td>
Specifying File Sets
</td></tr>
<tr><td>
Rodrigo Damazio Bovendorp
help: adding a topic on flags...
r35036 <a href="/help/flags">
flags
</a>
</td><td>
Command-line flags
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/glossary">
glossary
</a>
</td><td>
Glossary
</td></tr>
<tr><td>
<a href="/help/hgignore">
hgignore
</a>
</td><td>
Syntax for Mercurial Ignore Files
</td></tr>
<tr><td>
<a href="/help/hgweb">
hgweb
</a>
</td><td>
Configuring hgweb
</td></tr>
<tr><td>
Gregory Szorc
help: add "internals" topic...
r27376 <a href="/help/internals">
internals
</a>
</td><td>
Technical implementation topics
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/merge-tools">
merge-tools
</a>
</td><td>
Merge Tools
</td></tr>
<tr><td>
Augie Fackler
pager: move most help to a new help topic and deprecate extension
r31061 <a href="/help/pager">
pager
</a>
</td><td>
Pager Support
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/patterns">
patterns
</a>
</td><td>
File Name Patterns
</td></tr>
<tr><td>
<a href="/help/phases">
phases
</a>
</td><td>
Working with Phases
</td></tr>
<tr><td>
<a href="/help/revisions">
revisions
</a>
</td><td>
Martin von Zweigbergk
help: merge revsets.txt into revisions.txt...
r30769 Specifying Revisions
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
Gregory Szorc
help: scripting help topic...
r25881 <a href="/help/scripting">
scripting
</a>
</td><td>
Using Mercurial from scripts and automation
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/subrepos">
subrepos
</a>
</td><td>
Subrepositories
</td></tr>
<tr><td>
<a href="/help/templating">
templating
</a>
</td><td>
Template Usage
</td></tr>
<tr><td>
<a href="/help/urls">
urls
</a>
</td><td>
URL Paths
</td></tr>
<tr><td>
<a href="/help/topic-containing-verbose">
topic-containing-verbose
</a>
</td><td>
This is the topic to test omit indicating.
</td></tr>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
Gregory Szorc
templates: make earlycommands and othercommands optional...
r27578
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745
<tr><td>
<a href="/help/add">
add
</a>
</td><td>
add the specified files on the next commit
</td></tr>
<tr><td>
<a href="/help/annotate">
annotate
</a>
</td><td>
show changeset information by line for each file
</td></tr>
<tr><td>
<a href="/help/clone">
clone
</a>
</td><td>
make a copy of an existing repository
</td></tr>
<tr><td>
<a href="/help/commit">
commit
</a>
</td><td>
commit the specified files or all outstanding changes
</td></tr>
<tr><td>
<a href="/help/diff">
diff
</a>
</td><td>
diff repository (or selected files)
</td></tr>
<tr><td>
<a href="/help/export">
export
</a>
</td><td>
dump the header and diffs for one or more changesets
</td></tr>
<tr><td>
<a href="/help/forget">
forget
</a>
</td><td>
forget the specified files on the next commit
</td></tr>
<tr><td>
<a href="/help/init">
init
</a>
</td><td>
create a new repository in the given directory
</td></tr>
<tr><td>
<a href="/help/log">
log
</a>
</td><td>
show revision history of entire repository or files
</td></tr>
<tr><td>
<a href="/help/merge">
merge
</a>
</td><td>
anatoly techtonik
merge: be precise about what merged into what in short desc
r23400 merge another revision into working directory
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/pull">
pull
</a>
</td><td>
pull changes from the specified source
</td></tr>
<tr><td>
<a href="/help/push">
push
</a>
</td><td>
push changes to the specified destination
</td></tr>
<tr><td>
<a href="/help/remove">
remove
</a>
</td><td>
remove the specified files on the next commit
</td></tr>
<tr><td>
<a href="/help/serve">
serve
</a>
</td><td>
start stand-alone webserver
</td></tr>
<tr><td>
<a href="/help/status">
status
</a>
</td><td>
show changed files in the working directory
</td></tr>
<tr><td>
<a href="/help/summary">
summary
</a>
</td><td>
summarize working directory state
</td></tr>
<tr><td>
<a href="/help/update">
update
</a>
</td><td>
update working directory (or switch revisions)
</td></tr>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
Gregory Szorc
templates: make earlycommands and othercommands optional...
r27578
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745
<tr><td>
<a href="/help/addremove">
addremove
</a>
</td><td>
add all new files, delete all missing files
</td></tr>
<tr><td>
<a href="/help/archive">
archive
</a>
</td><td>
create an unversioned archive of a repository revision
</td></tr>
<tr><td>
<a href="/help/backout">
backout
</a>
</td><td>
reverse effect of earlier changeset
</td></tr>
<tr><td>
<a href="/help/bisect">
bisect
</a>
</td><td>
subdivision search of changesets
</td></tr>
<tr><td>
<a href="/help/bookmarks">
bookmarks
</a>
</td><td>
Matt Mackall
bookmarks: improve the bookmark help (issue4244)
r21762 create a new bookmark or list existing bookmarks
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/branch">
branch
</a>
</td><td>
set or show the current branch name
</td></tr>
<tr><td>
<a href="/help/branches">
branches
</a>
</td><td>
list repository named branches
</td></tr>
<tr><td>
<a href="/help/bundle">
bundle
</a>
</td><td>
Gregory Szorc
commands: update help for "bundle"...
r31794 create a bundle file
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/cat">
cat
</a>
</td><td>
output the current or given revision of files
</td></tr>
<tr><td>
Matt Mackall
config: move showconfig code and add config as primary alias...
r20570 <a href="/help/config">
config
</a>
</td><td>
show combined config settings from all hgrc files
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/copy">
copy
</a>
</td><td>
mark files as copied for the next commit
</td></tr>
<tr><td>
Matt Mackall
files: add new command unifying locate and manifest functionality
r22423 <a href="/help/files">
files
</a>
</td><td>
list tracked files
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/graft">
graft
</a>
</td><td>
copy changes from other branches onto the current branch
</td></tr>
<tr><td>
<a href="/help/grep">
grep
</a>
</td><td>
Kevin Bullock
grep: rewrite help to better document current (confusing) behavior
r30009 search revision history for a pattern in specified files
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/heads">
heads
</a>
</td><td>
Matt Mackall
heads: modernize documentation (issue3992)...
r19469 show branch heads
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/help">
help
</a>
</td><td>
show help for a given topic or a help overview
</td></tr>
<tr><td>
timeless
help: report source of aliases
r28828 <a href="/help/hgalias">
hgalias
</a>
</td><td>
summarize working directory state
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/identify">
identify
</a>
</td><td>
Yuya Nishihara
commands: replace "working copy" with "working directory" in help/messages...
r24364 identify the working directory or specified revision
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/import">
import
</a>
</td><td>
import an ordered set of patches
</td></tr>
<tr><td>
<a href="/help/incoming">
incoming
</a>
</td><td>
show new changesets found in source
</td></tr>
<tr><td>
<a href="/help/manifest">
manifest
</a>
</td><td>
output the current or given revision of the project manifest
</td></tr>
<tr><td>
<a href="/help/nohelp">
nohelp
</a>
</td><td>
(no help text available)
</td></tr>
<tr><td>
<a href="/help/outgoing">
outgoing
</a>
</td><td>
show changesets not found in the destination
</td></tr>
<tr><td>
<a href="/help/paths">
paths
</a>
</td><td>
show aliases for remote repositories
</td></tr>
<tr><td>
<a href="/help/phase">
phase
</a>
</td><td>
set or show the current phase name
</td></tr>
<tr><td>
<a href="/help/recover">
recover
</a>
</td><td>
roll back an interrupted transaction
</td></tr>
<tr><td>
<a href="/help/rename">
rename
</a>
</td><td>
rename files; equivalent of copy + remove
</td></tr>
<tr><td>
<a href="/help/resolve">
resolve
</a>
</td><td>
redo merges or set/view the merge status of files
</td></tr>
<tr><td>
<a href="/help/revert">
revert
</a>
</td><td>
restore files to their checkout state
</td></tr>
<tr><td>
<a href="/help/root">
root
</a>
</td><td>
print the root (top) of the current working directory
</td></tr>
<tr><td>
timeless
help: report source of aliases
r28828 <a href="/help/shellalias">
shellalias
</a>
</td><td>
(no help text available)
</td></tr>
<tr><td>
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 <a href="/help/tag">
tag
</a>
</td><td>
add one or more tags for the current or given revision
</td></tr>
<tr><td>
<a href="/help/tags">
tags
</a>
</td><td>
list repository tags
</td></tr>
<tr><td>
<a href="/help/unbundle">
unbundle
</a>
</td><td>
Gregory Szorc
commands: update help for "unbundle"...
r31795 apply one or more bundle files
Dan Villiom Podlaski Christiansen
hgweb help: split up long lines (in generated output)
r18745 </td></tr>
<tr><td>
<a href="/help/verify">
verify
</a>
</td><td>
verify the integrity of the repository
</td></tr>
<tr><td>
<a href="/help/version">
version
</a>
</td><td>
output version and copyright information
</td></tr>
Gregory Szorc
templates: make earlycommands and othercommands optional...
r27578
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </table>
</div>
</div>
</body>
</html>
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: add</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
Matt Mackall
urls: bulk-change primary website URLs
r26421 <a href="https://mercurial-scm.org/">
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active"><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
<h3>Help: add</h3>
<form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Alexander Plavin
paper: edit search hint to include new feature description
r19796 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </form>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <div id="doc">
<p>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 hg add [OPTION]... [FILE]...
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 add the specified files on the next commit
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Schedule files to be version controlled and added to the
repository.
</p>
<p>
The files will be added to the repository at the next commit. To
timeless
minirst: change hgrole to use single quotes...
r27729 undo an add before that, see 'hg forget'.
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
timeless
add: mention .hgignore in help
r27424 If no names are given, add all files to the repository (except
files matching &quot;.hgignore&quot;).
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Mathias De Maré
commands: add example for 'hg add'
r27143 Examples:
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 </p>
Mathias De Maré
commands: add example for 'hg add'
r27143 <ul>
timeless
minirst: change hgrole to use single quotes...
r27729 <li> New (unknown) files are added automatically by 'hg add':
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 <pre>
\$ ls (re)
foo.c
\$ hg status (re)
? foo.c
\$ hg add (re)
adding foo.c
\$ hg status (re)
A foo.c
</pre>
Mathias De Maré
commands: add example for 'hg add'
r27143 <li> Specific files to be added can be specified:
<pre>
\$ ls (re)
bar.c foo.c
\$ hg status (re)
? bar.c
? foo.c
\$ hg add bar.c (re)
\$ hg status (re)
A bar.c
? foo.c
</pre>
</ul>
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 <p>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 Returns 0 if all files are successfully added.
</p>
<p>
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<table>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <tr><td>-I</td>
<td>--include PATTERN [+]</td>
<td>include names matching the given patterns</td></tr>
<tr><td>-X</td>
<td>--exclude PATTERN [+]</td>
<td>exclude names matching the given patterns</td></tr>
<tr><td>-S</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--subrepos</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>recurse into subrepositories</td></tr>
<tr><td>-n</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--dry-run</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>do not perform actions, just print output</td></tr>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </table>
<p>
Matt Mackall
help: fold repeatable option message into option table header...
r22117 global options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<table>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <tr><td>-R</td>
<td>--repository REPO</td>
<td>repository root directory or name of overlay bundle file</td></tr>
<tr><td></td>
<td>--cwd DIR</td>
<td>change working directory</td></tr>
<tr><td>-y</td>
<td>--noninteractive</td>
<td>do not prompt, automatically pick the first choice for all prompts</td></tr>
<tr><td>-q</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--quiet</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>suppress output</td></tr>
<tr><td>-v</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--verbose</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>enable additional output</td></tr>
<tr><td></td>
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 <td>--color TYPE</td>
Pierre-Yves David
color: update main documentation...
r31123 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 <tr><td></td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>--config CONFIG [+]</td>
<td>set/override config option (use 'section.name=value')</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--debug</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>enable debugging output</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--debugger</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>start debugger</td></tr>
<tr><td></td>
<td>--encoding ENCODE</td>
<td>set the charset encoding (default: ascii)</td></tr>
<tr><td></td>
<td>--encodingmode MODE</td>
<td>set the charset encoding mode (default: strict)</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--traceback</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>always print a traceback on exception</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--time</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>time how long the command takes</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--profile</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>print command execution profile</td></tr>
<tr><td></td>
<td>--version</td>
<td>output version information and exit</td></tr>
<tr><td>-h</td>
<td>--help</td>
<td>display help and exit</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--hidden</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>consider hidden changesets</td></tr>
Augie Fackler
pager: move more behavior into core...
r30993 <tr><td></td>
<td>--pager TYPE</td>
<td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </table>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </div>
</div>
</body>
</html>
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: remove</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
Matt Mackall
urls: bulk-change primary website URLs
r26421 <a href="https://mercurial-scm.org/">
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active"><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
<h3>Help: remove</h3>
<form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Alexander Plavin
paper: edit search hint to include new feature description
r19796 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </form>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <div id="doc">
<p>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 hg remove [OPTION]... FILE...
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 aliases: rm
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 remove the specified files on the next commit
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Schedule the indicated files for removal from the current branch.
</p>
<p>
This command schedules the files to be removed at the next commit.
timeless
minirst: change hgrole to use single quotes...
r27729 To undo a remove before that, see 'hg revert'. To undo added
files, see 'hg forget'.
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 -A/--after can be used to remove only files that have already
been deleted, -f/--force can be used to force deletion, and -Af
can be used to remove files from the next revision without
deleting them from the working directory.
</p>
<p>
The following table details the behavior of remove for different
file states (columns) and option combinations (rows). The file
states are Added [A], Clean [C], Modified [M] and Missing [!]
timeless
minirst: change hgrole to use single quotes...
r27729 (as reported by 'hg status'). The actions are Warn, Remove
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 (from branch) and Delete (from disk):
</p>
<table>
FUJIWARA Katsunori
doc: put text into header of 1st column in table to generate page correctly...
r19960 <tr><td>opt/state</td>
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 <td>A</td>
<td>C</td>
<td>M</td>
<td>!</td></tr>
<tr><td>none</td>
<td>W</td>
<td>RD</td>
<td>W</td>
<td>R</td></tr>
<tr><td>-f</td>
<td>R</td>
<td>RD</td>
<td>RD</td>
<td>R</td></tr>
<tr><td>-A</td>
<td>W</td>
<td>W</td>
<td>W</td>
<td>R</td></tr>
<tr><td>-Af</td>
<td>R</td>
<td>R</td>
<td>R</td>
<td>R</td></tr>
</table>
<p>
timeless
remove: quote --force in never deletes note...
r27489 <b>Note:</b>
</p>
<p>
timeless
minirst: change hgrole to use single quotes...
r27729 'hg remove' never deletes files in Added [A] state from the
timeless
remove: quote --force in never deletes note...
r27489 working directory, not even if &quot;--force&quot; is specified.
Alexander Plavin
hgweb: make help verbose again (issue3899)...
r19079 </p>
<p>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 Returns 0 on success, 1 if any warnings encountered.
</p>
<p>
Matt Mackall
help: fold repeatable option message into option table header...
r22117 options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<table>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <tr><td>-A</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--after</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>record delete for missing files</td></tr>
<tr><td>-f</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--force</td>
liscju
remove: fix --force option help description (issue5177)...
r28902 <td>forget added files, delete modified files</td></tr>
Matt Harbison
remove: recurse into subrepositories with --subrepos/-S flag...
r23325 <tr><td>-S</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--subrepos</td>
Matt Harbison
remove: recurse into subrepositories with --subrepos/-S flag...
r23325 <td>recurse into subrepositories</td></tr>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <tr><td>-I</td>
<td>--include PATTERN [+]</td>
<td>include names matching the given patterns</td></tr>
<tr><td>-X</td>
<td>--exclude PATTERN [+]</td>
<td>exclude names matching the given patterns</td></tr>
Sushil khanchi
remove: add dry-run functionality
r37168 <tr><td>-n</td>
<td>--dry-run</td>
<td>do not perform actions, just print output</td></tr>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </table>
<p>
Matt Mackall
help: fold repeatable option message into option table header...
r22117 global options ([+] can be repeated):
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<table>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <tr><td>-R</td>
<td>--repository REPO</td>
<td>repository root directory or name of overlay bundle file</td></tr>
<tr><td></td>
<td>--cwd DIR</td>
<td>change working directory</td></tr>
<tr><td>-y</td>
<td>--noninteractive</td>
<td>do not prompt, automatically pick the first choice for all prompts</td></tr>
<tr><td>-q</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--quiet</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>suppress output</td></tr>
<tr><td>-v</td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--verbose</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>enable additional output</td></tr>
<tr><td></td>
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 <td>--color TYPE</td>
Pierre-Yves David
color: update main documentation...
r31123 <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
Pierre-Yves David
color: add the definition of '--color' in core...
r31104 <tr><td></td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>--config CONFIG [+]</td>
<td>set/override config option (use 'section.name=value')</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--debug</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>enable debugging output</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--debugger</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>start debugger</td></tr>
<tr><td></td>
<td>--encoding ENCODE</td>
<td>set the charset encoding (default: ascii)</td></tr>
<tr><td></td>
<td>--encodingmode MODE</td>
<td>set the charset encoding mode (default: strict)</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--traceback</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>always print a traceback on exception</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--time</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>time how long the command takes</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--profile</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>print command execution profile</td></tr>
<tr><td></td>
<td>--version</td>
<td>output version information and exit</td></tr>
<tr><td>-h</td>
<td>--help</td>
<td>display help and exit</td></tr>
<tr><td></td>
Pierre-Yves David
help: backout f3c4edfd35e1 (mark boolean flags with [no-] in help) for now...
r30152 <td>--hidden</td>
Dan Villiom Podlaski Christiansen
minirst: HTML formatter tweaks...
r18751 <td>consider hidden changesets</td></tr>
Augie Fackler
pager: move more behavior into core...
r30993 <tr><td></td>
<td>--pager TYPE</td>
<td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </table>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </div>
</div>
</body>
</html>
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <title>Help: dates</title>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
Matt Mackall
urls: bulk-change primary website URLs
r26421 <a href="https://mercurial-scm.org/">
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 <img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active"><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <h3>Help: dates</h3>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
<form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Alexander Plavin
paper: edit search hint to include new feature description
r19796 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </form>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <div id="doc">
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <h1>Date Formats</h1>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 Some commands allow the user to specify a date, e.g.:
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <ul>
<li> backout, commit, import, tag: Specify the commit date.
<li> log, revert, update: Select revision(s) by date.
</ul>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 Many date formats are valid. Here are some examples:
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <ul>
<li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
<li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
<li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
<li> &quot;Dec 6&quot; (midnight)
<li> &quot;13:18&quot; (today assumed)
<li> &quot;3:39&quot; (3:39AM assumed)
<li> &quot;3:39pm&quot; (15:39)
<li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
<li> &quot;2006-12-6 13:18&quot;
<li> &quot;2006-12-6&quot;
<li> &quot;12-6&quot;
<li> &quot;12/6&quot;
<li> &quot;12/6/6&quot; (Dec 6 2006)
<li> &quot;today&quot; (midnight)
<li> &quot;yesterday&quot; (midnight)
<li> &quot;now&quot; - right now
</ul>
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 <p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 Lastly, there is Mercurial's internal format:
</p>
<ul>
<li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
</ul>
<p>
This is the internal representation format for dates. The first number
is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
second is the offset of the local timezone, in seconds west of UTC
(negative if the timezone is east of UTC).
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
<p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 The log command also accepts date ranges:
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </p>
Martin von Zweigbergk
tests: use `hg help dates` instead of `hg help revs` in test...
r30768 <ul>
<li> &quot;&lt;DATE&quot; - at or before a given date/time
<li> &quot;&gt;DATE&quot; - on or after a given date/time
<li> &quot;DATE to DATE&quot; - a date range, inclusive
<li> &quot;-DAYS&quot; - within a given number of days of today
</ul>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
Dan Villiom Podlaski Christiansen
hgweb: generate HTML documentation...
r18747 </div>
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744 </div>
</div>
</body>
</html>
av6
tests: demonstrate that hgweb renders "pruned" that minirst.format() returns...
r38242 $ get-with-headers.py $LOCALIP:$HGPORT "help/pager"
200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: pager</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
<a href="https://mercurial-scm.org/">
<img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active"><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
<h3>Help: pager</h3>
<form class="search" action="/log">
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
<div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
</form>
<div id="doc">
<h1>Pager Support</h1>
<p>
Some Mercurial commands can produce a lot of output, and Mercurial will
attempt to use a pager to make those commands more pleasant.
</p>
<p>
To set the pager that should be used, set the application variable:
</p>
<pre>
[pager]
pager = less -FRX
</pre>
<p>
If no pager is set in the user or repository configuration, Mercurial uses the
environment variable $PAGER. If $PAGER is not set, pager.pager from the default
or system configuration is used. If none of these are set, a default pager will
be used, typically 'less' on Unix and 'more' on Windows.
</p>
<p>
You can disable the pager for certain commands by adding them to the
pager.ignore list:
</p>
<pre>
[pager]
ignore = version, help, update
</pre>
<p>
To ignore global commands like 'hg version' or 'hg help', you have
to specify them in your user configuration file.
</p>
<p>
To control whether the pager is used at all for an individual command,
you can use --pager=&lt;value&gt;:
</p>
<ul>
<li> use as needed: 'auto'.
<li> require the pager: 'yes' or 'on'.
<li> suppress the pager: 'no' or 'off' (any unrecognized value will also work).
</ul>
<p>
To globally turn off all attempts to use a pager, set:
</p>
<pre>
[ui]
paginate = never
</pre>
<p>
which will prevent the pager from running.
</p>
av6
templatefuncs: only render text portion of minirst.format() result...
r38243
av6
tests: demonstrate that hgweb renders "pruned" that minirst.format() returns...
r38242 </div>
</div>
</div>
</body>
</html>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 Sub-topic indexes rendered properly
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: internals</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
<a href="https://mercurial-scm.org/">
<img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
Gregory Szorc
hgweb: consolidate search form for paper...
r32758
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 <form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
</form>
<table class="bigtable">
av6
hgweb: make anchor name actually match its href on help index page
r30019 <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581
<tr><td>
Gregory Szorc
internals: document bundle2 format...
r36469 <a href="/help/internals.bundle2">
bundle2
</a>
</td><td>
Bundle2
</td></tr>
<tr><td>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 <a href="/help/internals.bundles">
bundles
</a>
</td><td>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 Bundles
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 </td></tr>
<tr><td>
Augie Fackler
help: update help.internalstable for new censor docs
r31293 <a href="/help/internals.censor">
censor
</a>
</td><td>
Censor
</td></tr>
<tr><td>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 <a href="/help/internals.changegroups">
changegroups
</a>
</td><td>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 Changegroups
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581 </td></tr>
Gregory Szorc
internals: document revlog format...
r27631 <tr><td>
Boris Feld
internal-doc: document the config register mechanism...
r34933 <a href="/help/internals.config">
config
</a>
</td><td>
Kevin Bullock
internals: update test-help.t for config registrar copy-edit
r34953 Config Registrar
Boris Feld
internal-doc: document the config register mechanism...
r34933 </td></tr>
<tr><td>
Gregory Szorc
help: document requirements...
r28523 <a href="/help/internals.requirements">
requirements
</a>
</td><td>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 Repository Requirements
Gregory Szorc
help: document requirements...
r28523 </td></tr>
<tr><td>
Gregory Szorc
internals: document revlog format...
r27631 <a href="/help/internals.revlogs">
revlogs
</a>
</td><td>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 Revision Logs
Gregory Szorc
internals: document revlog format...
r27631 </td></tr>
Gregory Szorc
help: internals topic for wire protocol...
r29859 <tr><td>
<a href="/help/internals.wireprotocol">
wireprotocol
</a>
</td><td>
Wire Protocol
Gregory Szorc
internals: document revlog format...
r27631 </td></tr>
Gregory Szorc
hgweb: support rendering sub-topic indexes...
r27581
</table>
</div>
</div>
</body>
</html>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 Sub-topic topics rendered properly
Jun Wu
tests: use LOCALIP...
r31008 $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 200 Script output follows
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>Help: internals.changegroups</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
<a href="https://mercurial-scm.org/">
<img src="/static/hglogo.png" alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li class="active"><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
<h3>Help: internals.changegroups</h3>
<form class="search" action="/log">
Gregory Szorc
hgweb: consolidate search form for paper...
r32758 <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
</form>
<div id="doc">
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 <h1>Changegroups</h1>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
Changegroups are representations of repository revlog data, specifically
Kyle Lippincott
help: fix internals.changegroups...
r31213 the changelog data, root/flat manifest data, treemanifest data, and
filelogs.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<p>
There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
Kyle Lippincott
help: fix internals.changegroups...
r31213 high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
only difference being an additional item in the *delta header*. Version
&quot;3&quot; adds support for revlog flags in the *delta header* and optionally
exchanging treemanifests (enabled by setting an option on the
&quot;changegroup&quot; part in the bundle2).
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 Changegroups when not exchanging treemanifests consist of 3 logical
segments:
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<pre>
+---------------------------------+
| | | |
| changeset | manifest | filelogs |
| | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | | | |
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 +---------------------------------+
</pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 When exchanging treemanifests, there are 4 logical segments:
</p>
<pre>
+-------------------------------------------------+
| | | | |
| changeset | root | treemanifests | filelogs |
| | manifest | | |
| | | | |
+-------------------------------------------------+
</pre>
<p>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 The principle building block of each segment is a *chunk*. A *chunk*
is a framed piece of data:
</p>
<pre>
+---------------------------------------+
| | |
| length | data |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | (4 bytes) | (&lt;length - 4&gt; bytes) |
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 | | |
+---------------------------------------+
</pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 All integers are big-endian signed integers. Each chunk starts with a 32-bit
integer indicating the length of the entire chunk (including the length field
itself).
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 There is a special case chunk that has a value of 0 for the length
(&quot;0x00000000&quot;). We call this an *empty chunk*.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 <h2>Delta Groups</h2>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
A *delta group* expresses the content of a revlog as a series of deltas,
or patches against previous revisions.
</p>
<p>
Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
to signal the end of the delta group:
</p>
<pre>
+------------------------------------------------------------------------+
| | | | | |
| chunk0 length | chunk0 data | chunk1 length | chunk1 data | 0x0 |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 | | | | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 +------------------------------------------------------------------------+
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </pre>
<p>
Each *chunk*'s data consists of the following:
</p>
<pre>
Kyle Lippincott
help: fix internals.changegroups...
r31213 +---------------------------------------+
| | |
| delta header | delta data |
| (various by version) | (various) |
| | |
+---------------------------------------+
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *delta data* is a series of *delta*s that describe a diff from an existing
entry (either that the recipient already has, or previously specified in the
Matt Harbison
help: spelling fixes
r32139 bundle/changegroup).
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<p>
The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, and
&quot;3&quot; of the changegroup format.
</p>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 1 (headerlen=80):
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<pre>
+------------------------------------------------------+
| | | | |
| node | p1 node | p2 node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | |
+------------------------------------------------------+
</pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 2 (headerlen=100):
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<pre>
+------------------------------------------------------------------+
| | | | | |
| node | p1 node | p2 node | base node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | | |
+------------------------------------------------------------------+
</pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 Version 3 (headerlen=102):
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<pre>
+------------------------------------------------------------------------------+
| | | | | | |
Kyle Lippincott
help: fix internals.changegroups...
r31213 | node | p1 node | p2 node | base node | link node | flags |
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
| | | | | | |
+------------------------------------------------------------------------------+
</pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
series of *delta*s, densely packed (no separators). These deltas describe a diff
from an existing entry (either that the recipient already has, or previously
specified in the bundle/changegroup). The format is described more fully in
&quot;hg help internals.bdiff&quot;, but briefly:
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
Yuya Nishihara
help: fix layout of pre-formatted text
r31287 <pre>
Kyle Lippincott
help: fix internals.changegroups...
r31213 +---------------------------------------------------------------+
| | | | |
| start offset | end offset | new length | content |
| (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
| | | | |
+---------------------------------------------------------------+
Yuya Nishihara
help: fix layout of pre-formatted text
r31287 </pre>
Kyle Lippincott
help: fix internals.changegroups...
r31213 <p>
Please note that the length field in the delta data does *not* include itself.
</p>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
In version 1, the delta is always applied against the previous node from
the changegroup or the first parent if this is the first entry in the
changegroup.
</p>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 In version 2 and up, the delta base node is encoded in the entry in the
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 changegroup. This allows the delta to be expressed against any parent,
which can result in smaller deltas and more efficient encoding of data.
</p>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 <h2>Changeset Segment</h2>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
The *changeset segment* consists of a single *delta group* holding
Kyle Lippincott
help: fix internals.changegroups...
r31213 changelog data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the *manifest segment*.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 <h2>Manifest Segment</h2>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *manifest segment* consists of a single *delta group* holding manifest
data. If treemanifests are in use, it contains only the manifest for the
root directory of the repository. Otherwise, it contains the entire
manifest data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the next segment (either the *treemanifests segment* or the
*filelogs segment*, depending on version and the request options).
</p>
<h3>Treemanifests Segment</h3>
<p>
The *treemanifests segment* only exists in changegroup version &quot;3&quot;, and
only if the 'treemanifest' param is part of the bundle2 changegroup part
(it is not possible to use changegroup version 3 outside of bundle2).
Aside from the filenames in the *treemanifests segment* containing a
trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
(see below). The final sub-segment is followed by an *empty chunk* (logically,
a sub-segment with filename size 0). This denotes the boundary to the
*filelogs segment*.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
Gregory Szorc
help: don't try to render a section on sub-topics...
r29747 <h2>Filelogs Segment</h2>
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 <p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 The *filelogs segment* consists of multiple sub-segments, each
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 corresponding to an individual file whose data is being described:
</p>
<pre>
Kyle Lippincott
help: fix internals.changegroups...
r31213 +--------------------------------------------------+
| | | | | |
| filelog0 | filelog1 | filelog2 | ... | 0x0 |
| | | | | (4 bytes) |
| | | | | |
+--------------------------------------------------+
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </pre>
<p>
Kyle Lippincott
help: fix internals.changegroups...
r31213 The final filelog sub-segment is followed by an *empty chunk* (logically,
a sub-segment with filename size 0). This denotes the end of the segment
and of the overall changegroup.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
<p>
Each filelog sub-segment consists of the following:
</p>
<pre>
Kyle Lippincott
help: fix internals.changegroups...
r31213 +------------------------------------------------------+
| | | |
| filename length | filename | delta group |
| (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
| | | |
+------------------------------------------------------+
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </pre>
<p>
That is, a *chunk* consisting of the filename (not terminated or padded)
Kyle Lippincott
help: fix internals.changegroups...
r31213 followed by N chunks constituting the *delta group* for this file. The
*empty chunk* at the end of each *delta group* denotes the boundary to the
next filelog sub-segment.
Gregory Szorc
hgweb: support rendering a sub-topic...
r27582 </p>
</div>
</div>
</div>
</body>
</html>
Yuya Nishihara
hgweb: translate Abort in help command to 404 error...
r36262 $ get-with-headers.py 127.0.0.1:$HGPORT "help/unknowntopic"
404 Not Found
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
<head>
<link rel="icon" href="/static/hgicon.png" type="image/png" />
<meta name="robots" content="index, nofollow" />
<link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
<script type="text/javascript" src="/static/mercurial.js"></script>
<title>test: error</title>
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
<a href="https://mercurial-scm.org/">
<img src="/static/hglogo.png" width=75 height=90 border=0 alt="mercurial" /></a>
</div>
<ul>
<li><a href="/shortlog">log</a></li>
<li><a href="/graph">graph</a></li>
<li><a href="/tags">tags</a></li>
<li><a href="/bookmarks">bookmarks</a></li>
<li><a href="/branches">branches</a></li>
</ul>
<ul>
<li><a href="/help">help</a></li>
</ul>
</div>
<div class="main">
<h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
<h3>error</h3>
<form class="search" action="/log">
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
<div id="hint">Find changesets by keywords (author, files, the commit message), revision
number or hash, or <a href="/help/revsets">revset expression</a>.</div>
</form>
<div class="description">
<p>
An error occurred while processing your request:
</p>
<p>
Not Found
</p>
</div>
</div>
</div>
</body>
</html>
[1]
Matt Mackall
tests: drop DAEMON_PIDS from killdaemons calls
r25474 $ killdaemons.py
Dan Villiom Podlaski Christiansen
hgweb help: add tests
r18744
#endif