Wrap synopsis lines and use [verse] to keep formatting
In addition, also fixes a few synopses to be more consistent and a gitlink. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
Jonas Fonseca committed
Dec 31, 2005 at 18:37 UTC
353ce81597e831969ac37d6991346f8c39c1488e
16 files changed
+49
-34
Documentation/git-am.txt
+1
@@ -8,6 +8,7 @@ git-am - Apply a series of patches in a mailbox
8
9
SYNOPSIS
10
--------
11
+[verse]
12
'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way] <mbox>...
13
'git-am' [--skip | --resolved]
14
Documentation/git-apply.txt
+4
-1
@@ -8,7 +8,10 @@ git-apply - Apply patch on a git index file and a work tree
8
9
SYNOPSIS
10
--------
11
-'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] [--no-add] [--index-info] [--allow-binary-replacement] [-z] [<patch>...]
11
+[verse]
12
+'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply]
13
+ [--no-add] [--index-info] [--allow-binary-replacement] [-z]
14
+ [<patch>...]
15
16
DESCRIPTION
17
-----------
Documentation/git-archimport.txt
+3
-3
@@ -8,9 +8,9 @@ git-archimport - Import an Arch repository into git
8
9
SYNOPSIS
10
--------
11
-`git-archimport` [ -h ] [ -v ] [ -o ] [ -a ] [ -f ] [ -T ]
12
- [ -D depth ] [ -t tempdir ]
13
- <archive/branch> [ <archive/branch> ]
11
+[verse]
12
+`git-archimport` [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir]
13
+ <archive/branch> [ <archive/branch> ]
14
15
DESCRIPTION
16
-----------
Documentation/git-cat-file.txt
+1
-1
@@ -8,7 +8,7 @@ git-cat-file - Provide content or type information for repository objects
8
9
SYNOPSIS
10
--------
11
-'git-cat-file' (-t | -s | -e | <type>) <object>
11
+'git-cat-file' [-t | -s | -e | <type>] <object>
12
13
DESCRIPTION
14
-----------
Documentation/git-checkout-index.txt
+2
-1
@@ -8,8 +8,9 @@ git-checkout-index - Copy files from the index to the working directory
8
9
SYNOPSIS
10
--------
11
+[verse]
12
'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
12
- [--stage=<number>] [--] <file>...
13
+ [--stage=<number>] [--] <file>...
14
15
DESCRIPTION
16
-----------
Documentation/git-clone.txt
+3
-1
@@ -8,7 +8,9 @@ git-clone - Clones a repository.
8
9
SYNOPSIS
10
--------
11
-'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> [<directory>]
11
+[verse]
12
+'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>]
13
+ <repository> [<directory>]
14
15
DESCRIPTION
16
-----------
Documentation/git-commit.txt
+3
-1
@@ -7,7 +7,9 @@ git-commit - Record your changes
7
8
SYNOPSIS
9
--------
10
-'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>...
10
+[verse]
11
+'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
12
+ [-e] [--] <file>...
13
14
DESCRIPTION
15
-----------
Documentation/git-cvsexportcommit.txt
+1
-2
@@ -8,8 +8,7 @@ git-cvsexportcommit - Export a commit to a CVS checkout
8
9
SYNOPSIS
10
--------
11
-git-cvsexportcommmit.perl
12
- [ -h ] [ -v ] [ -c ] [ -p ] [PARENTCOMMIT] COMMITID
11
+'git-cvsexportcommmit' [-h] [-v] [-c] [-p] [PARENTCOMMIT] COMMITID
12
13
14
DESCRIPTION
Documentation/git-cvsimport.txt
+4
-4
@@ -8,10 +8,10 @@ git-cvsimport - Import a CVS repository into git
8
9
SYNOPSIS
10
--------
11
-'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
12
- [ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
13
- [ -C <git_repository> ] [ -i ] [ -P <file> ] [ -k ]
14
- [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
11
+[verse]
12
+'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] [-s <subst>]
13
+ [-p <options-for-cvsps>] [-C <git_repository>] [-i] [-P <file>]
14
+ [-m] [-M regex] [<CVS_module>]
15
16
17
DESCRIPTION
Documentation/git-daemon.txt
+2
-1
@@ -7,8 +7,9 @@ git-daemon - A really simple server for git repositories.
7
8
SYNOPSIS
9
--------
10
+[verse]
11
'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
11
- [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...]
12
+ [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...]
13
14
DESCRIPTION
15
-----------
Documentation/git-diff-tree.txt
+3
-1
@@ -8,7 +8,9 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
8
9
SYNOPSIS
10
--------
11
-'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
11
+[verse]
12
+'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r]
13
+ [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
14
15
DESCRIPTION
16
-----------
Documentation/git-format-patch.txt
+4
-2
@@ -8,7 +8,9 @@ git-format-patch - Prepare patches for e-mail submission.
8
9
SYNOPSIS
10
--------
11
-'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]
11
+[verse]
12
+'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox]
13
+ [--diff-options] <his> [<mine>]
14
15
DESCRIPTION
16
-----------
@@ -96,7 +98,7 @@ git-format-patch -M -B origin::
98
99
See Also
100
--------
99
-gitlink:git-am[1], gitlink:git-send-email
101
+gitlink:git-am[1], gitlink:git-send-email[1]
102
103
104
Author
Documentation/git-fsck-objects.txt
+3
-1
@@ -8,7 +8,9 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the
8
9
SYNOPSIS
10
--------
11
-'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [--strict] [<object>*]
11
+[verse]
12
+'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache]
13
+ [--standalone | --full] [--strict] [<object>*]
14
15
DESCRIPTION
16
-----------
Documentation/git-grep.txt
+1
-2
@@ -8,7 +8,7 @@ git-grep - print lines matching a pattern
8
9
SYNOPSIS
10
--------
11
-'git-grep' <option>... <pattern> <path>...
11
+'git-grep' [<option>...] <pattern> [<path>...]
12
13
DESCRIPTION
14
-----------
@@ -27,7 +27,6 @@ OPTIONS
27
The pattern to look for.
28
29
<path>...::
30
-
30
Optional paths to limit the set of files to be searched;
31
passed to `git-ls-files`.
32
Documentation/git-http-fetch.txt
+2
-2
@@ -3,12 +3,12 @@ git-http-fetch(1)
3
4
NAME
5
----
6
-git-http-fetch - Downloads a remote git repository via HTTP
6
+git-http-fetch - downloads a remote git repository via HTTP
7
8
9
SYNOPSIS
10
--------
11
-'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url
11
+'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] <commit> <url>
12
13
DESCRIPTION
14
-----------
Documentation/git-rev-list.txt
+12
-11
@@ -8,18 +8,19 @@ git-rev-list - Lists commit objects in reverse chronological order
8
9
SYNOPSIS
10
--------
11
+[verse]
12
'git-rev-list' [ \--max-count=number ]
12
- [ \--max-age=timestamp ]
13
- [ \--min-age=timestamp ]
14
- [ \--sparse ]
15
- [ \--no-merges ]
16
- [ \--all ]
17
- [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] | ]
18
- [ \--parents ]
19
- [ \--objects [ \--unpacked ] ]
20
- [ \--pretty | \--header | ]
21
- [ \--bisect ]
22
- <commit>... [ \-- <paths>... ]
13
+ [ \--max-age=timestamp ]
14
+ [ \--min-age=timestamp ]
15
+ [ \--sparse ]
16
+ [ \--no-merges ]
17
+ [ \--all ]
18
+ [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] ]
19
+ [ \--parents ]
20
+ [ \--objects [ \--unpacked ] ]
21
+ [ \--pretty | \--header ]
22
+ [ \--bisect ]
23
+ <commit>... [ \-- <paths>... ]
24
25
DESCRIPTION
26
-----------