diff options
author | Jonas Fonseca <fonseca@diku.dk> | 2005-12-31 18:37:15 +0100 |
---|---|---|
committer | Junio C Hamano <junkio@cox.net> | 2006-01-05 18:44:28 -0800 |
commit | 353ce81597e831969ac37d6991346f8c39c1488e (patch) | |
tree | 7b925733c5a09e7b4e3bfa2d20926583d926f2b7 /Documentation | |
parent | 6ff0b1c56c451445f7dc45b652a4dc60213eac19 (diff) | |
download | git-353ce81597e831969ac37d6991346f8c39c1488e.tar.gz |
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>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-am.txt | 1 | ||||
-rw-r--r-- | Documentation/git-apply.txt | 5 | ||||
-rw-r--r-- | Documentation/git-archimport.txt | 6 | ||||
-rw-r--r-- | Documentation/git-cat-file.txt | 2 | ||||
-rw-r--r-- | Documentation/git-checkout-index.txt | 3 | ||||
-rw-r--r-- | Documentation/git-clone.txt | 4 | ||||
-rw-r--r-- | Documentation/git-commit.txt | 4 | ||||
-rw-r--r-- | Documentation/git-cvsexportcommit.txt | 3 | ||||
-rw-r--r-- | Documentation/git-cvsimport.txt | 8 | ||||
-rw-r--r-- | Documentation/git-daemon.txt | 3 | ||||
-rw-r--r-- | Documentation/git-diff-tree.txt | 4 | ||||
-rw-r--r-- | Documentation/git-format-patch.txt | 6 | ||||
-rw-r--r-- | Documentation/git-fsck-objects.txt | 4 | ||||
-rw-r--r-- | Documentation/git-grep.txt | 3 | ||||
-rw-r--r-- | Documentation/git-http-fetch.txt | 4 | ||||
-rw-r--r-- | Documentation/git-rev-list.txt | 23 |
16 files changed, 49 insertions, 34 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index a415fe24c3..02cabc935e 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -8,6 +8,7 @@ git-am - Apply a series of patches in a mailbox SYNOPSIS -------- +[verse] 'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way] <mbox>... 'git-am' [--skip | --resolved] diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 626e281596..51c7d47092 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -8,7 +8,10 @@ git-apply - Apply patch on a git index file and a work tree SYNOPSIS -------- -'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] [--no-add] [--index-info] [--allow-binary-replacement] [-z] [<patch>...] +[verse] +'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] + [--no-add] [--index-info] [--allow-binary-replacement] [-z] + [<patch>...] DESCRIPTION ----------- diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index fe57fe1e92..023d3ae7b9 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -8,9 +8,9 @@ git-archimport - Import an Arch repository into git SYNOPSIS -------- -`git-archimport` [ -h ] [ -v ] [ -o ] [ -a ] [ -f ] [ -T ] - [ -D depth ] [ -t tempdir ] - <archive/branch> [ <archive/branch> ] +[verse] +`git-archimport` [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] + <archive/branch> [ <archive/branch> ] DESCRIPTION ----------- diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index 9a7700fa7f..504eb1b16a 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -8,7 +8,7 @@ git-cat-file - Provide content or type information for repository objects SYNOPSIS -------- -'git-cat-file' (-t | -s | -e | <type>) <object> +'git-cat-file' [-t | -s | -e | <type>] <object> DESCRIPTION ----------- diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 9f32c65aab..2a1e526c6a 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -8,8 +8,9 @@ git-checkout-index - Copy files from the index to the working directory SYNOPSIS -------- +[verse] 'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] - [--stage=<number>] [--] <file>... + [--stage=<number>] [--] <file>... DESCRIPTION ----------- diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 8410a6d381..ffa4fb0a03 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -8,7 +8,9 @@ git-clone - Clones a repository. SYNOPSIS -------- -'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> [<directory>] +[verse] +'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] + <repository> [<directory>] DESCRIPTION ----------- diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 8b91f221fe..e0ff74f648 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -7,7 +7,9 @@ git-commit - Record your changes SYNOPSIS -------- -'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>... +[verse] +'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] + [-e] [--] <file>... DESCRIPTION ----------- diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 91def2b515..13cbf3ba67 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -8,8 +8,7 @@ git-cvsexportcommit - Export a commit to a CVS checkout SYNOPSIS -------- -git-cvsexportcommmit.perl - [ -h ] [ -v ] [ -c ] [ -p ] [PARENTCOMMIT] COMMITID +'git-cvsexportcommmit' [-h] [-v] [-c] [-p] [PARENTCOMMIT] COMMITID DESCRIPTION diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index f89b251e1e..01ca7ef96f 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -8,10 +8,10 @@ git-cvsimport - Import a CVS repository into git SYNOPSIS -------- -'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] - [ -d <CVSROOT> ] [ -p <options-for-cvsps> ] - [ -C <git_repository> ] [ -i ] [ -P <file> ] [ -k ] - [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ] +[verse] +'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] [-s <subst>] + [-p <options-for-cvsps>] [-C <git_repository>] [-i] [-P <file>] + [-m] [-M regex] [<CVS_module>] DESCRIPTION diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 2a8f371ec9..33f3320e28 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -7,8 +7,9 @@ git-daemon - A really simple server for git repositories. SYNOPSIS -------- +[verse] 'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all] - [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...] + [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...] DESCRIPTION ----------- diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index f2312f4d78..91fb130497 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -8,7 +8,9 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object SYNOPSIS -------- -'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...] +[verse] +'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] + [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...] DESCRIPTION ----------- diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index d7ca2dbb22..47705de4fc 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -8,7 +8,9 @@ git-format-patch - Prepare patches for e-mail submission. SYNOPSIS -------- -'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>] +[verse] +'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] + [--diff-options] <his> [<mine>] DESCRIPTION ----------- @@ -96,7 +98,7 @@ git-format-patch -M -B origin:: See Also -------- -gitlink:git-am[1], gitlink:git-send-email +gitlink:git-am[1], gitlink:git-send-email[1] Author diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt index bab1f6080c..387b435484 100644 --- a/Documentation/git-fsck-objects.txt +++ b/Documentation/git-fsck-objects.txt @@ -8,7 +8,9 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the SYNOPSIS -------- -'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [--strict] [<object>*] +[verse] +'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] + [--standalone | --full] [--strict] [<object>*] DESCRIPTION ----------- diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 0175793483..2bfd8edbc8 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -8,7 +8,7 @@ git-grep - print lines matching a pattern SYNOPSIS -------- -'git-grep' <option>... <pattern> <path>... +'git-grep' [<option>...] <pattern> [<path>...] DESCRIPTION ----------- @@ -27,7 +27,6 @@ OPTIONS The pattern to look for. <path>...:: - Optional paths to limit the set of files to be searched; passed to `git-ls-files`. diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 1116e855d6..bc1a132891 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -3,12 +3,12 @@ git-http-fetch(1) NAME ---- -git-http-fetch - Downloads a remote git repository via HTTP +git-http-fetch - downloads a remote git repository via HTTP SYNOPSIS -------- -'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url +'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] <commit> <url> DESCRIPTION ----------- diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index 75c9968004..f9146f1900 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -8,18 +8,19 @@ git-rev-list - Lists commit objects in reverse chronological order SYNOPSIS -------- +[verse] 'git-rev-list' [ \--max-count=number ] - [ \--max-age=timestamp ] - [ \--min-age=timestamp ] - [ \--sparse ] - [ \--no-merges ] - [ \--all ] - [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] | ] - [ \--parents ] - [ \--objects [ \--unpacked ] ] - [ \--pretty | \--header | ] - [ \--bisect ] - <commit>... [ \-- <paths>... ] + [ \--max-age=timestamp ] + [ \--min-age=timestamp ] + [ \--sparse ] + [ \--no-merges ] + [ \--all ] + [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] ] + [ \--parents ] + [ \--objects [ \--unpacked ] ] + [ \--pretty | \--header ] + [ \--bisect ] + <commit>... [ \-- <paths>... ] DESCRIPTION ----------- |