facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-06 23:07:18 +03:00
Code Issues Projects Releases Wiki Activity
9cf8ea29dd
sapling/tests/test-help.t

3396 lines
107 KiB
Perl
Raw Normal View History

tests: fix a bunch of pointless #s in unified tests
2010-09-18 02:03:08 +04:00
Short help:
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg
Mercurial Distributed SCM
basic commands:
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help' for the full list of commands or 'hg -v' for details)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg -q
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg help
Mercurial Distributed SCM
list of commands:
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
bookmarks: improve the bookmark help (issue4244)
2014-06-19 00:26:07 +04:00
bookmarks create a new bookmark or list existing bookmarks
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
branch set or show the current branch name
branches list repository named branches
commands: update help for "bundle" We now have a dedicated help topic to describe bundle specification strings. Let's update `hg bundle`'s documentation to reflect its existence. While I was hear, I also tweaked some wording which I felt was out of date and needed tweaking. Specifically, `hg bundle` no longer just deals with "changegroup" data: it can also generate files that have non-changegroup data.
2017-04-01 23:43:43 +03:00
bundle create a bundle file
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
config: move showconfig code and add config as primary alias Preparation for adding config --edit to launch an editor
2014-02-27 22:42:09 +04:00
config show combined config settings from all hgrc files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
files: add new command unifying locate and manifest functionality
2014-09-13 03:32:46 +04:00
files list tracked files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
grep: rewrite help to better document current (confusing) behavior
2016-09-23 20:45:10 +03:00
grep search revision history for a pattern in specified files
heads: modernize documentation (issue3992) The old docs emphasized topological heads rather than branch heads and incorrectly defined branch heads as not having children rather than descendants.
2013-07-22 03:45:42 +04:00
heads show branch heads
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
help show help for a given topic or a help overview
commands: replace "working copy" with "working directory" in help/messages "working directory" is the standard term, we should use it consistently. But I didn't touch the hint, "run 'hg update' to get a working copy", because "get a working directory" sounds a bit odd.
2015-03-17 16:47:08 +03:00
identify identify the working directory or specified revision
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
commands: update help for "unbundle" Similar to the recent change to "bundle," this command no longer just deals with "changegroup" data.
2017-04-01 23:43:52 +03:00
unbundle apply one or more bundle files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
tests: unify test-help
2010-08-27 18:25:47 +04:00
additional help topics:
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
bundlespec Bundle File Formats
color: update the help table We also need to reference the new topic in the great old help table.
2017-03-01 22:22:04 +03:00
color Colorizing Outputs
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
extensions Using Additional Features
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
filesets Specifying File Sets
help: adding a topic on flags This is a short topic to explain how command-line flags can be specified. Some users have been confused by hg offerring different flag syntax than some other libraries, so it'd be nice to point them to this rather than explaining it every time. Differential Revision: https://phab.mercurial-scm.org/D1270
2017-10-31 06:35:30 +03:00
flags Command-line flags
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
glossary Glossary
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
hgignore Syntax for Mercurial Ignore Files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
hgweb Configuring hgweb
help: add "internals" topic We introduce the "internals" help topic, which renders an index of available sub-topics. The sub-topics themselves are still not reachable via the help system.
2015-12-13 21:35:03 +03:00
internals Technical implementation topics
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
merge-tools Merge Tools
pager: move most help to a new help topic and deprecate extension
2017-02-07 08:07:53 +03:00
pager Pager Support
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
patterns File Name Patterns
help: add phases topic
2012-01-26 21:23:14 +04:00
phases Working with Phases
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
revisions Specifying Revisions
help: scripting help topic There are a lot of non-human consumers of Mercurial. And the challenges and considerations for machines consuming Mercurial is significantly different from what humans face. I think there are enough special considerations around how machines consume Mercurial that a dedicated help topic is warranted. I concede the audience for this topic is probably small compared to the general audience. However, lots of normal Mercurial users do things like create one-off shell scripts for common workflows that I think this is useful enough to be in the install (as opposed to, say, a wiki page - which most users will likely never find). This text is by no means perfect. But you have to start somewhere. I think I did cover the important parts, though.
2015-07-19 03:10:28 +03:00
scripting Using Mercurial from scripts and automation
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
subrepos Subrepositories
templating Template Usage
urls URL Paths
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help -v' to show built-in aliases and global options)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg -q help
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
bookmarks: improve the bookmark help (issue4244)
2014-06-19 00:26:07 +04:00
bookmarks create a new bookmark or list existing bookmarks
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
branch set or show the current branch name
branches list repository named branches
commands: update help for "bundle" We now have a dedicated help topic to describe bundle specification strings. Let's update `hg bundle`'s documentation to reflect its existence. While I was hear, I also tweaked some wording which I felt was out of date and needed tweaking. Specifically, `hg bundle` no longer just deals with "changegroup" data: it can also generate files that have non-changegroup data.
2017-04-01 23:43:43 +03:00
bundle create a bundle file
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
config: move showconfig code and add config as primary alias Preparation for adding config --edit to launch an editor
2014-02-27 22:42:09 +04:00
config show combined config settings from all hgrc files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
files: add new command unifying locate and manifest functionality
2014-09-13 03:32:46 +04:00
files list tracked files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
grep: rewrite help to better document current (confusing) behavior
2016-09-23 20:45:10 +03:00
grep search revision history for a pattern in specified files
heads: modernize documentation (issue3992) The old docs emphasized topological heads rather than branch heads and incorrectly defined branch heads as not having children rather than descendants.
2013-07-22 03:45:42 +04:00
heads show branch heads
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
help show help for a given topic or a help overview
commands: replace "working copy" with "working directory" in help/messages "working directory" is the standard term, we should use it consistently. But I didn't touch the hint, "run 'hg update' to get a working copy", because "get a working directory" sounds a bit odd.
2015-03-17 16:47:08 +03:00
identify identify the working directory or specified revision
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
commands: update help for "unbundle" Similar to the recent change to "bundle," this command no longer just deals with "changegroup" data.
2017-04-01 23:43:52 +03:00
unbundle apply one or more bundle files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
tests: unify test-help
2010-08-27 18:25:47 +04:00
additional help topics:
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
bundlespec Bundle File Formats
color: update the help table We also need to reference the new topic in the great old help table.
2017-03-01 22:22:04 +03:00
color Colorizing Outputs
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
extensions Using Additional Features
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
filesets Specifying File Sets
help: adding a topic on flags This is a short topic to explain how command-line flags can be specified. Some users have been confused by hg offerring different flag syntax than some other libraries, so it'd be nice to point them to this rather than explaining it every time. Differential Revision: https://phab.mercurial-scm.org/D1270
2017-10-31 06:35:30 +03:00
flags Command-line flags
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
glossary Glossary
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
hgignore Syntax for Mercurial Ignore Files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
hgweb Configuring hgweb
help: add "internals" topic We introduce the "internals" help topic, which renders an index of available sub-topics. The sub-topics themselves are still not reachable via the help system.
2015-12-13 21:35:03 +03:00
internals Technical implementation topics
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
merge-tools Merge Tools
pager: move most help to a new help topic and deprecate extension
2017-02-07 08:07:53 +03:00
pager Pager Support
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
patterns File Name Patterns
help: add phases topic
2012-01-26 21:23:14 +04:00
phases Working with Phases
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
revisions Specifying Revisions
help: scripting help topic There are a lot of non-human consumers of Mercurial. And the challenges and considerations for machines consuming Mercurial is significantly different from what humans face. I think there are enough special considerations around how machines consume Mercurial that a dedicated help topic is warranted. I concede the audience for this topic is probably small compared to the general audience. However, lots of normal Mercurial users do things like create one-off shell scripts for common workflows that I think this is useful enough to be in the install (as opposed to, say, a wiki page - which most users will likely never find). This text is by no means perfect. But you have to start somewhere. I think I did cover the important parts, though.
2015-07-19 03:10:28 +03:00
scripting Using Mercurial from scripts and automation
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
subrepos Subrepositories
templating Template Usage
urls URL Paths
tests: unify test-help
2010-08-27 18:25:47 +04:00
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
Test extension help:
extensions: remove the inotify extension (BC) This extension has always had correctness issues and has been unmaintained for years. It is now removed in favor of the third-party hgwatchman which is maintained and appears to be correct. Users with inotify enabled in their config files will fall back to standard status performance.
2014-03-02 02:20:15 +04:00
$ hg help extensions --config extensions.rebase= --config extensions.children=
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
See 'hg help config' for more information on configuration files.
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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:
absorb: move to hgext Summary: Move absorb to hgext. Test Plan: `run-tests.py -l` with empty `PYTHONPATH`. Reviewers: durham, #mercurial Reviewed By: durham Differential Revision: https://phabricator.intern.facebook.com/D6678562 Signature: 6678562:1515455701:8778bc0ce54ec017483f6826a9792bebcb9464d7
2018-01-09 00:57:01 +03:00
absorb apply working directory changes to changesets
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
acl hooks for controlling repository access
blackbox log repository events to a blackbox for debugging
bugzilla hooks for integrating with the Bugzilla bug tracker
censor: add censor command to hgext with basic client-side tests The censor command is a core extension which can replace the contents of a historical file revision with a censor "tombstone" which can be exchanged with older clients in place of the real revision data. The command rewrites the filelog by copying revision-by-revision. Care must be taken to expand the fulltext of the children of the censored revision before copying them to the new filelog; they might be stored as deltas against the uncensored revision, and those deltas will be invalidated. For more background on the censorship feature design, see: http://mercurial.selenic.com/wiki/CensorPlan
2015-03-16 04:52:17 +03:00
censor erase file content at a given revision
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
churn command to display statistics about repository history
clonebundles: rewrite documentation There are a lot of considerations server operators need to know before deploying clone bundles. They should be documented. So I rewrote the extension docs to contain this information.
2015-10-17 21:23:54 +03:00
clonebundles advertise pre-generated bundles to seed clones
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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
gpg commands to sign and verify changesets
hgk browse the repository in a graphical way
help: add hgsql to help Summary: It was missed by whoever was adding hsql to this repo Test Plan: tests are passing now Reviewers: rmcelroy, ikostia, #mercurial Reviewed By: rmcelroy Differential Revision: https://phabricator.intern.facebook.com/D6674927 Signature: 6674927:1515432467:705219df9ef28e218923aafe720c8f908f16be67
2018-01-08 21:32:01 +03:00
hgsql (no help text available)
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
highlight syntax highlighting for hgweb (requires Pygments)
histedit interactive history editing
keyword expand keywords in tracked files
largefiles track large binary files
lz4revlog: add lz4revlog to test-help
2018-01-03 21:13:17 +03:00
lz4revlog store revlog deltas using lz4 compression
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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
remotenames: accept test failures
2018-01-03 17:28:53 +03:00
remotenames
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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
spelling: fixes from proofreading of spell checker issues
2014-04-18 00:47:38 +04:00
strip strip changesets and their descendants from history
test-help.t: add test for 'hg help extensions' This demonstrates the defect that deprecated extensions show up in the output. A followup patch will fix this defect.
2014-02-28 00:37:04 +04:00
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
test-help: verify that extension keywords appear in help templates fixed by 7d713b4fcf9b
2015-09-24 20:58:18 +03:00
Verify that extension keywords appear in help templates
$ hg help --config extensions.transplant= templating|grep transplant > /dev/null
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test short command list with verbose option
$ hg -v help shortlist
help: drop with_version If --version is specified, we print the version and exit (as documented).
2011-08-05 00:08:41 +04:00
Mercurial Distributed SCM
tests: unify test-help
2010-08-27 18:25:47 +04:00
basic commands:
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
global options ([+] can be repeated):
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
-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
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-q --quiet suppress output
-v --verbose enable additional output
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
--color TYPE when to colorize (boolean, always, auto, never, or
color: update main documentation Now that the feature no longer lives in the extension, we document it in the help of the core config. This include the new 'ui.color' option introduced in the previous changesets. As a result the color extensions can now be deprecated. This is a documentation patch only; color is still disabled by default.
2017-02-21 22:04:55 +03:00
debug)
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--config CONFIG [+] set/override config option (use 'section.name=value')
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--debug enable debugging output
--debugger start debugger
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--encoding ENCODE set the charset encoding (default: ascii)
--encodingmode MODE set the charset encoding mode (default: strict)
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--traceback always print a traceback on exception
--time time how long the command takes
--profile print command execution profile
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--version output version information and exit
-h --help display help and exit
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--hidden consider hidden changesets
pager: move more behavior into core This moves the global flag and the --pager=yes logic into core. Only functionality change is that users now always get a --pager flag and can enable the pager via the flag without the extension active. Moving the flag into core exposes a defect in the ro localization, which will have to be corrected later.
2017-02-16 01:47:57 +03:00
--pager TYPE when to paginate (boolean, always, auto, or never)
(default: auto)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help' for the full list of commands)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ 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
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
add before that, see 'hg forget'.
tests: unify test-help
2010-08-27 18:25:47 +04:00
add: mention .hgignore in help
2015-12-17 17:53:40 +03:00
If no names are given, add all files to the repository (except files
matching ".hgignore").
tests: unify test-help
2010-08-27 18:25:47 +04:00
Returns 0 if all files are successfully added.
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
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
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
add before that, see 'hg forget'.
tests: unify test-help
2010-08-27 18:25:47 +04:00
add: mention .hgignore in help
2015-12-17 17:53:40 +03:00
If no names are given, add all files to the repository (except files
matching ".hgignore").
tests: unify test-help
2010-08-27 18:25:47 +04:00
commands: add example for 'hg add'
2015-11-25 20:10:31 +03:00
Examples:
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
- New (unknown) files are added automatically by 'hg add':
commands: add example for 'hg add'
2015-11-25 20:10:31 +03:00
$ 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
tests: unify test-help
2010-08-27 18:25:47 +04:00
Returns 0 if all files are successfully added.
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
global options ([+] can be repeated):
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
-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
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-q --quiet suppress output
-v --verbose enable additional output
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
--color TYPE when to colorize (boolean, always, auto, never, or
color: update main documentation Now that the feature no longer lives in the extension, we document it in the help of the core config. This include the new 'ui.color' option introduced in the previous changesets. As a result the color extensions can now be deprecated. This is a documentation patch only; color is still disabled by default.
2017-02-21 22:04:55 +03:00
debug)
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--config CONFIG [+] set/override config option (use 'section.name=value')
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--debug enable debugging output
--debugger start debugger
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--encoding ENCODE set the charset encoding (default: ascii)
--encodingmode MODE set the charset encoding mode (default: strict)
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--traceback always print a traceback on exception
--time time how long the command takes
--profile print command execution profile
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--version output version information and exit
-h --help display help and exit
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--hidden consider hidden changesets
pager: move more behavior into core This moves the global flag and the --pager=yes logic into core. Only functionality change is that users now always get a --pager flag and can enable the pager via the flag without the extension active. Moving the flag into core exposes a defect in the ro localization, which will have to be corrected later.
2017-02-16 01:47:57 +03:00
--pager TYPE when to paginate (boolean, always, auto, or never)
(default: auto)
tests: unify test-help
2010-08-27 18:25:47 +04:00
ui: add new config option for help text width Before this patch, when printing help text using `hg help`, or `hg log -h`, the output will wrap at 78 chars even if the user has a bigger terminal width and there is no config option to change it, making the experience different from the commonly used `man` tool. This patch introduces a new config option `ui.textwidth`, which replaces the hardcoded number. It's set to 78 by default to maintain compatibility. When set to 0, `hg help` will behave more like `man`.
2016-05-04 20:18:24 +03:00
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)
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test help option with version option
$ hg add -h --version
tests: add glob matching for unified tests This adds a " (glob)" marker that works like a simpler version of (re): "*" is converted to ".*", and "?" is converted to ".". Both special characters can be escaped using "\", and the backslash itself can be escaped as well. Other glob-style syntax, like "**", "[chars]", or "[!chars]", isn't supported.
2010-09-23 01:06:02 +04:00
Mercurial Distributed SCM (version *) (glob)
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
(see https://mercurial-scm.org for more information)
tests: unify test-help
2010-08-27 18:25:47 +04:00
misc: update year in copyright lines This patch also makes some expected output lines in tests glob-ed for persistence of them. BTW, files below aren't yet changed in 2017, but this patch also updates copyright of them, because: - mercurial/help/hg.1.txt almost all of "man hg" output comes from online help of hg command, and is already changed in 2017 - mercurial/help/hgignore.5.txt - mercurial/help/hgrc.5 "copyright 2005-201X Matt Mackall" in them mentions about copyright of Mercurial itself
2017-02-11 20:23:33 +03:00
Copyright (C) 2005-* Matt Mackall and others (glob)
tests: unify test-help
2010-08-27 18:25:47 +04:00
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
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-S --subrepos recurse into subrepositories
-n --dry-run do not perform actions, just print output
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg add -h' to show more help)
tests: add exit codes to unified tests
2010-09-17 02:51:32 +04:00
[255]
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test ambiguous command help
$ hg help ad
list of commands:
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
add add the specified files on the next commit
addremove add all new files, delete all missing files
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help -v ad' to show built-in aliases and global options)
tests: unify test-help
2010-08-27 18:25:47 +04:00
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.
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more
help: add information about recovery from corruption to help of "verify" Before this patch, there is no information about what users should (or can) do for recovery from corruption of repositories. This patch adds URL of the Mercurial Wiki page explaining about recovery from corruption.
2012-10-03 20:24:05 +04:00
information about recovery from corruption of the repository.
tests: unify test-help
2010-08-27 18:25:47 +04:00
Returns 0 on success, 1 if errors are encountered.
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ 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.
Use note admonition
2010-09-22 18:23:55 +04:00
Note:
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
'hg diff' may generate unexpected results for merges, as it will
commands: the first word of each note should be capital or `hg`
2015-12-22 05:24:16 +03:00
default to comparing against the working directory's first parent
changeset if no revisions are specified.
tests: unify test-help
2010-08-27 18:25:47 +04:00
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,
diff: clarify comparison as first parent
2015-12-18 21:52:25 +03:00
the working directory files are compared to its first parent.
tests: unify test-help
2010-08-27 18:25:47 +04:00
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.
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
For more information, read 'hg help diffs'.
tests: unify test-help
2010-08-27 18:25:47 +04:00
Returns 0 on success.
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-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
diff: add --binary option for git mode diffs This patch adds --binary option to `hg diff` and `hg export` to allow more control about when binary diffs are displayed in Git mode as well as some tests to verify it behaves correctly (issue5510).
2017-04-06 01:31:08 +03:00
--binary generate binary diffs in git mode (default)
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--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
mdiff: add a --ignore-space-at-eol option Add an option that only ignores whitespaces at EOL. The name of the option is the same as Git. .. feature:: Added `--ignore-space-at-eol` diff option to ignore whitespace differences at line endings. Differential Revision: https://phab.mercurial-scm.org/D422
2017-08-30 04:20:50 +03:00
-Z --ignore-space-at-eol ignore changes in whitespace at EOL
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-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
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ 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.
Use more note admonitions in help texts
2010-09-23 18:31:38 +04:00
Note:
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
'hg status' may appear to disagree with diff if permissions have
commands: the first word of each note should be capital or `hg`
2015-12-22 05:24:16 +03:00
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.
tests: unify test-help
2010-08-27 18:25:47 +04:00
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
status: improve explanation of ' ' status a) it shows for states other than 'A' b) it only shows with --copies
2014-03-07 03:26:49 +04:00
= origin of the previous file (with --copies)
tests: unify test-help
2010-08-27 18:25:47 +04:00
Returns 0 on success.
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-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
help: use RST to format option lists
2011-09-21 22:00:48 +04:00
--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
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-S --subrepos recurse into subrepositories
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg -q help status
hg status [OPTION]... [FILE]...
show changed files in the working directory
$ hg help foo
help: suggest keyword search when no topic is found When `hg help foobar` fails, it now suggests using `hg help --keyword foobar` instead of printing a full page of basic commands. This should greatly increases discoverability of the `hg help --keyword` argument.
2014-04-17 03:55:40 +04:00
abort: no such help topic: foo
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(try 'hg help --keyword foo')
tests: add exit codes to unified tests
2010-09-17 02:51:32 +04:00
[255]
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ hg skjdfks
hg: unknown command 'skjdfks'
Mercurial Distributed SCM
basic commands:
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
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)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help' for the full list of commands or 'hg -v' for details)
tests: add exit codes to unified tests
2010-09-17 02:51:32 +04:00
[255]
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: add tests for typoed commands This includes one test showing how disabling a command with e.g. "extensions.rebase=!" results in the command not being suggested. We'll fix that next.
2017-07-07 10:12:44 +03:00
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'
dispatch: fix typo suggestion for disabled extension If the matching command lives in an in-tree extension (which is all we scan for), and the user has disabled that extension with "extensions.<name>=!", we were not finding it, because the path in _disabledextensions was the empty string. If the user had set "extensions.<name>=!<valid path>" it would work, so it seems like just a mistake that it didn't work.
2017-07-07 10:13:53 +03:00
'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)
tests: add tests for typoed commands This includes one test showing how disabling a command with e.g. "extensions.rebase=!" results in the command not being suggested. We'll fix that next.
2017-07-07 10:12:44 +03:00
[255]
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
dispatch: don't stack trace on commands like `hg .log` This used to stack trace because it raised a util.Abort which wasn't handled in this block. We now handle it. Additionally, we error out earlier instead of plodding on and showing the "log" entry of the plain `hg help` output.
2015-09-25 18:16:20 +03:00
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'
dispatch: report similar names consistently
2016-01-05 08:52:44 +03:00
(did you mean log?)
dispatch: don't stack trace on commands like `hg .log` This used to stack trace because it raised a util.Abort which wasn't handled in this block. We now handle it. Additionally, we error out earlier instead of plodding on and showing the "log" entry of the plain `hg help` output.
2015-09-25 18:16:20 +03:00
[255]
$ hg log.
hg: unknown command 'log.'
dispatch: report similar names consistently
2016-01-05 08:52:44 +03:00
(did you mean log?)
dispatch: don't stack trace on commands like `hg .log` This used to stack trace because it raised a util.Abort which wasn't handled in this block. We now handle it. Additionally, we error out earlier instead of plodding on and showing the "log" entry of the plain `hg help` output.
2015-09-25 18:16:20 +03:00
[255]
$ hg pu.lh
hg: unknown command 'pu.lh'
(did you mean one of pull, push?)
[255]
tests: unify test-help
2010-08-27 18:25:47 +04:00
$ cat > helpext.py <<EOF
> import os
registrar: move cmdutil.command to registrar module (API) cmdutil.command wasn't a member of the registrar framework only for a historical reason. Let's make that happen. This patch keeps cmdutil.command as an alias for extension compatibility.
2016-01-09 17:07:20 +03:00
> from mercurial import commands, registrar
tests: unify test-help
2010-08-27 18:25:47 +04:00
>
tests: declare commands using decorator
2014-05-05 09:48:07 +04:00
> cmdtable = {}
registrar: move cmdutil.command to registrar module (API) cmdutil.command wasn't a member of the registrar framework only for a historical reason. Let's make that happen. This patch keeps cmdutil.command as an alias for extension compatibility.
2016-01-09 17:07:20 +03:00
> command = registrar.command(cmdtable)
tests: declare commands using decorator
2014-05-05 09:48:07 +04:00
>
tests: port test extension in test-help.t to python 3 The changes required herein suggest to me that we should probably accept ascii-safe unicode strings for command name, flag name, etc.
2017-05-28 22:42:05 +03:00
> @command(b'nohelp',
> [(b'', b'longdesc', 3, b'x'*90),
> (b'n', b'', None, b'normal desc'),
> (b'', b'newline', b'', b'line1\nline2')],
> b'hg nohelp',
tests: define norepo in command decorator
2014-05-05 09:07:45 +04:00
> norepo=True)
tests: port test extension in test-help.t to python 3 The changes required herein suggest to me that we should probably accept ascii-safe unicode strings for command name, flag name, etc.
2017-05-28 22:42:05 +03:00
> @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)')])
tests: unify test-help
2010-08-27 18:25:47 +04:00
> def nohelp(ui, *args, **kwargs):
> pass
>
help: report source of aliases
2016-04-08 21:35:49 +03:00
> def uisetup(ui):
tests: port test extension in test-help.t to python 3 The changes required herein suggest to me that we should probably accept ascii-safe unicode strings for command name, flag name, etc.
2017-05-28 22:42:05 +03:00
> ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
> ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
help: report source of aliases
2016-04-08 21:35:49 +03:00
>
tests: unify test-help
2010-08-27 18:25:47 +04:00
> EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
help: report source of aliases
2016-04-08 21:35:49 +03:00
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:
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--remote check for push and pull
help: report source of aliases
2016-04-08 21:35:49 +03:00
(some details hidden, use --verbose to show complete help)
$ hg help shellalias
hg shellalias
shell alias for:
echo hi
defined by: helpext
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test command with no help text
$ hg help nohelp
hg nohelp
(no help text available)
minirst: create valid output when table data contains a newline When table data contained a newline, the result of minirst.maketable did not look nice plus it was not recognised by minirst.format: == === ==== l1 1 one l2 2 2 22 l3 == === ==== This problem occurred when the description of options had a very long translation which was split by newlines. Do not bother a translator with this detail. The multiline translations for option descriptions have been fixed in 7a88a81d5d9e in it.po, de.po and ro.po. I manually did the same as this patch does, I removed the newlines. When a newline was in the description, this created unusable help output: $ hg help somecommand hg somecommand [option]... with somecommand, you can... options: == =================== ======================================================= =================================== --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -n --norm normal desc --newline VALUE line1 line2 == =================== =============== =========================================================================== now this looks much nicer: ... options: --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -n --norm normal desc --newline VALUE line1 line2
2014-02-19 20:32:21 +04:00
options:
--longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3)
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
-n -- normal desc
minirst: create valid output when table data contains a newline When table data contained a newline, the result of minirst.maketable did not look nice plus it was not recognised by minirst.format: == === ==== l1 1 one l2 2 2 22 l3 == === ==== This problem occurred when the description of options had a very long translation which was split by newlines. Do not bother a translator with this detail. The multiline translations for option descriptions have been fixed in 7a88a81d5d9e in it.po, de.po and ro.po. I manually did the same as this patch does, I removed the newlines. When a newline was in the description, this created unusable help output: $ hg help somecommand hg somecommand [option]... with somecommand, you can... options: == =================== ======================================================= =================================== --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -n --norm normal desc --newline VALUE line1 line2 == =================== =============== =========================================================================== now this looks much nicer: ... options: --longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -n --norm normal desc --newline VALUE line1 line2
2014-02-19 20:32:21 +04:00
--newline VALUE line1 line2
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: fix 'hg help -k' matching an extension without docs getattr is not needed, __doc__ always exists and defaults to None
2012-06-07 17:54:40 +04:00
$ hg help -k nohelp
Commands:
nohelp hg nohelp
Extension Commands:
nohelp (no help text available)
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test that default list of commands omits extension commands
$ hg help
Mercurial Distributed SCM
list of commands:
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
bookmarks: improve the bookmark help (issue4244)
2014-06-19 00:26:07 +04:00
bookmarks create a new bookmark or list existing bookmarks
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
branch set or show the current branch name
branches list repository named branches
commands: update help for "bundle" We now have a dedicated help topic to describe bundle specification strings. Let's update `hg bundle`'s documentation to reflect its existence. While I was hear, I also tweaked some wording which I felt was out of date and needed tweaking. Specifically, `hg bundle` no longer just deals with "changegroup" data: it can also generate files that have non-changegroup data.
2017-04-01 23:43:43 +03:00
bundle create a bundle file
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
config: move showconfig code and add config as primary alias Preparation for adding config --edit to launch an editor
2014-02-27 22:42:09 +04:00
config show combined config settings from all hgrc files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
files: add new command unifying locate and manifest functionality
2014-09-13 03:32:46 +04:00
files list tracked files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
forget forget the specified files on the next commit
graft copy changes from other branches onto the current branch
grep: rewrite help to better document current (confusing) behavior
2016-09-23 20:45:10 +03:00
grep search revision history for a pattern in specified files
heads: modernize documentation (issue3992) The old docs emphasized topological heads rather than branch heads and incorrectly defined branch heads as not having children rather than descendants.
2013-07-22 03:45:42 +04:00
heads show branch heads
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
help show help for a given topic or a help overview
commands: replace "working copy" with "working directory" in help/messages "working directory" is the standard term, we should use it consistently. But I didn't touch the hint, "run 'hg update' to get a working copy", because "get a working directory" sounds a bit odd.
2015-03-17 16:47:08 +03:00
identify identify the working directory or specified revision
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge merge another revision into working directory
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
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
commands: update help for "unbundle" Similar to the recent change to "bundle," this command no longer just deals with "changegroup" data.
2017-04-01 23:43:52 +03:00
unbundle apply one or more bundle files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
update update working directory (or switch revisions)
verify verify the integrity of the repository
version output version and copyright information
tests: unify test-help
2010-08-27 18:25:47 +04:00
enabled extensions:
minirst: simplify and standardize field list formatting The default width of field lists is changed from 12 to 14 to align minirst with the rst2html tool. Shrinking the width of the left column to fit the content is removed, to keep formatting simple and uniform.
2012-01-11 21:08:25 +04:00
helpext (no help text available)
tests: unify test-help
2010-08-27 18:25:47 +04:00
additional help topics:
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
bundlespec Bundle File Formats
color: update the help table We also need to reference the new topic in the great old help table.
2017-03-01 22:22:04 +03:00
color Colorizing Outputs
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
config Configuration Files
dates Date Formats
diffs Diff Formats
environment Environment Variables
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
extensions Using Additional Features
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
filesets Specifying File Sets
help: adding a topic on flags This is a short topic to explain how command-line flags can be specified. Some users have been confused by hg offerring different flag syntax than some other libraries, so it'd be nice to point them to this rather than explaining it every time. Differential Revision: https://phab.mercurial-scm.org/D1270
2017-10-31 06:35:30 +03:00
flags Command-line flags
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
glossary Glossary
help: consistently use title capitalization for help topics
2012-04-30 13:51:24 +04:00
hgignore Syntax for Mercurial Ignore Files
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
hgweb Configuring hgweb
help: add "internals" topic We introduce the "internals" help topic, which renders an index of available sub-topics. The sub-topics themselves are still not reachable via the help system.
2015-12-13 21:35:03 +03:00
internals Technical implementation topics
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
merge-tools Merge Tools
pager: move most help to a new help topic and deprecate extension
2017-02-07 08:07:53 +03:00
pager Pager Support
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
patterns File Name Patterns
help: add phases topic
2012-01-26 21:23:14 +04:00
phases Working with Phases
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
revisions Specifying Revisions
help: scripting help topic There are a lot of non-human consumers of Mercurial. And the challenges and considerations for machines consuming Mercurial is significantly different from what humans face. I think there are enough special considerations around how machines consume Mercurial that a dedicated help topic is warranted. I concede the audience for this topic is probably small compared to the general audience. However, lots of normal Mercurial users do things like create one-off shell scripts for common workflows that I think this is useful enough to be in the install (as opposed to, say, a wiki page - which most users will likely never find). This text is by no means perfect. But you have to start somewhere. I think I did cover the important parts, though.
2015-07-19 03:10:28 +03:00
scripting Using Mercurial from scripts and automation
help: fix column alignment in "hg help" output The output of "hg help" is changed to ensure that the column containing descriptions of commands, extensions, and other topics is correctly alignmened.
2012-01-11 21:14:55 +04:00
subrepos Subrepositories
templating Template Usage
urls URL Paths
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help -v' to show built-in aliases and global options)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: sort help topics to make the output more readable (issue2751)
2011-04-05 08:40:47 +04:00
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
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
commands: support consuming stream clone bundles For the same reasons that we don't produce stream clone bundles with `hg bundle`, we don't support consuming stream clone bundles with `hg unbundle`. We introduce a complementary debug command for applying stream clone bundles. This command is mostly to facilitate testing. Although it may be used to manually apply stream clone bundles until a more formal mechanism is (possibly) adopted.
2015-10-15 23:43:18 +03:00
debugapplystreamclonebundle
apply a stream clone bundle file
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugbuilddag
builds a repo with a given DAG from scratch in the current
empty repo
debugbundle lists the contents of a bundle
debug: add a debugcapabilities commands This new debugcommand prints the capabilities of any remote in a human friendly way. Improved bundle2 capabilities support will be introduced in the next changesets.
2017-10-30 19:08:16 +03:00
debugcapabilities
lists the capabilities of a remote peer
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugcheckstate
validate the correctness of the current dirstate
color: move 'debugcolor' into the 'debugcommands' modules This is the last bits we needed to move out of the extensions. 'hgext/color.py' now only contains logic to changes the default color behavior to 'auto'. However, more cleanups are on the way and we need to document the new config directly in core.
2017-02-21 20:41:37 +03:00
debugcolor show available color, effects or style
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugcommands
list all available commands and options
debugcomplete
returns the completion list associated with the given command
commands: support creating stream clone bundles Now that we have support for recognizing the streaming clone bundle type, add a debug command for creating them. I decided to create a new debug command instead of adding support to `hg bundle` because stream clone bundles are not exactly used the same way as normal bundle files and I don't want to commit to supporting them through the official `hg bundle` command forever. A debug command, however, can be changed without as much concern for backwards compatibility. As part of this, `hg bundle` will explicitly reject requests to produce stream bundles. This command will be required by server operators using stream clone bundles with the clone bundles feature.
2015-10-17 21:40:29 +03:00
debugcreatestreamclonebundle
create a stream clone bundle file
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
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
commands: add debugdeltachain command We have debug commands for displaying overall revlog statistics (debugrevlog) and for dumping a revlog index (debugindex). As part of investigating various aspects of revlog behavior and performance, I found it important to have an understanding of how revlog delta chains behave in practice. This patch implements a "debugdeltachain" command. For each revision in a revlog, it dumps information about the delta chain. Which delta chain it is part of, length of the delta chain, distance since base revision, info about base revision, size of the delta chain, etc. The generic formatting facility is used, which means we can templatize output and get machine readable output like JSON. This command has already uncovered some weird history in mozilla-central I didn't know about. So I think it's valuable.
2015-12-06 10:37:46 +03:00
debugdeltachain
dump information about delta chains in a revlog
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugdirstate
show the contents of the current dirstate
debugdiscovery
runs the changeset discovery protocol in isolation
mercurial: add debugextensions command (issue4676) Add debugextensions command to help users debug their extension problems. If there are no extensions command prints nothing, otherwise it prints names of extension modules. If quiet or verbose option is not specified it prints(after extensions name) last version of mercurial in which given module was tested for non internal modules or not tested with user mercurial version. If verbose is specified it prints following information for every extension: extension name, import source, testedwith and buglink information. Extensions are printed sorted by extension name.
2015-09-10 17:53:07 +03:00
debugextensions
show information about active extensions
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugfileset parse and apply a fileset specification
debugformat: add a 'debugformat' command The command displays basic data about all format variants registered for repo upgrades. This gives a quick way to peek into a repository format. The 'fm.write()' calls are very independent because more data will be added in later changeset. Having more separate call make the later patch clearer.
2017-12-07 18:19:46 +03:00
debugformat display format information about the current repository
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugfsinfo show information detected about current filesystem
debuggetbundle
retrieves a bundle from a repo
debugignore: find out if a file is being ignored Before this patch debugignore was just displaying the list of ignore patterns. This patch makes it support a list of filename as argument and tells the user if those given files are ignored or not.
2016-01-05 18:47:08 +03:00
debugignore display the combined ignore pattern and information about
ignored files
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
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
commands: add debuglocks to report/clear lock state
2014-09-27 01:44:11 +04:00
debuglocks show or modify state of locks
commands: add a new debug command to print merge state We're going to be extending the merge state very soon, and this will give us a way to test all that.
2015-10-02 23:00:47 +03:00
debugmergestate
print merge state
debugnamecomplete: rename from debuglabelcomplete Now that we have decided on the use of 'name' instead of 'label' we rename this function accordingly. The old method 'debuglabelcomplete' has been left as a deprecated command so that current scripts don't break.
2014-10-18 00:41:29 +04:00
debugnamecomplete
complete "names" - tags, open branch names, bookmark names
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugobsolete
create arbitrary obsolete marker
help: hide command line options marked as "advanced" Previously, we have keywords like "(DEPRECATED)" and "(EXPERIMENTAL)" to hide command line options in non-verbose help output. However, sometimes an option is neither deprecated nor experimental. It's well-tested and working, but just not designed to average users. This patch adds a keyword "(ADVANCED)" to fit in such use cases. Thanks rom1dep for the suggestion of the word "advanced".
2016-11-01 17:50:45 +03:00
debugoptADV (no help text available)
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugoptDEP (no help text available)
help: also hide options marked EXPERIMENTAL Similar to DEPRECATED, add a way to indicate that options are EXPERIMENTAL.
2015-04-28 01:12:41 +03:00
debugoptEXP (no help text available)
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugpathcomplete
complete part or all of a tracked path
debugcommands: add debugpickmergetool to examine which merge tool is chosen Before this patch, there is no convenient way to know which merge tool is chosen for each managed files without actual merging.
2017-05-12 21:37:50 +03:00
debugpickmergetool
examine which merge tool is chosen for specified file
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
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
repair: add functionality to rebuild fncache Currently, there is no way to recover from a missing or corrupt fncache file in place (a clone is required). For certain use cases such as servers and with large repositories, an in-place repair may be desirable. This patch adds functionality for in-place repair of the fncache. The `hg debugrebuildfncache` command is introduced. It ensures the fncache is up to date by reconstructing the fncache from all seen files encountered during a brute force traversal of the repository's entire history. The command will add missing entries and will prune excess ones. Currently, the command no-ops unless the repository has the fncache requirement. The command could later grow the ability to "upgrade" an existing repository to be fncache enabled, if desired. When testing this patch on a local clone of the Firefox repository, it removed a bunch of entries. Investigation revealed that removed entries belonged to empty (0 byte size) .i filelogs. The functionality for pruning fncache of stripped revlogs was introduced in 93ba76bfbe8a, so the presence of these entries likely predates this feature.
2015-06-22 19:59:48 +03:00
debugrebuildfncache
rebuild the fncache file
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugrename dump rename information
debugrevlog show data and statistics about a revlog
debugrevspec parse and apply a revision specification
debugsetparents
manually set the parents of the current working directory
debug: add a method to check the state of, and built an SSL cert chain This is only useful on Windows, and avoids the need to use Internet Explorer to build the certificate chain. I can see this being extended in the future to print information about the certificate(s) to help debug issues on any platform. Maybe even perform some of the python checks listed on the secure connections wiki page. But for now, all I need is 1) a command that can be invoked in a setup script to ensure the certificate is installed, and 2) a command that the user can run if/when a certificate changes in the future. It would have been nice to leverage the sslutil library to pick up host specific settings, but attempting to use sslutil.wrapsocket() failed the 'not sslsocket.cipher()' check in it and aborted. The output is a little more chatty than some commands, but I've seen the update take 10+ seconds, and this is only a debug command.
2017-03-30 07:27:46 +03:00
debugssl test a secure connection to a server
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugsub (no help text available)
debugsuccessorssets
show set of successors for revision
templater: add debugtemplate command This is useful for debugging template parsing. Several tests are ported to this command.
2016-02-13 19:06:12 +03:00
debugtemplate
parse and apply a template
caches: introduce a 'debugupdatecaches' command That command make sure caches are updated. This is based on 'localrepo.updatecaches' so when we move support for new cache in that function this command will benefit from it.
2017-05-02 22:35:06 +03:00
debugupdatecaches
warm all known caches in the repository
debugcommands: stub for debugupgraderepo command Currently, if Mercurial introduces a new repository/store feature or changes behavior of an existing feature, users must perform an `hg clone` to create a new repository with hopefully the correct/optimal settings. Unfortunately, even `hg clone` may not give the correct results. For example, if you do a local `hg clone`, you may get hardlinks to revlog files that inherit the old state. If you `hg clone` from a remote or `hg clone --pull`, changegroup application may bypass some optimization, such as converting to generaldelta. Optimizing a repository is harder than it seems and requires more than a simple `hg` command invocation. This commit starts the process of changing that. We introduce `hg debugupgraderepo`, a command that performs an in-place upgrade of a repository to use new, optimal features. The command is just a stub right now. Features will be added in subsequent commits. This commit does foreshadow some of the behavior of the new command, notably that it doesn't do anything by default and that it takes arguments that influence what actions it performs. These will be explained more in subsequent commits.
2016-11-25 03:24:09 +03:00
debugupgraderepo
upgrade a repository to use different features
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
debugwalk show how files match on given patterns
debugwireargs
(no help text available)
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help -v debug' to show built-in aliases and global options)
help: let 'hg help debug' show the list of secret debug commands The names of the debug commands are not easy to remember and they are not easy to find.
2014-03-15 19:14:04 +04:00
help: add "internals" topic We introduce the "internals" help topic, which renders an index of available sub-topics. The sub-topics themselves are still not reachable via the help system.
2015-12-13 21:35:03 +03:00
internals topic renders index of available sub-topics
$ hg help internals
Technical implementation topics
"""""""""""""""""""""""""""""""
help: explain how to access subtopics in internals
2017-04-20 03:04:22 +03:00
To access a subtopic, use "hg help internals.{subtopic-name}"
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
bundles Bundles
help: update help.internalstable for new censor docs
2017-03-11 01:37:39 +03:00
censor Censor
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
changegroups Changegroups
internals: update test-help.t for config registrar copy-edit
2017-11-01 23:34:22 +03:00
config Config Registrar
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
requirements Repository Requirements
revlogs Revision Logs
help: internals topic for wire protocol The Mercurial wire protocol is under-documented. This includes a lack of source docstrings and comments as well as pages on the official wiki. This patch adds the beginnings of "internals" documentation on the wire protocol. The documentation should have nearly complete coverage on the lower-level parts of the protocol, such as the different transport mechanims, how commands and arguments are sent, capabilities, and, of course, the commands themselves. As part of writing this documentation, I discovered a number of deficiencies in the protocol and bugs in the implementation. I've started sending patches for some of the issues. I hope to send a lot more. This patch starts with the scaffolding for a new internals page.
2016-08-23 05:46:39 +03:00
wireprotocol Wire Protocol
help: sort help topics to make the output more readable (issue2751)
2011-04-05 08:40:47 +04:00
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
sub-topics can be accessed
$ hg help internals.changegroups
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
Changegroups
""""""""""""
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Changegroups are representations of repository revlog data, specifically
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
the changelog data, root/flat manifest data, treemanifest data, and
filelogs.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
changegroups: add documentation for cg3
2015-12-18 17:57:35 +03:00
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
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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).
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Changegroups when not exchanging treemanifests consist of 3 logical
segments:
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
+---------------------------------+
| | | |
| changeset | manifest | filelogs |
| | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| | | |
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
+---------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
When exchanging treemanifests, there are 4 logical segments:
+-------------------------------------------------+
| | | | |
| changeset | root | treemanifests | filelogs |
| | manifest | | |
| | | | |
+-------------------------------------------------+
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
The principle building block of each segment is a *chunk*. A *chunk* is a
framed piece of data:
+---------------------------------------+
| | |
| length | data |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| (4 bytes) | (<length - 4> bytes) |
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
| | |
+---------------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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).
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
There is a special case chunk that has a value of 0 for the length
("0x00000000"). We call this an *empty chunk*.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Delta Groups
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
============
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
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 |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
| | | | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+------------------------------------------------------------------------+
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Each *chunk*'s data consists of the following:
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+---------------------------------------+
| | |
| delta header | delta data |
| (various by version) | (various) |
| | |
+---------------------------------------+
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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
help: spelling fixes
2017-05-04 05:07:47 +03:00
specified in the bundle/changegroup).
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
changegroups: add documentation for cg3
2015-12-18 17:57:35 +03:00
The *delta header* is different between versions "1", "2", and "3" of the
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
changegroup format.
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 1 (headerlen=80):
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
+------------------------------------------------------+
| | | | |
| node | p1 node | p2 node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | |
+------------------------------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 2 (headerlen=100):
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
+------------------------------------------------------------------+
| | | | | |
| node | p1 node | p2 node | base node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | | |
+------------------------------------------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 3 (headerlen=102):
changegroups: add documentation for cg3
2015-12-18 17:57:35 +03:00
+------------------------------------------------------------------------------+
| | | | | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| node | p1 node | p2 node | base node | link node | flags |
changegroups: add documentation for cg3
2015-12-18 17:57:35 +03:00
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
| | | | | | |
+------------------------------------------------------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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:
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
help: fix layout of pre-formatted text
2017-03-09 06:55:48 +03:00
+---------------------------------------------------------------+
| | | | |
| start offset | end offset | new length | content |
| (4 bytes) | (4 bytes) | (4 bytes) | (<new length> bytes) |
| | | | |
+---------------------------------------------------------------+
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Please note that the length field in the delta data does *not* include
itself.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
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.
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
In version 2 and up, the delta base node is encoded in the entry in the
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
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
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
=================
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
The *changeset segment* consists of a single *delta group* holding
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
changelog data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the *manifest segment*.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Manifest Segment
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
================
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
The *manifest segment* consists of a single *delta group* holding manifest
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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*.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Filelogs Segment
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
================
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
The *filelogs segment* consists of multiple sub-segments, each
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
corresponding to an individual file whose data is being described:
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+--------------------------------------------------+
| | | | | |
| filelog0 | filelog1 | filelog2 | ... | 0x0 |
| | | | | (4 bytes) |
| | | | | |
+--------------------------------------------------+
changegroups: add documentation for cg3
2015-12-18 17:57:35 +03:00
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
Each filelog sub-segment consists of the following:
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+------------------------------------------------------+
| | | |
| filename length | filename | delta group |
| (4 bytes) | (<length - 4> bytes) | (various) |
| | | |
+------------------------------------------------------+
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
That is, a *chunk* consisting of the filename (not terminated or padded)
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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.
help: support loading sub-topics If a sub-topic/section is requested and the main topic corresponds to a topic with sub-topics, we now look for and return content for a sub-topic if found. With this patch, `hg help internals.X` now works. hgweb does not yet render sub-topics, however.
2015-12-13 22:19:55 +03:00
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test list of commands with command with no help text
$ hg help helpext
helpext extension - no help text available
list of commands:
help: format command and option list help using RST This patch changes the function which generates help text about commands and options to use RST formatting. Tables describing options have been formatted using RST table markup for some time already, so their appearance does not change. Command lists, however, change appearance. To format non-verbose command lists, RST field list markup was chosen, because it resembles the old format: <http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists> In the old (hand-coded) format of non-verbose command lists, the left column is 12 characters wide. Our minirst implementation formats field lists with a left column 14 characters wide, so this patch changes the appearance of help output correspondingly: <http://markmail.org/message/krl4cxopsnii7s6z?q=mercurial+reinert+from:%22Olav+Reinert%22&page=2> The minirst markup most closely resembling the old verbose command lists is definition lists. But using it would cause a blank line to be inserted between each command definition, making the output excessively long, and no more useful than before. To avoid this, I chose to use field lists also for verbose command help, resulting in output like this example: 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 merge merge working directory with another revision phase set or show the current phase name pull pull changes from the specified source push push changes to the specified destination qdiff diff of the current patch and subsequent modifications qinit init a new queue repository (DEPRECATED) qnew create a new patch qpop pop the current patch off the stack qpush push the next patch onto the stack qrefresh update the current patch 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) This change is a move towards generating all help text as a list of strings marked up with RST.
2012-06-02 13:25:40 +04:00
nohelp (no help text available)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help -v helpext' to show built-in aliases and global options)
tests: unify test-help
2010-08-27 18:25:47 +04:00
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
help: hide command line options marked as "advanced" Previously, we have keywords like "(DEPRECATED)" and "(EXPERIMENTAL)" to hide command line options in non-verbose help output. However, sometimes an option is neither deprecated nor experimental. It's well-tested and working, but just not designed to average users. This patch adds a keyword "(ADVANCED)" to fit in such use cases. Thanks rom1dep for the suggestion of the word "advanced".
2016-11-01 17:50:45 +03:00
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)
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
$ hg help debugoptDEP
hg debugoptDEP
(no help text available)
options:
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
help: also hide options marked EXPERIMENTAL Similar to DEPRECATED, add a way to indicate that options are EXPERIMENTAL.
2015-04-28 01:12:41 +03:00
$ hg help debugoptEXP
hg debugoptEXP
(no help text available)
options:
(some details hidden, use --verbose to show complete help)
help: hide command line options marked as "advanced" Previously, we have keywords like "(DEPRECATED)" and "(EXPERIMENTAL)" to hide command line options in non-verbose help output. However, sometimes an option is neither deprecated nor experimental. It's well-tested and working, but just not designed to average users. This patch adds a keyword "(ADVANCED)" to fit in such use cases. Thanks rom1dep for the suggestion of the word "advanced".
2016-11-01 17:50:45 +03:00
test advanced, deprecated and experimental options are shown with -v
$ hg help -v debugoptADV | grep aopt
--aopt option is (ADVANCED)
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
$ hg help -v debugoptDEP | grep dopt
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--dopt option is (DEPRECATED)
help: also hide options marked EXPERIMENTAL Similar to DEPRECATED, add a way to indicate that options are EXPERIMENTAL.
2015-04-28 01:12:41 +03:00
$ hg help -v debugoptEXP | grep eopt
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
--eopt option is (EXPERIMENTAL)
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
tests: mark test in tests/test-help.t as contingent on gettext being available
2014-04-16 01:51:27 +04:00
#if gettext
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
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)
help: roll option list header into option formatter
2014-08-12 12:53:33 +04:00
options:
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
help: tweak --verbose command help hint We used to have two slightly different message which people wouldn't read... and then complain that they couldn't find the global options or examples. So we unify them into one message that's upfront that STUFF IS INTENTIONALLY HIDDEN and that looks more like our normal hint style.
2014-08-12 12:01:37 +04:00
(some details hidden, use --verbose to show complete help)
tests: mark test in tests/test-help.t as contingent on gettext being available
2014-04-16 01:51:27 +04:00
#endif
help: filter out deprecated options with untranslated descriptions When using a different language than English, deprecated options were only removed from the output of `hg help anycmd` when "DEPRECATED" in the options description was translated.
2014-02-17 10:39:53 +04:00
help: always show command help with -h (issue4240) Old behavior: hg help x hg x -h hg help -e x hg help -c x config topic topic (!) - cmd showconfig cmd topic (!) - cmd rebase cmd cmd ext cmd New behavior: hg help x hg x -h hg help -e x hg help -c x config topic cmd - cmd showconfig cmd cmd - cmd rebase cmd cmd ext cmd
2014-07-31 23:31:31 +04:00
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
tests: unify test-help
2010-08-27 18:25:47 +04:00
Test a help topic
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
$ 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.
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
Many date formats are valid. Here are some examples:
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
- "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
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
Lastly, there is Mercurial's internal format:
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
- "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
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).
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
The log command also accepts date ranges:
tests: unify test-help
2010-08-27 18:25:47 +04:00
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
- "<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
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
help: distinguish sections when multiple match (issue4802)
2015-08-31 02:03:38 +03:00
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".
minirst: handle edge in hunting for parents test for "hg help -c config" in help config ``section`` ----------- section text ``def1`` definition of def1 $ hg help scope.def1 should list this paragraph, but not section text below... section text ``def2`` definition of def2 $ hg help scope.def2 should list this paragraph, but not section text below... section text $ hg help scope.section should show everything from the first section text to this last line. ``section2`` ------------
2015-09-04 00:06:27 +03:00
Unrelated trailing paragraphs shouldn't be included
$ hg help config.extramsg | grep '^$'
commands: support hg help scripting.HGPLAIN keywords are lowercased within help/minirst...
2015-09-03 06:50:45 +03:00
Test capitalized section name
$ hg help scripting.HGPLAIN > /dev/null
minirst: don't treat top level item as children of last item (issue4803) test for "hg help -c config" in help config
2015-09-02 22:12:08 +03:00
Help subsection:
$ hg help config.charsets |grep "Email example:" > /dev/null
[1]
minirst: establish leveling for nested definitions
2015-09-10 17:48:20 +03:00
Show nested definitions
("profiling.type"[break]"ls"[break]"stat"[break])
$ hg help config.type | egrep '^$'|wc -l
\s*3 (re)
help: include section heading if section depth changes This makes it easier to distinguish between: "format" -------- "usestore" ... Enabled by default. and "progress.format" Format of the progress bar.
2016-01-01 19:59:13 +03:00
Separate sections from subsections
$ hg help config.format | egrep '^ ("|-)|^\s*$' | uniq
"format"
--------
"usegeneraldelta"
"dotencode"
"usefncache"
"usestore"
lz4revlog: add lz4revlog to test-help
2018-01-03 21:13:17 +03:00
"uselz4"
help: include section heading if section depth changes This makes it easier to distinguish between: "format" -------- "usestore" ... Enabled by default. and "progress.format" Format of the progress bar.
2016-01-01 19:59:13 +03:00
"profiling"
-----------
"format"
"progress"
----------
"format"
minirst: don't treat top level item as children of last item (issue4803) test for "hg help -c config" in help config
2015-09-02 22:12:08 +03:00
Last item in help config.*:
$ hg help config.`hg help config|grep '^ "'| \
> tail -1|sed 's![ "]*!!g'`| \
tests: favor single quotes for wrapping hg help ...
2016-09-21 02:49:20 +03:00
> grep 'hg help -c config' > /dev/null
minirst: don't treat top level item as children of last item (issue4803) test for "hg help -c config" in help config
2015-09-02 22:12:08 +03:00
[1]
note to use help -c for general hg help config:
tests: favor single quotes for wrapping hg help ...
2016-09-21 02:49:20 +03:00
$ hg help config |grep 'hg help -c config' > /dev/null
minirst: don't treat top level item as children of last item (issue4803) test for "hg help -c config" in help config
2015-09-02 22:12:08 +03:00
test-help: test a sample of 'templates' topic help
2011-03-12 14:46:31 +03:00
Test templating help
$ hg help templating | egrep '(desc|diffstat|firstline|nonempty) '
minirst: simplify and standardize field list formatting The default width of field lists is changed from 12 to 14 to align minirst with the rst2html tool. Shrinking the width of the left column to fit the content is removed, to keep formatting simple and uniform.
2012-01-11 21:08:25 +04:00
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.
test-help: test a sample of 'templates' topic help
2011-03-12 14:46:31 +03:00
help: hide deprecated filesets, revsets and template items if not verbose This allows us to hide {branches} template keyword in a better way. Currently it is achieved by copying keywords table and deleting 'branches' from it.
2015-09-26 06:17:44 +03:00
Test deprecated items
$ hg help -v templating | grep currentbookmark
currentbookmark
$ hg help templating | (grep currentbookmark || true)
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
Test help hooks
$ cat > helphook1.py <<EOF
> from mercurial import help
>
help: pass around ui to rewriter hooks (API) makeitemsdoc() will hide DEPRECATED items conditionally.
2015-09-26 06:11:46 +03:00
> def rewrite(ui, topic, doc):
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
> return doc + '\nhelphook1\n'
>
> def extsetup(ui):
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
> help.addtopichook('revisions', rewrite)
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
> EOF
$ cat > helphook2.py <<EOF
> from mercurial import help
>
help: pass around ui to rewriter hooks (API) makeitemsdoc() will hide DEPRECATED items conditionally.
2015-09-26 06:11:46 +03:00
> def rewrite(ui, topic, doc):
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
> return doc + '\nhelphook2\n'
>
> def extsetup(ui):
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
> help.addtopichook('revisions', rewrite)
help: add topic rewriting hooks They are useful when updating help topics dynamically from extensions.
2010-10-23 21:21:49 +04:00
> EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
$ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
$ hg help revsets | grep helphook
helphook1
helphook2
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
help: call filtercmd from topicmatch update test coverage to explicitly define when help -c should list debug/deprecated items.
2015-12-09 22:09:35 +03:00
help -c should only show debug --debug
help: fix help -c/help -e/help -k Before, hg help -c was the same as hg help, now it only shows commands. Before, hg help -e was the same as hg help, now it only shows extensions. Before, hg help -k crashed, now it shows all topics.
2015-12-09 08:56:54 +03:00
$ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
help: call filtercmd from topicmatch update test coverage to explicitly define when help -c should list debug/deprecated items.
2015-12-09 22:09:35 +03:00
[1]
help -c should only show deprecated for -v
help: fix help -c/help -e/help -k Before, hg help -c was the same as hg help, now it only shows commands. Before, hg help -e was the same as hg help, now it only shows extensions. Before, hg help -k crashed, now it shows all topics.
2015-12-09 08:56:54 +03:00
$ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
help: call filtercmd from topicmatch update test coverage to explicitly define when help -c should list debug/deprecated items.
2015-12-09 22:09:35 +03:00
[1]
help: add --system flag to get help for various platform(s)
2016-01-10 11:03:58 +03:00
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
help: fix help argument parsing and documentation support combining -c and -e previously -k was misdocumented: * the first line didn't mention it * the help half implied you could do help -k keyword topic with these changes, -k just changes the search method support -c and -e for -k searches
2015-09-11 03:22:37 +03:00
Test -e / -c / -k combinations
test-help: tighten grep patterns Help should output section headings, but no debug commands
2015-12-14 09:00:32 +03:00
$ hg help -c|egrep '^[A-Z].*:|^ debug'
help: fix help -c/help -e/help -k Before, hg help -c was the same as hg help, now it only shows commands. Before, hg help -e was the same as hg help, now it only shows extensions. Before, hg help -k crashed, now it shows all topics.
2015-12-09 08:56:54 +03:00
Commands:
test-help: tighten grep patterns Help should output section headings, but no debug commands
2015-12-14 09:00:32 +03:00
$ hg help -e|egrep '^[A-Z].*:|^ debug'
help: fix help -c/help -e/help -k Before, hg help -c was the same as hg help, now it only shows commands. Before, hg help -e was the same as hg help, now it only shows extensions. Before, hg help -k crashed, now it shows all topics.
2015-12-09 08:56:54 +03:00
Extensions:
help: filter extension commands
2015-12-14 08:29:55 +03:00
$ hg help -k|egrep '^[A-Z].*:|^ debug'
help: fix help -c/help -e/help -k Before, hg help -c was the same as hg help, now it only shows commands. Before, hg help -e was the same as hg help, now it only shows extensions. Before, hg help -k crashed, now it shows all topics.
2015-12-09 08:56:54 +03:00
Topics:
Commands:
Extensions:
Extension Commands:
test-help: don't use progress extension for the test of argument parsing The next patch will remove the progress extension completely, so we have to pick another extension. The schemes is picked arbitrary. This test was introduced at 57703c45ed60.
2015-11-27 17:10:48 +03:00
$ hg help -c schemes
abort: no such help topic: schemes
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(try 'hg help --keyword schemes')
help: fix help argument parsing and documentation support combining -c and -e previously -k was misdocumented: * the first line didn't mention it * the help half implied you could do help -k keyword topic with these changes, -k just changes the search method support -c and -e for -k searches
2015-09-11 03:22:37 +03:00
[255]
test-help: don't use progress extension for the test of argument parsing The next patch will remove the progress extension completely, so we have to pick another extension. The schemes is picked arbitrary. This test was introduced at 57703c45ed60.
2015-11-27 17:10:48 +03:00
$ hg help -e schemes |head -1
schemes extension - extend schemes with shortcuts to repository swarms
help: fix help argument parsing and documentation support combining -c and -e previously -k was misdocumented: * the first line didn't mention it * the help half implied you could do help -k keyword topic with these changes, -k just changes the search method support -c and -e for -k searches
2015-09-11 03:22:37 +03:00
$ 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
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(try 'hg help --keyword commit')
help: fix help argument parsing and documentation support combining -c and -e previously -k was misdocumented: * the first line didn't mention it * the help half implied you could do help -k keyword topic with these changes, -k just changes the search method support -c and -e for -k searches
2015-09-11 03:22:37 +03:00
[255]
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
Test keyword search help
help: use full name of extensions to look up them for keyword search Before this patch, "hg help -k KEYWORD" fails, if there is the extension of which name includes ".", because "extensions.load()" invoked from "help.topicmatch()" fails to look such extension up, even though it is already loaded in. "help.topicmatch()" invokes "extensions.load()" with the name gotten from "extensions.enabled()". The former expects full name of extension (= key in '[extensions]' section), but the latter returns names shortened by "split('.')[-1]". This difference causes failure of looking extension up. This patch adds "shortname" argument to "extensions.enabled()" to make it return shortened names only if it is True. "help.topicmatch()" turns it off to get full name of extensions. Then, this patch shortens full name of extensions by "split('.')[-1]" for showing them in the list of extensions. Shortening is also applied on names gotten from "extensions.disabled()" but harmless, because it returns only extensions directly under "hgext" and their names should not include ".".
2013-09-23 15:23:25 +04:00
$ cat > prefixedname.py <<EOF
> '''matched against word "clone"
> '''
> EOF
$ echo '[extensions]' >> $HGRCPATH
$ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
$ hg help -k clone
Topics:
config Configuration Files
extensions Using Additional Features
glossary Glossary
phases Working with Phases
help: use the first topic name from helptable, not the longest alias This makes the 'additional help topics' list consistent with the output from keyword search (for instance subrepo/subrepos). The sorting by longest name was introduced in 4cbe49492ad3. There might have been a good reason for it back then, but now it seems like a better idea to place the preferred name first in the list in helptable.
2012-08-01 16:59:15 +04:00
subrepos Subrepositories
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
urls URL Paths
Commands:
help: call filtercmd from topicmatch update test coverage to explicitly define when help -c should list debug/deprecated items.
2015-12-09 22:09:35 +03:00
bookmarks create a new bookmark or list existing bookmarks
clone make a copy of an existing repository
paths show aliases for remote repositories
update update working directory (or switch revisions)
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
Extensions:
exchange: make clone bundles non-experimental and enabled by default The clone bundles feature was introduced in Mercurial 3.6 behind an experimental and disabled by default flag. The feature has been enabled on hg.mozilla.org for a few months and has served many terabytes of clones. Users have been encouraged to use the feature and reception has been very positive (mainly due to faster clones as a result of connecting to a CDN). I have heard no feedback about changing the feature other than inquiries about when it will be enabled by default. So, I think the feature is ready to be enabled by default. This patch renames experimental.clonebundles to ui.clonebundles, documents the option, and enables it by default. References to the experimental state of clone bundles have been removed. The remaining config option docs in clonebundles.py have been removed because they are redudant with `hg help config`. There are some oddities with behavior of clone bundles. Because clones with clone bundles are effectively 2 `hg pull` operations, there may be 2 transactions. This could result in hooks running twice. If the subsequent pull is aborted, it could result in partial rollback and an incomplete clone. This behavior is a bit wonky and should probably be documented. If this patch is accepted, I'll send a follow-up to document it. I don't think this behavior should prevent the feature being enabled by default. Reworking the clone mechanism to support interrupted or multi-part clones feels like a major new feature and something that when implemented can change the hook and rollback semantics of clone bundles. Besides, partial clone is better than full rollback and hooks running on initial clone are likely rare, so I think the impact is minimal.
2016-01-08 21:58:04 +03:00
clonebundles advertise pre-generated bundles to seed clones
help: use full name of extensions to look up them for keyword search Before this patch, "hg help -k KEYWORD" fails, if there is the extension of which name includes ".", because "extensions.load()" invoked from "help.topicmatch()" fails to look such extension up, even though it is already loaded in. "help.topicmatch()" invokes "extensions.load()" with the name gotten from "extensions.enabled()". The former expects full name of extension (= key in '[extensions]' section), but the latter returns names shortened by "split('.')[-1]". This difference causes failure of looking extension up. This patch adds "shortname" argument to "extensions.enabled()" to make it return shortened names only if it is True. "help.topicmatch()" turns it off to get full name of extensions. Then, this patch shortens full name of extensions by "split('.')[-1]" for showing them in the list of extensions. Shortening is also applied on names gotten from "extensions.disabled()" but harmless, because it returns only extensions directly under "hgext" and their names should not include ".".
2013-09-23 15:23:25 +04:00
prefixedname matched against word "clone"
relink recreates hardlinks between repository clones
help: fix extension commands help in keyword search This patch fixes the synopsis shown for extension commands in keyword search results. A previous patch erroneously caused the extension synopsis to be shown instead. Test cases for keyword search are missing, so I added a one.
2012-06-07 03:42:50 +04:00
Extension Commands:
qclone clone main and patch repository at same time
help: suggest keyword search when no topic is found When `hg help foobar` fails, it now suggests using `hg help --keyword foobar` instead of printing a full page of basic commands. This should greatly increases discoverability of the `hg help --keyword` argument.
2014-04-17 03:55:40 +04:00
Test unfound topic
$ hg help nonexistingtopicthatwillneverexisteverever
abort: no such help topic: nonexistingtopicthatwillneverexisteverever
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
help: suggest keyword search when no topic is found When `hg help foobar` fails, it now suggests using `hg help --keyword foobar` instead of printing a full page of basic commands. This should greatly increases discoverability of the `hg help --keyword` argument.
2014-04-17 03:55:40 +04:00
[255]
help: provide a more helpful message when no keyword are matched Before this changeset, when no topic were matching the provided keyword ( in command such as `hg help --keyword babar`) the output was empty. This is confusing and unhelpful for new users seeking assistance in the help. We now display: $ hg help --keyword babar abort: no matches (try "hg help" for a list of topics) This send users in a new direction where they may find what they are looking for.
2014-04-17 04:01:03 +04:00
Test unfound keyword
$ hg help --keyword nonexistingwordthatwillneverexisteverever
abort: no matches
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(try 'hg help' for a list of topics)
help: provide a more helpful message when no keyword are matched Before this changeset, when no topic were matching the provided keyword ( in command such as `hg help --keyword babar`) the output was empty. This is confusing and unhelpful for new users seeking assistance in the help. We now display: $ hg help --keyword babar abort: no matches (try "hg help" for a list of topics) This send users in a new direction where they may find what they are looking for.
2014-04-17 04:01:03 +04:00
[255]
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
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,
test: fix typo in test-help.t
2014-12-18 23:53:55 +03:00
> if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
>
> This paragraph is never omitted, too (for extension)
> '''
tests: update test-help to pass our import checker
2017-08-22 22:51:30 +03:00
> from __future__ import absolute_import
> from mercurial import commands, help
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
> testtopic = """This paragraph is never omitted (for topic).
>
> .. container:: verbose
>
> This paragraph is omitted,
test: fix typo in test-help.t
2014-12-18 23:53:55 +03:00
> if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
>
> 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.",
help: pass around ui to doc loader (API) This is necessary to hide DEPRECATED items conditionally. Flagged as API change because it will break "hg help git|subversion".
2015-09-26 06:06:30 +03:00
> lambda ui: testtopic))
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
> 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)
help: normalize topic and extension verbose hints
2014-08-12 12:25:51 +04:00
(some details hidden, use --verbose to show complete help)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
no commands defined
$ hg help -v addverboseitems
addverboseitems extension - extension to test omit indicating.
This paragraph is never omitted (for extension)
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
This paragraph is omitted, if 'hg help' is invoked without "-v" (for
test: fix typo in test-help.t
2014-12-18 23:53:55 +03:00
extension)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
This paragraph is never omitted, too (for extension)
no commands defined
$ hg help topic-containing-verbose
This is the topic to test omit indicating.
help: use a full header for topic titles ...for prettier HTML!
2013-02-10 15:58:57 +04:00
""""""""""""""""""""""""""""""""""""""""""
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
This paragraph is never omitted (for topic).
This paragraph is never omitted, too (for topic)
help: normalize topic and extension verbose hints
2014-08-12 12:25:51 +04:00
(some details hidden, use --verbose to show complete help)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
$ hg help -v topic-containing-verbose
This is the topic to test omit indicating.
help: use a full header for topic titles ...for prettier HTML!
2013-02-10 15:58:57 +04:00
""""""""""""""""""""""""""""""""""""""""""
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
This paragraph is never omitted (for topic).
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
This paragraph is omitted, if 'hg help' is invoked without "-v" (for
test: fix typo in test-help.t
2014-12-18 23:53:55 +03:00
topic)
help: indicate help omitting if help document is not fully displayed Before this patch, there is no information about whether help document is fully displayed or not. So, some users seem to misunderstand "-v" for "hg help" just as "the option to show list of global options": experience on "hg help -v" for some commands not containing verbose containers may strengthen this misunderstanding. Such users have less opportunity for noticing omitted help document, and this may cause insufficient understanding about Mercurial. This patch indicates help omitting, if help document is not fully displayed. For command help, the message below is displayed at the end of help output, if help document is not fully displayed: use "hg -v help xxxx" to show more complete help and the global options and otherwise: use "hg -v help xxxx" to show the global options For topics and extensions help, the message below is displayed, only if help document is not fully displayed: use "hg help -v xxxx" to show more complete help This allows users to know whether there is any omitted information or not exactly, and can trigger "hg help -v" invocation. This patch causes formatting help document twice, to switch messages one for omitted help, and another for not omitted. This decreases performance of help document formatting, but it is not mainly focused at help command invocation, so this wouldn't become problem.
2012-10-18 05:31:15 +04:00
This paragraph is never omitted, too (for topic)
help: basic support for showing only specified topic sections For instance, 'hg help config.files' will show only the Files section.
2014-10-01 01:40:10 +04:00
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
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
help: basic support for showing only specified topic sections For instance, 'hg help config.files' will show only the Files section.
2014-10-01 01:40:10 +04:00
limited by the requirement for children to have at most two parents.
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
$ hg help hgrc.paths
"paths"
-------
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
Assigns symbolic names and behavior to repositories.
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
Options are symbolic names defining the URL or directory that is the
location of the repository. Example:
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
[paths]
my_server = https://example.com/my_repo
local_path = /home/me/repo
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
These symbolic names can be used from the command line. To pull from
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
"my_server": 'hg pull my_server'. To push to "local_path": 'hg push
local_path'.
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
Options containing colons (":") denote sub-options that can influence
behavior for that specific path. Example:
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
[paths]
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
my_server = https://example.com/my_path
my_server:pushurl = ssh://example.com/my_path
The following sub-options can be defined:
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
"pushurl"
The URL to use for push operations. If not defined, the location
defined by the path's main entry is used.
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
ui: path option to declare which revisions to push by default Now that we have a mechanism for declaring path sub-options, we can start to pile on features! Many power users have expressed frustration that bare `hg push` attempts to push all local revisions to the remote. This patch introduces the "pushrev" path sub-option to control which revisions are pushed when no "-r" argument is specified. The value of this sub-option is a revset, naturally. A future feature addition could potentially introduce a "pushnames" sub-options that declares the list of names (branches, bookmarks, topics, etc) to push by default. The entire "what to push by default" feature should probably be considered before this patch lands.
2016-06-26 17:59:02 +03:00
"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.
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
The following special named paths exist:
"default"
The URL or directory to use when no source or remote is specified.
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
'hg clone' will automatically define this path to the location the
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
repository was cloned from.
"default-push"
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
(deprecated) The URL or directory for the default 'hg push' location.
ui: support declaring path push urls as sub-options Power users often want to apply per-path configuration options. For example, they may want to declare an alternate URL for push operations or declare a revset of revisions to push when `hg push` is used (as opposed to attempting to push all revisions by default). This patch establishes the use of sub-options (config options with ":" in the name) to declare additional behavior for paths. New sub-options are declared by using the new ``@ui.pathsuboption`` decorator. This decorator serves multiple purposes: * Declaring which sub-options are registered * Declaring how a sub-option maps to an attribute on ``path`` instances (this is needed to `hg paths` can render sub-options and values properly) * Validation and normalization of config options to attribute values * Allows extensions to declare new sub-options without monkeypatching * Allows extensions to overwrite built-in behavior for sub-option handling As convenient as the new option registration decorator is, extensions (and even core functionality) may still need an additional hook point to perform finalization of path instances. For example, they may wish to validate that multiple options/attributes aren't conflicting with each other. This hook point could be added later, if needed. To prove this new functionality works, we implement the "pushurl" path sub-option. This option declares the URL that `hg push` should use by default. We require that "pushurl" is an actual URL. This requirement might be controversial and could be dropped if there is opposition. However, objectors should read the complicated code in ui.path.__init__ and commands.push for resolving non-URL values before making a judgement. We also don't allow #fragment in the URLs. I intend to introduce a ":pushrev" (or similar) option to define a revset to control which revisions are pushed when "-r <rev>" isn't passed into `hg push`. This is much more powerful than #fragment and I don't think #fragment is useful enough to continue supporting. The [paths] section of the "config" help page has been updated significantly. `hg paths` has been taught to display path sub-options. The docs mention that "default-push" is now deprecated. However, there are several references to it that need to be cleaned up. A large part of this is converting more consumers to the new paths API. This will happen naturally as more path sub-options are added and more and more components need to access them.
2015-12-06 08:11:04 +03:00
"default:pushurl" should be used instead.
help: show all nested subsections of a section with `hg help foo.section` Used to be that `hg help hgrc.paths` would show "paths" ------- Assigns symbolic names to repositories. The left side is the symbolic name, and the right gives the directory or URL that is the location of the repository. Default paths can be declared by setting the following entries. and stop there. Obviously the result seems better as shown in the attached test.
2014-10-06 15:35:53 +04:00
help: basic support for showing only specified topic sections For instance, 'hg help config.files' will show only the Files section.
2014-10-01 01:40:10 +04:00
$ hg help glossary.mcguffin
help: show section that couldn't be found For better error indication.
2017-02-05 12:57:19 +03:00
abort: help section not found: glossary.mcguffin
help: basic support for showing only specified topic sections For instance, 'hg help config.files' will show only the Files section.
2014-10-01 01:40:10 +04:00
[255]
help: don't crash on help for 'sections' with multiple '.'
2014-11-01 21:02:31 +03:00
$ hg help glossary.mc.guffin
help: show section that couldn't be found For better error indication.
2017-02-05 12:57:19 +03:00
abort: help section not found: glossary.mc.guffin
help: don't crash on help for 'sections' with multiple '.'
2014-11-01 21:02:31 +03:00
[255]
help: support 'hg help template.somekeyword' Previously the output was simply 'abort: help section not found'.
2015-07-05 06:11:32 +03:00
$ hg help template.files
files List of strings. All files modified, added, or removed by
this changeset.
templates: add built-in files() function We already support multiple primitive for listing files, which were affected by the current changeset. This patch adds files() which returns files of the current changeset matching a given pattern or fileset query via the "set:" prefix.
2016-09-23 11:15:05 +03:00
files(pattern)
All files of the current changeset matching the pattern. See
'hg help patterns'.
help: support 'hg help template.somekeyword' Previously the output was simply 'abort: help section not found'.
2015-07-05 06:11:32 +03:00
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
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().
tests: replace yet more calls to `python` with $PYTHON These are some simple cases. More to come in a future change. Reviewers: krbullock Reviewed By: krbullock Differential Revision: https://phab.mercurial-scm.org/D4
2017-07-05 19:10:11 +03:00
$ $PYTHON <<EOF
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> 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
> ------------------
>
tests: favor single quotes for wrapping hg help ...
2016-09-21 02:49:20 +03:00
> This should be hidden at 'hg help ambiguous' with section name.
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> '''
> """ % (escape(upper), escape(lower)))
> EOF
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = ./ambiguous.py
> EOF
tests: replace yet more calls to `python` with $PYTHON These are some simple cases. More to come in a future change. Reviewers: krbullock Reviewed By: krbullock Differential Revision: https://phab.mercurial-scm.org/D4
2017-07-05 19:10:11 +03:00
$ $PYTHON <<EOF | sh
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> upper = "\x8bL\x98^"
tests: clean up many print statements to be print functions instead Differential Revision: https://phab.mercurial-scm.org/D294
2017-06-15 21:22:25 +03:00
> print("hg --encoding cp932 help -e ambiguous.%s" % upper)
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> EOF
\x8bL\x98^ (esc)
----
Upper name should show only this message
tests: replace yet more calls to `python` with $PYTHON These are some simple cases. More to come in a future change. Reviewers: krbullock Reviewed By: krbullock Differential Revision: https://phab.mercurial-scm.org/D4
2017-07-05 19:10:11 +03:00
$ $PYTHON <<EOF | sh
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> lower = "\x8bl\x98^"
tests: clean up many print statements to be print functions instead Differential Revision: https://phab.mercurial-scm.org/D294
2017-06-15 21:22:25 +03:00
> print("hg --encoding cp932 help -e ambiguous.%s" % lower)
help: search section of help topic by translated section name correctly Before this patch, "hg help topic.section" might show unexpected section of help topic in some encoding. It applies str.lower() instead of encoding.lower(str) on translated message to search section case-insensitively, but some encoding uses 0x41(A) - 0x5a(Z) as the second or later byte of multi-byte character (for example, ja_JP.cp932), and str.lower() causes unexpected result. To search section of help topic by translated section name correctly, this patch replaces str.lower() by encoding.lower(str) for both query string (in commands.help()) and translated help text (in minirst.getsections()).
2016-05-13 01:19:59 +03:00
> EOF
\x8bl\x98^ (esc)
----
Lower name should show only this message
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = !
> EOF
help: show content for explicitly disabled extension (issue5228)
2016-09-01 23:06:42 +03:00
Show help content of disabled extensions
$ cat >> $HGRCPATH <<EOF
> [extensions]
> ambiguous = !./ambiguous.py
> EOF
$ hg help -e ambiguous
ambiguous extension - (no help text available)
help: use single quotes in use warning
2016-09-21 02:47:46 +03:00
(use 'hg help extensions' for information on enabling extensions)
help: show content for explicitly disabled extension (issue5228)
2016-09-01 23:06:42 +03:00
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
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.
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
backout' and in several extensions.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
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".
help: fix typo in hg merge documentation
2017-10-21 00:15:46 +03:00
This implies premerge. Therefore, files aren't dumped, if premerge runs
filemerge: add internal merge tool to dump files forcibly Internal merge tool :dump implies premerge. Therefore, files aren't dumped, if premerge runs successfully. This undocumented behavior might confuse users, if they want to always dump files. But just making :dump omit premerge might cause backward compatibility issue for existing automation. This patch adds new internal merge tool :forcedump, which works as same as :dump, but omits premerge always. Internal tools annotated with "nomerge" should merge "change and delete" correctly, but _forcedump() can't. Therefore, it is annotated with "mergeonly" to always omit premerge, even though it doesn't merge files actually. This patch also adds explanation about premerge to :dump, to clarify how :dump actually works. BTW, this patch specifies internal tools with "internal:" prefix in newly added test scenario in test-merge-tools.t, even though this prefix is already deprecated. This is only for similarity to other tests in test-merge-tools.t.
2017-05-12 21:31:42 +03:00
successfully. Use :forcedump to forcibly write files out.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":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.
filemerge: add internal merge tool to dump files forcibly Internal merge tool :dump implies premerge. Therefore, files aren't dumped, if premerge runs successfully. This undocumented behavior might confuse users, if they want to always dump files. But just making :dump omit premerge might cause backward compatibility issue for existing automation. This patch adds new internal merge tool :forcedump, which works as same as :dump, but omits premerge always. Internal tools annotated with "nomerge" should merge "change and delete" correctly, but _forcedump() can't. Therefore, it is annotated with "mergeonly" to always omit premerge, even though it doesn't merge files actually. This patch also adds explanation about premerge to :dump, to clarify how :dump actually works. BTW, this patch specifies internal tools with "internal:" prefix in newly added test scenario in test-merge-tools.t, even though this prefix is already deprecated. This is only for similarity to other tests in test-merge-tools.t.
2017-05-12 21:31:42 +03:00
":forcedump"
Creates three versions of the files as same as :dump, but omits
premerge.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":local"
filemerge: use revset notation for p1/p2 of local/other descriptions
2016-03-17 03:36:01 +03:00
Uses the local 'p1()' version of files as the merged version.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":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.
filemerge: add non-interactive :merge-local and :merge-other There are two non-interactive internal merge tools, :other and :local, but they don't really merge, they just pick all changes from the local or other version of the file. In some situations, it is known that we want a merge and also know that all merge conflicts should be resolved in one direction. Although external merge tools can do this, sometimes it can be convenient to do so from within hg, without invoking a merge tool. These new :merge-local and :merge-other tools can do just that.
2015-09-10 16:41:11 +03:00
":merge-local"
Like :merge, but resolve all conflicts non-interactively in favor of the
filemerge: use revset notation for p1/p2 of local/other descriptions
2016-03-17 03:36:01 +03:00
local 'p1()' changes.
filemerge: add non-interactive :merge-local and :merge-other There are two non-interactive internal merge tools, :other and :local, but they don't really merge, they just pick all changes from the local or other version of the file. In some situations, it is known that we want a merge and also know that all merge conflicts should be resolved in one direction. Although external merge tools can do this, sometimes it can be convenient to do so from within hg, without invoking a merge tool. These new :merge-local and :merge-other tools can do just that.
2015-09-10 16:41:11 +03:00
":merge-other"
Like :merge, but resolve all conflicts non-interactively in favor of the
filemerge: use revset notation for p1/p2 of local/other descriptions
2016-03-17 03:36:01 +03:00
other 'p2()' changes.
filemerge: add non-interactive :merge-local and :merge-other There are two non-interactive internal merge tools, :other and :local, but they don't really merge, they just pick all changes from the local or other version of the file. In some situations, it is known that we want a merge and also know that all merge conflicts should be resolved in one direction. Although external merge tools can do this, sometimes it can be convenient to do so from within hg, without invoking a merge tool. These new :merge-local and :merge-other tools can do just that.
2015-09-10 16:41:11 +03:00
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":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"
filemerge: use revset notation for p1/p2 of local/other descriptions
2016-03-17 03:36:01 +03:00
Uses the other 'p2()' version of files as the merged version.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":prompt"
filemerge: use revset notation for p1/p2 of local/other descriptions
2016-03-17 03:36:01 +03:00
Asks the user which of the local 'p1()' or the other 'p2()' version to
keep as the merged version.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
":tagmerge"
Uses the internal tag merge algorithm (experimental).
filemerge: add 'union' merge to internal merge tool 'union merge' is a merge strategy which adds both left and right hand side of a conflict region. Git implements this merge strategy which is very practical to have for merging e.g. the Changelog file.
2015-08-16 11:19:00 +03:00
":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.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
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.
help: describe about choice of :prompt as a fallback merge tool explicitly "merge-tools" help topic has described that the merge of the file fails if no tool is found to merge binary or symlink, since 9da9bced2226 (or Mercurial 1.7), which based on (already removed) MergeProgram wiki page. But even at that revision, and of course now, merge of the file doesn't fail automatically for binary/symlink. ":prompt" (or equivalent logic) is used, if there is no appropriate tool configuration for binary/symlink.
2017-05-05 20:33:00 +03:00
8. Otherwise, ":prompt" is used.
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
Note:
After selecting a merge program, Mercurial will by default attempt to
merge the files using a simple merge algorithm first. Only if it
help: minor copy editing for grammar
2017-11-01 06:09:29 +03:00
doesn't succeed because of conflicting changes will Mercurial actually
test-help: add test to demonstrate that 'hg help merge-tools' is sane
2015-02-10 18:57:58 +03:00
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.
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
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"
tests: make zstd-related output optional Caught by the buildbot with --pure, fix suggested by indygreg.
2017-04-04 02:45:09 +03:00
better compression than "gzip". It also frequently yields better (?)
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
doc: add the tool to check section marks in help documents This patch adds "doc/check-seclevel.py" which checks below in help documents: - whether unknown or unavailable section marks are used or not - whether appropriate section mark is used at sub-sectioning It should be invoked in "doc" directory. It checks all help documents of Mercurial (topics, commands, extensions), if no file is specified by --file option. With --file option, it checks contents of the specified file as help document, for self testing purpose: -t/-c/-e/-C are used to specify what kind of help document contents of the specified file is. This checking is related to changeset 8d980034517b.
2012-08-13 16:25:48 +04:00
Test usage of section marks in help documents
$ cd "$TESTDIR"/../doc
cleanup: use $PYTHON to run python in many more tests Spotted one of these, then wrote a check-code rule that caught them all. It will be the next change.
2017-06-20 16:45:02 +03:00
$ $PYTHON check-seclevel.py
hgweb help: add tests
2013-03-01 22:42:42 +04:00
$ 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
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help"
hgweb help: add tests
2013-03-01 22:42:42 +04:00
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">
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
<a href="https://mercurial-scm.org/">
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<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>
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<form class="search" action="/log">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
paper: edit search hint to include new feature description
2013-09-06 13:30:57 +04:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</form>
<table class="bigtable">
hgweb: make anchor name actually match its href on help index page
2016-09-26 11:12:40 +03:00
<tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
help: document bundle specifications I softly formalized the concept of a "bundle specification" a while ago when I was working on clone bundles and stream clone bundles and wanted a more robust way to define what exactly is in a bundle file. The concept has existed for a while. Since it is part of the clone bundles feature and exposed to the user via the "-t" argument to `hg bundle`, it is something we need to support for the long haul. After the 4.1 release, I heard a few people comment that they didn't realize you could generate zstd bundles with `hg bundle`. I'm partially to blame for not documenting it in bundle's docstring. Additionally, I added a hacky, experimental feature for controlling the compression level of bundles in 054e64c4d837. As the commit message says, I went with a quick and dirty solution out of time constraints. Furthermore, I wanted to eventually store this configuration in the "bundlespec" so it could be made more flexible. Given: a) bundlespecs are here to stay b) we don't have great documentation over what they are, despite being a user-facing feature c) the list of available compression engines and their behavior isn't exposed d) we need an extensible place to modify behavior of compression engines I want to move forward with formalizing bundlespecs as a user-facing feature. This commit does that by introducing a "bundlespec" help page. Leaning on the just-added compression engine documentation and API, the topic also conveniently lists available compression engines and details about them. This makes features like zstd bundle compression more discoverable. e.g. you can now `hg help -k zstd` and it lists the "bundlespec" topic.
2017-04-01 23:42:06 +03:00
<tr><td>
<a href="/help/bundlespec">
bundlespec
</a>
</td><td>
Bundle File Formats
</td></tr>
color: update the help table We also need to reference the new topic in the great old help table.
2017-03-01 22:22:04 +03:00
<tr><td>
<a href="/help/color">
color
</a>
</td><td>
Colorizing Outputs
</td></tr>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<tr><td>
<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>
help: adding a topic on flags This is a short topic to explain how command-line flags can be specified. Some users have been confused by hg offerring different flag syntax than some other libraries, so it'd be nice to point them to this rather than explaining it every time. Differential Revision: https://phab.mercurial-scm.org/D1270
2017-10-31 06:35:30 +03:00
<a href="/help/flags">
flags
</a>
</td><td>
Command-line flags
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
help: add "internals" topic We introduce the "internals" help topic, which renders an index of available sub-topics. The sub-topics themselves are still not reachable via the help system.
2015-12-13 21:35:03 +03:00
<a href="/help/internals">
internals
</a>
</td><td>
Technical implementation topics
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<a href="/help/merge-tools">
merge-tools
</a>
</td><td>
Merge Tools
</td></tr>
<tr><td>
pager: move most help to a new help topic and deprecate extension
2017-02-07 08:07:53 +03:00
<a href="/help/pager">
pager
</a>
</td><td>
Pager Support
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
help: merge revsets.txt into revisions.txt Selecting single and multiple revisions is closely related, so let's put it in one place, so users can easily find it. We actually did not even point to "hg help revsets" from "hg help revisions", but now that they're on a single page, that won't be necessary.
2017-01-11 22:37:38 +03:00
Specifying Revisions
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</td></tr>
<tr><td>
help: scripting help topic There are a lot of non-human consumers of Mercurial. And the challenges and considerations for machines consuming Mercurial is significantly different from what humans face. I think there are enough special considerations around how machines consume Mercurial that a dedicated help topic is warranted. I concede the audience for this topic is probably small compared to the general audience. However, lots of normal Mercurial users do things like create one-off shell scripts for common workflows that I think this is useful enough to be in the install (as opposed to, say, a wiki page - which most users will likely never find). This text is by no means perfect. But you have to start somewhere. I think I did cover the important parts, though.
2015-07-19 03:10:28 +03:00
<a href="/help/scripting">
scripting
</a>
</td><td>
Using Mercurial from scripts and automation
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
templates: make earlycommands and othercommands optional We now have sub-topics in the help system. The "helptopics" template serves as a mechanism for displaying an index of help topics. Previously, it was only used to show the top-level list of help topics, which includes special groupings of topics. In the near future, we'll adapt "helptopics" for showing the index of sub-topics. In this patch, we optionally render {earlycommands} and {othercommands} since they aren't present on sub-topics.
2015-12-31 03:12:59 +03:00
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
merge: be precise about what merged into what in short desc
2014-11-26 17:22:09 +03:00
merge another revision into working directory
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
templates: make earlycommands and othercommands optional We now have sub-topics in the help system. The "helptopics" template serves as a mechanism for displaying an index of help topics. Previously, it was only used to show the top-level list of help topics, which includes special groupings of topics. In the near future, we'll adapt "helptopics" for showing the index of sub-topics. In this patch, we optionally render {earlycommands} and {othercommands} since they aren't present on sub-topics.
2015-12-31 03:12:59 +03:00
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
bookmarks: improve the bookmark help (issue4244)
2014-06-19 00:26:07 +04:00
create a new bookmark or list existing bookmarks
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</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>
commands: update help for "bundle" We now have a dedicated help topic to describe bundle specification strings. Let's update `hg bundle`'s documentation to reflect its existence. While I was hear, I also tweaked some wording which I felt was out of date and needed tweaking. Specifically, `hg bundle` no longer just deals with "changegroup" data: it can also generate files that have non-changegroup data.
2017-04-01 23:43:43 +03:00
create a bundle file
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</td></tr>
<tr><td>
<a href="/help/cat">
cat
</a>
</td><td>
output the current or given revision of files
</td></tr>
<tr><td>
config: move showconfig code and add config as primary alias Preparation for adding config --edit to launch an editor
2014-02-27 22:42:09 +04:00
<a href="/help/config">
config
</a>
</td><td>
show combined config settings from all hgrc files
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<a href="/help/copy">
copy
</a>
</td><td>
mark files as copied for the next commit
</td></tr>
<tr><td>
files: add new command unifying locate and manifest functionality
2014-09-13 03:32:46 +04:00
<a href="/help/files">
files
</a>
</td><td>
list tracked files
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
grep: rewrite help to better document current (confusing) behavior
2016-09-23 20:45:10 +03:00
search revision history for a pattern in specified files
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</td></tr>
<tr><td>
<a href="/help/heads">
heads
</a>
</td><td>
heads: modernize documentation (issue3992) The old docs emphasized topological heads rather than branch heads and incorrectly defined branch heads as not having children rather than descendants.
2013-07-22 03:45:42 +04:00
show branch heads
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</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>
help: report source of aliases
2016-04-08 21:35:49 +03:00
<a href="/help/hgalias">
hgalias
</a>
</td><td>
summarize working directory state
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<a href="/help/identify">
identify
</a>
</td><td>
commands: replace "working copy" with "working directory" in help/messages "working directory" is the standard term, we should use it consistently. But I didn't touch the hint, "run 'hg update' to get a working copy", because "get a working directory" sounds a bit odd.
2015-03-17 16:47:08 +03:00
identify the working directory or specified revision
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</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>
help: report source of aliases
2016-04-08 21:35:49 +03:00
<a href="/help/shellalias">
shellalias
</a>
</td><td>
(no help text available)
</td></tr>
<tr><td>
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
<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>
commands: update help for "unbundle" Similar to the recent change to "bundle," this command no longer just deals with "changegroup" data.
2017-04-01 23:43:52 +03:00
apply one or more bundle files
hgweb help: split up long lines (in generated output)
2013-02-10 01:51:21 +04:00
</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>
templates: make earlycommands and othercommands optional We now have sub-topics in the help system. The "helptopics" template serves as a mechanism for displaying an index of help topics. Previously, it was only used to show the top-level list of help topics, which includes special groupings of topics. In the near future, we'll adapt "helptopics" for showing the index of sub-topics. In this patch, we optionally render {earlycommands} and {othercommands} since they aren't present on sub-topics.
2015-12-31 03:12:59 +03:00
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</table>
</div>
</div>
</body>
</html>
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help/add"
hgweb help: add tests
2013-03-01 22:42:42 +04:00
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">
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
<a href="https://mercurial-scm.org/">
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<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">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
paper: edit search hint to include new feature description
2013-09-06 13:30:57 +04:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</form>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<div id="doc">
<p>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
hg add [OPTION]... [FILE]...
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
add the specified files on the next commit
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</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
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
undo an add before that, see 'hg forget'.
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
add: mention .hgignore in help
2015-12-17 17:53:40 +03:00
If no names are given, add all files to the repository (except
files matching &quot;.hgignore&quot;).
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
commands: add example for 'hg add'
2015-11-25 20:10:31 +03:00
Examples:
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
</p>
commands: add example for 'hg add'
2015-11-25 20:10:31 +03:00
<ul>
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
<li> New (unknown) files are added automatically by 'hg add':
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
<pre>
\$ ls (re)
foo.c
\$ hg status (re)
? foo.c
\$ hg add (re)
adding foo.c
\$ hg status (re)
A foo.c
</pre>
commands: add example for 'hg add'
2015-11-25 20:10:31 +03:00
<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>
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
<p>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
Returns 0 if all files are successfully added.
</p>
<p>
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<table>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--subrepos</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>recurse into subrepositories</td></tr>
<tr><td>-n</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--dry-run</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>do not perform actions, just print output</td></tr>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</table>
<p>
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
global options ([+] can be repeated):
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<table>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--quiet</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>suppress output</td></tr>
<tr><td>-v</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--verbose</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>enable additional output</td></tr>
<tr><td></td>
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
<td>--color TYPE</td>
color: update main documentation Now that the feature no longer lives in the extension, we document it in the help of the core config. This include the new 'ui.color' option introduced in the previous changesets. As a result the color extensions can now be deprecated. This is a documentation patch only; color is still disabled by default.
2017-02-21 22:04:55 +03:00
<td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
<tr><td></td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>--config CONFIG [+]</td>
<td>set/override config option (use 'section.name=value')</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--debug</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>enable debugging output</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--debugger</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--traceback</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>always print a traceback on exception</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--time</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>time how long the command takes</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--profile</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--hidden</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>consider hidden changesets</td></tr>
pager: move more behavior into core This moves the global flag and the --pager=yes logic into core. Only functionality change is that users now always get a --pager flag and can enable the pager via the flag without the extension active. Moving the flag into core exposes a defect in the ro localization, which will have to be corrected later.
2017-02-16 01:47:57 +03:00
<tr><td></td>
<td>--pager TYPE</td>
<td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</table>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</div>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</div>
</div>
</body>
</html>
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
hgweb help: add tests
2013-03-01 22:42:42 +04:00
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">
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
<a href="https://mercurial-scm.org/">
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<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">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
paper: edit search hint to include new feature description
2013-09-06 13:30:57 +04:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</form>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<div id="doc">
<p>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
hg remove [OPTION]... FILE...
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
aliases: rm
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
remove the specified files on the next commit
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</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.
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
To undo a remove before that, see 'hg revert'. To undo added
files, see 'hg forget'.
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
-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 [!]
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
(as reported by 'hg status'). The actions are Warn, Remove
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
(from branch) and Delete (from disk):
</p>
<table>
doc: put text into header of 1st column in table to generate page correctly >From the table without header text of 1st column, docutils generates the table with fully empty header row.
2013-10-24 20:14:18 +04:00
<tr><td>opt/state</td>
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
<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>
remove: quote --force in never deletes note Split Note into a note container
2015-12-22 09:02:01 +03:00
<b>Note:</b>
</p>
<p>
minirst: change hgrole to use single quotes We decided to reserve double quotes for arguments to hg because cmd does not like single quotes, so switch the outer quotes to single
2016-01-12 09:03:36 +03:00
'hg remove' never deletes files in Added [A] state from the
remove: quote --force in never deletes note Split Note into a note container
2015-12-22 09:02:01 +03:00
working directory, not even if &quot;--force&quot; is specified.
hgweb: make help verbose again (issue3899) Due to regression introduced in 5fc7d589c700, help in hgweb was rendered in non-verbose form (issue3899)
2013-04-22 12:27:56 +04:00
</p>
<p>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
Returns 0 on success, 1 if any warnings encountered.
</p>
<p>
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
options ([+] can be repeated):
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<table>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<tr><td>-A</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--after</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>record delete for missing files</td></tr>
<tr><td>-f</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--force</td>
remove: fix --force option help description (issue5177) Before this commit --force option help description stated that file was removed and deleted even if file was added or modified which is not true. Force option removes added file only from dirstate, it doesn't delete it from the filesystem.
2016-04-13 10:56:51 +03:00
<td>forget added files, delete modified files</td></tr>
remove: recurse into subrepositories with --subrepos/-S flag Like 'forget', git and svn subrepos are currently not supported. Unfortunately the name 'remove' is already used in the subrepo classes, so we break the convention of naming the subrepo function after the command.
2014-11-16 05:36:19 +03:00
<tr><td>-S</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--subrepos</td>
remove: recurse into subrepositories with --subrepos/-S flag Like 'forget', git and svn subrepos are currently not supported. Unfortunately the name 'remove' is already used in the subrepo classes, so we break the convention of naming the subrepo function after the command.
2014-11-16 05:36:19 +03:00
<td>recurse into subrepositories</td></tr>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</table>
<p>
help: fold repeatable option message into option table header This will hopefully conserve some limited user attention.
2014-08-12 13:00:42 +04:00
global options ([+] can be repeated):
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<table>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--quiet</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>suppress output</td></tr>
<tr><td>-v</td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--verbose</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>enable additional output</td></tr>
<tr><td></td>
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
<td>--color TYPE</td>
color: update main documentation Now that the feature no longer lives in the extension, we document it in the help of the core config. This include the new 'ui.color' option introduced in the previous changesets. As a result the color extensions can now be deprecated. This is a documentation patch only; color is still disabled by default.
2017-02-21 22:04:55 +03:00
<td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
color: add the definition of '--color' in core If we want to be able to move the initialisation in core, we need core to be aware of that '--color' flag at all time. So we now have the definition in core. That flag is currently unprocessed without the extensions (will be fixed soon). In addition the default value for this flag in core is 'never'. Enabling the extensions change that default value to 'auto'.
2017-02-21 20:09:21 +03:00
<tr><td></td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>--config CONFIG [+]</td>
<td>set/override config option (use 'section.name=value')</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--debug</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>enable debugging output</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--debugger</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--traceback</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>always print a traceback on exception</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--time</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>time how long the command takes</td></tr>
<tr><td></td>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--profile</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<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>
help: backout 6f89f03ad369 (mark boolean flags with [no-] in help) for now The ability to negate any boolean flags itself is great, but I think we are not ready to expose the help side of it yet. First, while there exist a handful of such flags whose default value can be changed (eg: git diff, patchwork confirmation), there is only a few of them. The users who benefit the most from this change are alias users and large installation that can deploy extension to change behavior (eg: facebook tweakdefault). So the majority of user who will be affected by a large change to command help that is not yet relevant to them. (I expect this to become relevant when ui.progressive start to exists). Below is an example of the impact of the new help on 'hg help diff': -r --rev REV [+] revision -c --change REV change made by revision -a --[no-]text treat all files as text -g --[no-]git use git extended diff format --[no-]nodates omit dates from diff headers --[no-]noprefix omit a/ and b/ prefixes from filenames -p --[no-]show-function show which function each change is in --[no-]reverse produce a diff that undoes the changes -w --[no-]ignore-all-space ignore white space when comparing lines -b --[no-]ignore-space-change ignore changes in the amount of white space -B --[no-]ignore-blank-lines ignore changes whose lines are all blank -U --unified NUM number of lines of context to show --[no-]stat output diffstat-style summary of changes --root DIR produce diffs relative to subdirectory -I --include PATTERN [+] include names matching the given patterns -X --exclude PATTERN [+] exclude names matching the given patterns -S --[no-]subrepos recurse into subrepositories Another issue with the current state of help, the default value for the flag is not conveyed to the user. For example in the 'backout' help, there is no real distinction between "--[no-]backup" (default to True) and "--[no-]keep" (default) to False: --[no-]backup no backups --[no-]keep do not modify working directory during strip In addition, I've discussed with Augie Fackler and the last batch of the work on this have burned him out quite some. Therefore he is not intending to perform any more work on this topic. Quoting him, he would rather see the help part backed out than spending more time on it. I do not think we are ready to expose this to users in 4.0 (freeze in a week), especially because we cannot expect quick improvement on these aspect as this topic no longer have an owner. We should be able to reintroduce that change in the future when someone get back on it and the main issues are solves: * Introduction of ui.progressive makes it relevant for a majority of user, * Current default value are efficiently conveyed to the user. (In addition, the excerpt from diff help show that we still have some issue with some negative option like '--nodates' so further improvement are probably welcome there.)
2016-10-09 04:11:18 +03:00
<td>--hidden</td>
minirst: HTML formatter tweaks output table rows on distinct lines don't make the first row a table header
2013-02-10 01:51:21 +04:00
<td>consider hidden changesets</td></tr>
pager: move more behavior into core This moves the global flag and the --pager=yes logic into core. Only functionality change is that users now always get a --pager flag and can enable the pager via the flag without the extension active. Moving the flag into core exposes a defect in the ro localization, which will have to be corrected later.
2017-02-16 01:47:57 +03:00
<tr><td></td>
<td>--pager TYPE</td>
<td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</table>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</div>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</div>
</div>
</body>
</html>
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
hgweb help: add tests
2013-03-01 22:42:42 +04:00
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>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<title>Help: dates</title>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</head>
<body>
<div class="container">
<div class="menu">
<div class="logo">
urls: bulk-change primary website URLs
2015-09-30 23:43:49 +03:00
<a href="https://mercurial-scm.org/">
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<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>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<h3>Help: dates</h3>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
<form class="search" action="/log">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
paper: edit search hint to include new feature description
2013-09-06 13:30:57 +04:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</form>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<div id="doc">
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<h1>Date Formats</h1>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
Some commands allow the user to specify a date, e.g.:
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<ul>
<li> backout, commit, import, tag: Specify the commit date.
<li> log, revert, update: Select revision(s) by date.
</ul>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
Many date formats are valid. Here are some examples:
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<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>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
Lastly, there is Mercurial's internal format:
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<ul>
<li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
</ul>
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
<p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
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).
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
<p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
The log command also accepts date ranges:
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</p>
tests: use `hg help dates` instead of `hg help revs` in test The revisions help is already long and will get longer, so switch to another short and stable topic.
2017-01-11 22:40:40 +03:00
<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>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
hgweb: generate HTML documentation It's generated from the raw ReST source, as returned from help.help_().
2013-02-10 01:51:21 +04:00
</div>
hgweb help: add tests
2013-03-01 22:42:42 +04:00
</div>
</div>
</body>
</html>
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
Sub-topic indexes rendered properly
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
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>
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
<form class="search" action="/log">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
<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">
hgweb: make anchor name actually match its href on help index page
2016-09-26 11:12:40 +03:00
<tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
<tr><td>
<a href="/help/internals.bundles">
bundles
</a>
</td><td>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
Bundles
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
</td></tr>
<tr><td>
help: update help.internalstable for new censor docs
2017-03-11 01:37:39 +03:00
<a href="/help/internals.censor">
censor
</a>
</td><td>
Censor
</td></tr>
<tr><td>
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
<a href="/help/internals.changegroups">
changegroups
</a>
</td><td>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
Changegroups
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
</td></tr>
internals: document revlog format It seems like a good idea to document the revlog format. There is a lot more that could be added to this documentation. But you have to start somewhere.
2015-12-31 02:21:57 +03:00
<tr><td>
internal-doc: document the config register mechanism This explains the various usage and feature of the config register introduced in Mercurial 4.3 and 4.4.
2017-10-27 19:19:07 +03:00
<a href="/help/internals.config">
config
</a>
</td><td>
internals: update test-help.t for config registrar copy-edit
2017-11-01 23:34:22 +03:00
Config Registrar
internal-doc: document the config register mechanism This explains the various usage and feature of the config register introduced in Mercurial 4.3 and 4.4.
2017-10-27 19:19:07 +03:00
</td></tr>
<tr><td>
help: document requirements We didn't have unified documentation of the various repository requirements. This patch changes that.
2016-03-13 05:51:07 +03:00
<a href="/help/internals.requirements">
requirements
</a>
</td><td>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
Repository Requirements
help: document requirements We didn't have unified documentation of the various repository requirements. This patch changes that.
2016-03-13 05:51:07 +03:00
</td></tr>
<tr><td>
internals: document revlog format It seems like a good idea to document the revlog format. There is a lot more that could be added to this documentation. But you have to start somewhere.
2015-12-31 02:21:57 +03:00
<a href="/help/internals.revlogs">
revlogs
</a>
</td><td>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
Revision Logs
internals: document revlog format It seems like a good idea to document the revlog format. There is a lot more that could be added to this documentation. But you have to start somewhere.
2015-12-31 02:21:57 +03:00
</td></tr>
help: internals topic for wire protocol The Mercurial wire protocol is under-documented. This includes a lack of source docstrings and comments as well as pages on the official wiki. This patch adds the beginnings of "internals" documentation on the wire protocol. The documentation should have nearly complete coverage on the lower-level parts of the protocol, such as the different transport mechanims, how commands and arguments are sent, capabilities, and, of course, the commands themselves. As part of writing this documentation, I discovered a number of deficiencies in the protocol and bugs in the implementation. I've started sending patches for some of the issues. I hope to send a lot more. This patch starts with the scaffolding for a new internals page.
2016-08-23 05:46:39 +03:00
<tr><td>
<a href="/help/internals.wireprotocol">
wireprotocol
</a>
</td><td>
Wire Protocol
</td></tr>
hgweb: support rendering sub-topic indexes If the requested topic name is the name of a sub-topic, we now render an index of topics within that sub-topic.
2015-12-31 03:34:51 +03:00
</table>
</div>
</div>
</body>
</html>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
Sub-topic topics rendered properly
tests: use LOCALIP This patch replaces hardcoded 127.0.0.1 with $LOCALIP in all tests. Till now, the IPv6 series should make tests pass on common IPv6 systems where the local device has the address "::1" and the hostname "localhost" resolves to "::1".
2017-02-16 20:38:52 +03:00
$ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
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">
hgweb: consolidate search form for paper AFAICT this was mostly a bunch of copy pasta. The only variation is some pages defined a "value" attribute. The "query" variable will just be empty on pages that don't accept it. So let's consolidate the template and remove the redundancy.
2017-06-09 23:59:13 +03:00
<p><input name="rev" id="search1" type="text" size="30" value="" /></p>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<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">
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
<h1>Changegroups</h1>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<p>
Changegroups are representations of repository revlog data, specifically
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
the changelog data, root/flat manifest data, treemanifest data, and
filelogs.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<p>
There are 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&quot;. From a
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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).
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Changegroups when not exchanging treemanifests consist of 3 logical
segments:
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<pre>
+---------------------------------+
| | | |
| changeset | manifest | filelogs |
| | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| | | |
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
+---------------------------------+
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
When exchanging treemanifests, there are 4 logical segments:
</p>
<pre>
+-------------------------------------------------+
| | | | |
| changeset | root | treemanifests | filelogs |
| | manifest | | |
| | | | |
+-------------------------------------------------+
</pre>
<p>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
The principle building block of each segment is a *chunk*. A *chunk*
is a framed piece of data:
</p>
<pre>
+---------------------------------------+
| | |
| length | data |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| (4 bytes) | (&lt;length - 4&gt; bytes) |
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
| | |
+---------------------------------------+
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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).
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
There is a special case chunk that has a value of 0 for the length
(&quot;0x00000000&quot;). We call this an *empty chunk*.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
<h2>Delta Groups</h2>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<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 |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| (4 bytes) | (various) | (4 bytes) | (various) | (4 bytes) |
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
| | | | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+------------------------------------------------------------------------+
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</pre>
<p>
Each *chunk*'s data consists of the following:
</p>
<pre>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+---------------------------------------+
| | |
| delta header | delta data |
| (various by version) | (various) |
| | |
+---------------------------------------+
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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
help: spelling fixes
2017-05-04 05:07:47 +03:00
bundle/changegroup).
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</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>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 1 (headerlen=80):
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<pre>
+------------------------------------------------------+
| | | | |
| node | p1 node | p2 node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | |
+------------------------------------------------------+
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 2 (headerlen=100):
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<pre>
+------------------------------------------------------------------+
| | | | | |
| node | p1 node | p2 node | base node | link node |
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) |
| | | | | |
+------------------------------------------------------------------+
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
Version 3 (headerlen=102):
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<pre>
+------------------------------------------------------------------------------+
| | | | | | |
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
| node | p1 node | p2 node | base node | link node | flags |
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
| (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
| | | | | | |
+------------------------------------------------------------------------------+
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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:
</p>
help: fix layout of pre-formatted text
2017-03-09 06:55:48 +03:00
<pre>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+---------------------------------------------------------------+
| | | | |
| start offset | end offset | new length | content |
| (4 bytes) | (4 bytes) | (4 bytes) | (&lt;new length&gt; bytes) |
| | | | |
+---------------------------------------------------------------+
help: fix layout of pre-formatted text
2017-03-09 06:55:48 +03:00
</pre>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
<p>
Please note that the length field in the delta data does *not* include itself.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<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>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
In version 2 and up, the delta base node is encoded in the entry in the
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
changegroup. This allows the delta to be expressed against any parent,
which can result in smaller deltas and more efficient encoding of data.
</p>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
<h2>Changeset Segment</h2>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<p>
The *changeset segment* consists of a single *delta group* holding
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
changelog data. The *empty chunk* at the end of the *delta group* denotes
the boundary to the *manifest segment*.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
<h2>Manifest Segment</h2>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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*.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
2016-08-07 03:04:22 +03:00
<h2>Filelogs Segment</h2>
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
The *filelogs segment* consists of multiple sub-segments, each
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
corresponding to an individual file whose data is being described:
</p>
<pre>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+--------------------------------------------------+
| | | | | |
| filelog0 | filelog1 | filelog2 | ... | 0x0 |
| | | | | (4 bytes) |
| | | | | |
+--------------------------------------------------+
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</pre>
<p>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
<p>
Each filelog sub-segment consists of the following:
</p>
<pre>
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
+------------------------------------------------------+
| | | |
| filename length | filename | delta group |
| (4 bytes) | (&lt;length - 4&gt; bytes) | (various) |
| | | |
+------------------------------------------------------+
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</pre>
<p>
That is, a *chunk* consisting of the filename (not terminated or padded)
help: fix internals.changegroups Add information about tree manifests, copy edit the text and fix up a few ambiguities. The document also contains a few additional fixes from Siddharth Agarwal <sid0@fb.com>, who used it to build a parser for changegroups in Rust.
2017-03-02 05:37:34 +03:00
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.
hgweb: support rendering a sub-topic If the requested topic contains a "." we assume a sub-topic is requested and display it.
2015-12-31 03:15:10 +03:00
</p>
</div>
</div>
</div>
</body>
</html>
tests: drop DAEMON_PIDS from killdaemons calls
2015-06-08 22:55:40 +03:00
$ killdaemons.py
hgweb help: add tests
2013-03-01 22:42:42 +04:00
#endif
Reference in New Issue Copy Permalink