Skip to content

Commit

Permalink
Wrap synopsis lines and use [verse] to keep formatting
Browse files Browse the repository at this point in the history 
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>
  • Loading branch information
Jonas Fonseca authored and Junio C Hamano committed Jan 6, 2006
1 parent 6ff0b1c commit 353ce81
Show file tree
Hide file tree
Showing 16 changed files with 49 additions and 34 deletions.
1 change: 1 addition & 0 deletions Documentation/git-am.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
5 changes: 4 additions & 1 deletion Documentation/git-apply.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-archimport.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-cat-file.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
3 changes: 2 additions & 1 deletion Documentation/git-checkout-index.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 3 additions & 1 deletion Documentation/git-clone.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 3 additions & 1 deletion Documentation/git-commit.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
3 changes: 1 addition & 2 deletions Documentation/git-cvsexportcommit.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions Documentation/git-cvsimport.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion Documentation/git-daemon.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
4 changes: 3 additions & 1 deletion Documentation/git-diff-tree.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
6 changes: 4 additions & 2 deletions Documentation/git-format-patch.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion Documentation/git-fsck-objects.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
3 changes: 1 addition & 2 deletions Documentation/git-grep.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ git-grep - print lines matching a pattern

SYNOPSIS
--------
'git-grep' <option>... <pattern> <path>...
'git-grep' [<option>...] <pattern> [<path>...]

DESCRIPTION
-----------
Expand All @@ -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`.

Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-http-fetch.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down
23 changes: 12 additions & 11 deletions Documentation/git-rev-list.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down

0 comments on commit 353ce81

Please sign in to comment.