Mercurial > hg
changeset 12390:aff4afdcfd2b
Use more note admonitions in help texts
author | Christian Ebert <blacktrash@gmx.net> |
---|---|
date | Thu, 23 Sep 2010 16:31:38 +0200 |
parents | 4ac734b9b3fd |
children | 9d45f78c465b |
files | hgext/keyword.py mercurial/commands.py tests/test-help.t |
diffstat | 3 files changed, 29 insertions(+), 22 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/keyword.py Wed Sep 22 16:23:55 2010 +0200 +++ b/hgext/keyword.py Thu Sep 23 16:31:38 2010 +0200 @@ -52,8 +52,9 @@ # prefer svn- over cvs-like default keywordmaps svn = True -NOTE: the more specific you are in your filename patterns the less you -lose speed in huge repositories. +.. note:: + The more specific you are in your filename patterns the less you + lose speed in huge repositories. For [keywordmaps] template mapping and expansion demonstration and control run :hg:`kwdemo`. See :hg:`help templates` for a list of
--- a/mercurial/commands.py Wed Sep 22 16:23:55 2010 +0200 +++ b/mercurial/commands.py Thu Sep 23 16:31:38 2010 +0200 @@ -1487,9 +1487,10 @@ branch name (if non-default), changeset hash, parent(s) and commit comment. - NOTE: export may generate unexpected diff output for merge - changesets, as it will compare the merge changeset against its - first parent only. + .. note:: + export may generate unexpected diff output for merge + changesets, as it will compare the merge changeset against its + first parent only. Output may be to a file, in which case the name of the file is given using a format string. The formatting rules are as follows: @@ -2445,10 +2446,11 @@ each commit. When the -v/--verbose switch is used, the list of changed files and full commit message are shown. - NOTE: log -p/--patch may generate unexpected diff output for merge - changesets, as it will only compare the merge changeset against - its first parent. Also, only files different from BOTH parents - will appear in files:. + .. note:: + log -p/--patch may generate unexpected diff output for merge + changesets, as it will only compare the merge changeset against + its first parent. Also, only files different from BOTH parents + will appear in files:. Returns 0 on success. """ @@ -3002,11 +3004,13 @@ def revert(ui, repo, *pats, **opts): """restore individual files or directories to an earlier state - NOTE: This command is most likely not what you are looking for. revert - will partially overwrite content in the working directory without changing - the working directory parents. Use :hg:`update -r rev` to check out earlier - revisions, or :hg:`update --clean .` to undo a merge which has added - another parent. + .. note:: + This command is most likely not what you are looking for. + revert will partially overwrite content in the working + directory without changing the working directory parents. Use + :hg:`update -r rev` to check out earlier revisions, or + :hg:`update --clean .` to undo a merge which has added another + parent. With no revision specified, revert the named files or directories to the contents they had in the parent of the working directory. @@ -3372,10 +3376,11 @@ Option -q/--quiet hides untracked (unknown and ignored) files unless explicitly requested with -u/--unknown or -i/--ignored. - NOTE: status may appear to disagree with diff if permissions have - 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. + .. note:: + status may appear to disagree with diff if permissions have + 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. If one revision is given, it is used as the base revision. If two revisions are given, the differences between them are
--- a/tests/test-help.t Wed Sep 22 16:23:55 2010 +0200 +++ b/tests/test-help.t Thu Sep 23 16:31:38 2010 +0200 @@ -499,10 +499,11 @@ Option -q/--quiet hides untracked (unknown and ignored) files unless explicitly requested with -u/--unknown or -i/--ignored. - NOTE: status may appear to disagree with diff if permissions have 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. + Note: + status may appear to disagree with diff if permissions have 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. 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