##// END OF EJS Templates
help: format command and option list help using RST...
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&gt; 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&gt; 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.

File last commit:

r16458:55982f62 default
r16853:7863ff38 default
Show More
test-qrecord.t
399 lines | 8.6 KiB | text/troff | Tads3Lexer
Create configuration
$ echo "[ui]" >> $HGRCPATH
$ echo "interactive=true" >> $HGRCPATH
help record (no record)
$ hg help record
record extension - commands to interactively select changes for commit/qrefresh
use "hg help extensions" for information on enabling extensions
help qrecord (no record)
$ hg help qrecord
'qrecord' is provided by the following extension:
record commands to interactively select changes for commit/qrefresh
use "hg help extensions" for information on enabling extensions
$ echo "[extensions]" >> $HGRCPATH
$ echo "record=" >> $HGRCPATH
help record (record)
$ hg help record
hg record [OPTION]... [FILE]...
interactively select changes to commit
If a list of files is omitted, all changes reported by "hg status" will be
candidates for recording.
See "hg help dates" for a list of formats valid for -d/--date.
You will be prompted for whether to record changes to each modified file,
and for files with multiple changes, for each change to use. For each
query, the following responses are possible:
y - record this change
n - skip this change
e - edit this change manually
s - skip remaining changes to this file
f - record remaining changes to this file
d - done, skip remaining changes and files
a - record all changes to all remaining files
q - quit, recording no changes
? - display help
This command is not available when committing a merge.
options:
-A --addremove mark new/missing files as added/removed before
committing
--close-branch mark a branch as closed, hiding it from the branch
list
--amend amend the parent of the working dir
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
-m --message TEXT use text as commit message
-l --logfile FILE read commit message from file
-d --date DATE record the specified date as commit date
-u --user USER record the specified user as committer
-S --subrepos recurse into subrepositories
-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
[+] marked option can be specified multiple times
use "hg -v help record" to show more info
help (no mq, so no qrecord)
$ hg help qrecord
hg qrecord [OPTION]... PATCH [FILE]...
interactively record a new patch
See "hg help qnew" & "hg help record" for more information and usage.
use "hg -v help qrecord" to show more info
$ hg init a
qrecord (mq not present)
$ hg -R a qrecord
hg qrecord: invalid arguments
hg qrecord [OPTION]... PATCH [FILE]...
interactively record a new patch
use "hg help qrecord" to show the full help text
[255]
qrecord patch (mq not present)
$ hg -R a qrecord patch
abort: 'mq' extension not loaded
[255]
help (bad mq)
$ echo "mq=nonexistant" >> $HGRCPATH
$ hg help qrecord
*** failed to import extension mq from nonexistant: [Errno 2] * (glob)
hg qrecord [OPTION]... PATCH [FILE]...
interactively record a new patch
See "hg help qnew" & "hg help record" for more information and usage.
use "hg -v help qrecord" to show more info
help (mq present)
$ sed 's/mq=nonexistant/mq=/' $HGRCPATH > hgrc.tmp
$ mv hgrc.tmp $HGRCPATH
$ hg help qrecord
hg qrecord [OPTION]... PATCH [FILE]...
interactively record a new patch
See "hg help qnew" & "hg help record" for more information and usage.
options:
-e --edit edit commit message
-g --git use git extended diff format
-U --currentuser add "From: <current user>" to patch
-u --user USER add "From: <USER>" to patch
-D --currentdate add "Date: <current date>" to patch
-d --date DATE add "Date: <DATE>" to patch
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
-m --message TEXT use text as commit message
-l --logfile FILE read commit message from file
-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
--mq operate on patch repository
[+] marked option can be specified multiple times
use "hg -v help qrecord" to show more info
$ cd a
Base commit
$ cat > 1.txt <<EOF
> 1
> 2
> 3
> 4
> 5
> EOF
$ cat > 2.txt <<EOF
> a
> b
> c
> d
> e
> f
> EOF
$ mkdir dir
$ cat > dir/a.txt <<EOF
> hello world
>
> someone
> up
> there
> loves
> me
> EOF
$ hg add 1.txt 2.txt dir/a.txt
$ hg commit -m 'initial checkin'
Changing files
$ sed -e 's/2/2 2/;s/4/4 4/' 1.txt > 1.txt.new
$ sed -e 's/b/b b/' 2.txt > 2.txt.new
$ sed -e 's/hello world/hello world!/' dir/a.txt > dir/a.txt.new
$ mv -f 1.txt.new 1.txt
$ mv -f 2.txt.new 2.txt
$ mv -f dir/a.txt.new dir/a.txt
Whole diff
$ hg diff --nodates
diff -r 1057167b20ef 1.txt
--- a/1.txt
+++ b/1.txt
@@ -1,5 +1,5 @@
1
-2
+2 2
3
-4
+4 4
5
diff -r 1057167b20ef 2.txt
--- a/2.txt
+++ b/2.txt
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
diff -r 1057167b20ef dir/a.txt
--- a/dir/a.txt
+++ b/dir/a.txt
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
qrecord with bad patch name, should abort before prompting
$ hg qrecord .hg
abort: patch name cannot begin with ".hg"
[255]
qrecord a.patch
$ hg qrecord -d '0 0' -m aaa a.patch <<EOF
> y
> y
> n
> y
> y
> n
> EOF
diff --git a/1.txt b/1.txt
2 hunks, 2 lines changed
examine changes to '1.txt'? [Ynesfdaq?]
@@ -1,3 +1,3 @@
1
-2
+2 2
3
record change 1/4 to '1.txt'? [Ynesfdaq?]
@@ -3,3 +3,3 @@
3
-4
+4 4
5
record change 2/4 to '1.txt'? [Ynesfdaq?]
diff --git a/2.txt b/2.txt
1 hunks, 1 lines changed
examine changes to '2.txt'? [Ynesfdaq?]
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
record change 3/4 to '2.txt'? [Ynesfdaq?]
diff --git a/dir/a.txt b/dir/a.txt
1 hunks, 1 lines changed
examine changes to 'dir/a.txt'? [Ynesfdaq?]
After qrecord a.patch 'tip'"
$ hg tip -p
changeset: 1:5d1ca63427ee
tag: a.patch
tag: qbase
tag: qtip
tag: tip
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: aaa
diff -r 1057167b20ef -r 5d1ca63427ee 1.txt
--- a/1.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/1.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
1
-2
+2 2
3
4
5
diff -r 1057167b20ef -r 5d1ca63427ee 2.txt
--- a/2.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/2.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
After qrecord a.patch 'diff'"
$ hg diff --nodates
diff -r 5d1ca63427ee 1.txt
--- a/1.txt
+++ b/1.txt
@@ -1,5 +1,5 @@
1
2 2
3
-4
+4 4
5
diff -r 5d1ca63427ee dir/a.txt
--- a/dir/a.txt
+++ b/dir/a.txt
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
qrecord b.patch
$ hg qrecord -d '0 0' -m bbb b.patch <<EOF
> y
> y
> y
> y
> EOF
diff --git a/1.txt b/1.txt
1 hunks, 1 lines changed
examine changes to '1.txt'? [Ynesfdaq?]
@@ -1,5 +1,5 @@
1
2 2
3
-4
+4 4
5
record change 1/2 to '1.txt'? [Ynesfdaq?]
diff --git a/dir/a.txt b/dir/a.txt
1 hunks, 1 lines changed
examine changes to 'dir/a.txt'? [Ynesfdaq?]
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
record change 2/2 to 'dir/a.txt'? [Ynesfdaq?]
After qrecord b.patch 'tip'
$ hg tip -p
changeset: 2:b056198bf878
tag: b.patch
tag: qtip
tag: tip
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: bbb
diff -r 5d1ca63427ee -r b056198bf878 1.txt
--- a/1.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/1.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
1
2 2
3
-4
+4 4
5
diff -r 5d1ca63427ee -r b056198bf878 dir/a.txt
--- a/dir/a.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/dir/a.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
After qrecord b.patch 'diff'
$ hg diff --nodates