Merge branch 'mz/doc-synopsis-verse' into maint

* mz/doc-synopsis-verse:
  Documentation: use [verse] for SYNOPSIS sections
This commit is contained in:
Junio C Hamano 2011-08-16 11:41:26 -07:00
commit 412403eb45
93 changed files with 92 additions and 6 deletions

View file

@ -7,6 +7,7 @@ git-annotate - Annotate file lines with commit information
SYNOPSIS
--------
[verse]
'git annotate' [options] file [revision]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-bisect - Find by binary search the change that introduced a bug
SYNOPSIS
--------
[verse]
'git bisect' <subcommand> <options>
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
SYNOPSIS
--------
[verse]
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-cherry - Find commits not merged upstream
SYNOPSIS
--------
[verse]
'git cherry' [-v] [<upstream> [<head> [<limit>]]]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-citool - Graphical alternative to git-commit
SYNOPSIS
--------
[verse]
'git citool'
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-commit-tree - Create a new commit object
SYNOPSIS
--------
[verse]
'git commit-tree' <tree> [(-p <parent commit>)...] < changelog
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-count-objects - Count unpacked number of objects and their disk consumption
SYNOPSIS
--------
[verse]
'git count-objects' [-v]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
SYNOPSIS
--------
[verse]
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID

View file

@ -8,6 +8,7 @@ git-diff-files - Compares files in the working tree and the index
SYNOPSIS
--------
[verse]
'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-diff-index - Compares content and mode of blobs between the index and reposi
SYNOPSIS
--------
[verse]
'git diff-index' [-m] [--cached] [<common diff options>] <tree-ish> [<path>...]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-difftool - Show changes using common diff tools
SYNOPSIS
--------
[verse]
'git difftool' [<options>] [<commit> [<commit>]] [--] [<path>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-fast-export - Git data exporter
SYNOPSIS
--------
[verse]
'git fast-export [options]' | 'git fast-import'
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-fast-import - Backend for fast Git data importers
SYNOPSIS
--------
[verse]
frontend | 'git fast-import' [options]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-fetch-pack - Receive missing objects from another repository
SYNOPSIS
--------
[verse]
'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag] [--upload-pack=<git-upload-pack>] [--depth=<n>] [--no-progress] [-v] [<host>:]<directory> [<refs>...]
DESCRIPTION

View file

@ -8,12 +8,10 @@ git-fetch - Download objects and refs from another repository
SYNOPSIS
--------
[verse]
'git fetch' [<options>] [<repository> [<refspec>...]]
'git fetch' [<options>] <group>
'git fetch' --multiple [<options>] [(<repository> | <group>)...]
'git fetch' --all [<options>]

View file

@ -8,6 +8,7 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the
SYNOPSIS
--------
[verse]
'git fsck-objects' ...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository
SYNOPSIS
--------
[verse]
'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-get-tar-commit-id - Extract commit ID from an archive created using git-arch
SYNOPSIS
--------
[verse]
'git get-tar-commit-id' < <tarfile>

View file

@ -7,6 +7,7 @@ git-gui - A portable graphical interface to Git
SYNOPSIS
--------
[verse]
'git gui' [<command>] [arguments]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-help - display help information about git
SYNOPSIS
--------
[verse]
'git help' [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-http-fetch - Download from a remote git repository via HTTP
SYNOPSIS
--------
[verse]
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin] <commit> <url>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
SYNOPSIS
--------
[verse]
'git http-push' [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
SYNOPSIS
--------
[verse]
'git imap-send'

View file

@ -8,6 +8,7 @@ git-init-db - Creates an empty git repository
SYNOPSIS
--------
[verse]
'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]

View file

@ -8,6 +8,7 @@ git-init - Create an empty git repository or reinitialize an existing one
SYNOPSIS
--------
[verse]
'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
[--separate-git-dir <git dir>]
[--shared[=<permissions>]] [directory]

View file

@ -8,6 +8,7 @@ git-log - Show commit logs
SYNOPSIS
--------
[verse]
'git log' [<options>] [<since>..<until>] [[\--] <path>...]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-lost-found - Recover lost refs that luckily have not yet been pruned
SYNOPSIS
--------
[verse]
'git lost-found'
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
SYNOPSIS
--------
[verse]
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>

View file

@ -7,6 +7,7 @@ git-mailsplit - Simple UNIX mbox splitter program
SYNOPSIS
--------
[verse]
'git mailsplit' [-b] [-f<nn>] [-d<prec>] [--keep-cr] -o<directory> [--] [(<mbox>|<Maildir>)...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-merge-index - Run a merge for files needing merging
SYNOPSIS
--------
[verse]
'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>*)
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-merge-one-file - The standard helper program to use with git-merge-index
SYNOPSIS
--------
[verse]
'git merge-one-file'
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-merge-tree - Show three-way merge without touching index
SYNOPSIS
--------
[verse]
'git merge-tree' <base-tree> <branch1> <branch2>
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-mergetool--lib - Common git merge tool shell scriptlets
SYNOPSIS
--------
[verse]
'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool--lib"'
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
SYNOPSIS
--------
[verse]
'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-mktag - Creates a tag object
SYNOPSIS
--------
[verse]
'git mktag' < signature_file
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-mktree - Build a tree-object from ls-tree formatted text
SYNOPSIS
--------
[verse]
'git mktree' [-z] [--missing] [--batch]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS
--------
[verse]
'git mv' <options>... <args>...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-pack-redundant - Find redundant pack files
SYNOPSIS
--------
[verse]
'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-pack-refs - Pack heads and tags for efficient repository access
SYNOPSIS
--------
[verse]
'git pack-refs' [--all] [--no-prune]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-parse-remote - Routines to help parsing remote repository access parameters
SYNOPSIS
--------
[verse]
'. "$(git --exec-path)/git-parse-remote"'
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-patch-id - Compute unique ID for a patch
SYNOPSIS
--------
[verse]
'git patch-id' < <patch>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-peek-remote - List the references in a remote repository
SYNOPSIS
--------
[verse]
'git peek-remote' [--upload-pack=<git-upload-pack>] [<host>:]<directory>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-prune-packed - Remove extra objects that are already in pack files
SYNOPSIS
--------
[verse]
'git prune-packed' [-n|--dry-run] [-q|--quiet]

View file

@ -8,6 +8,7 @@ git-prune - Prune all unreachable objects from the object database
SYNOPSIS
--------
[verse]
'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-pull - Fetch from and merge with another repository or a local branch
SYNOPSIS
--------
[verse]
'git pull' [options] [<repository> [<refspec>...]]

View file

@ -8,6 +8,7 @@ git-read-tree - Reads tree information into the index
SYNOPSIS
--------
[verse]
'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
[-u [--exclude-per-directory=<gitignore>] | -i]]
[--index-output=<file>] [--no-sparse-checkout]

View file

@ -12,7 +12,6 @@ SYNOPSIS
[<upstream>] [<branch>]
'git rebase' [-i | --interactive] [options] --onto <newbase>
--root [<branch>]
'git rebase' --continue | --skip | --abort
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS
--------
[verse]
'git-receive-pack' <directory>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-reflog - Manage reflog information
SYNOPSIS
--------
[verse]
'git reflog' <subcommand> <options>
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-relink - Hardlink common objects in local repositories
SYNOPSIS
--------
[verse]
'git relink' [--safe] <dir>... <master_dir>
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-remote-ext - Bridge smart transport to external command.
SYNOPSIS
--------
[verse]
git remote add <nick> "ext::<command>[ <arguments>...]"
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-remote-helpers - Helper programs to interact with remote repositories
SYNOPSIS
--------
[verse]
'git remote-<transport>' <repository> [<URL>]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-repack - Pack unpacked objects in a repository
SYNOPSIS
--------
[verse]
'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [--window=<n>] [--depth=<n>]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-repo-config - Get and set repository or global options
SYNOPSIS
--------
[verse]
'git repo-config' ...

View file

@ -7,6 +7,7 @@ git-request-pull - Generates a summary of pending changes
SYNOPSIS
--------
[verse]
'git request-pull' [-p] <start> <url> [<end>]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges
SYNOPSIS
--------
[verse]
'git rerere' ['clear'|'forget' <pathspec>|'diff'|'status'|'gc']
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-rev-parse - Pick out and massage parameters
SYNOPSIS
--------
[verse]
'git rev-parse' [ --option ] <args>...
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-revert - Revert some existing commits
SYNOPSIS
--------
[verse]
'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-rm - Remove files from the working tree and from the index
SYNOPSIS
--------
[verse]
'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-send-email - Send a collection of patches as emails
SYNOPSIS
--------
[verse]
'git send-email' [options] <file|directory|rev-list options>...

View file

@ -8,6 +8,7 @@ git-send-pack - Push objects over git protocol to another repository
SYNOPSIS
--------
[verse]
'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-sh-i18n - Git's i18n setup code for shell scripts
SYNOPSIS
--------
[verse]
'. "$(git --exec-path)/git-sh-i18n"'
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-sh-setup - Common git shell script setup code
SYNOPSIS
--------
[verse]
'. "$(git --exec-path)/git-sh-setup"'
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-shell - Restricted login shell for Git-only SSH access
SYNOPSIS
--------
[verse]
'git shell' [-c <command> <argument>]
DESCRIPTION

View file

@ -13,7 +13,6 @@ SYNOPSIS
[--more=<n> | --list | --independent | --merge-base]
[--no-name | --sha1-name] [--topics]
[(<rev> | <glob>)...]
'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-show-index - Show packed archive index
SYNOPSIS
--------
[verse]
'git show-index' < idx-file

View file

@ -8,6 +8,7 @@ git-show - Show various types of objects
SYNOPSIS
--------
[verse]
'git show' [options] <object>...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-status - Show the working tree status
SYNOPSIS
--------
[verse]
'git status' [<options>...] [--] [<pathspec>...]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-stripspace - Filter out empty lines
SYNOPSIS
--------
[verse]
'git stripspace' [-s | --strip-comments] < <stream>
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-svn - Bidirectional operation between a Subversion repository and git
SYNOPSIS
--------
[verse]
'git svn' <command> [options] [arguments]
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-symbolic-ref - Read and modify symbolic refs
SYNOPSIS
--------
[verse]
'git symbolic-ref' [-q] [-m <reason>] <name> [<ref>]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-tar-tree - Create a tar archive of the files in the named tree object
SYNOPSIS
--------
[verse]
'git tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
DESCRIPTION

View file

@ -9,6 +9,7 @@ git-unpack-file - Creates a temporary file with a blob's contents
SYNOPSIS
--------
[verse]
'git unpack-file' <blob>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-unpack-objects - Unpack objects from a packed archive
SYNOPSIS
--------
[verse]
'git unpack-objects' [-n] [-q] [-r] [--strict] <pack-file

View file

@ -7,6 +7,7 @@ git-update-ref - Update the object name stored in a ref safely
SYNOPSIS
--------
[verse]
'git update-ref' [-m <reason>] (-d <ref> [<oldvalue>] | [--no-deref] <ref> <newvalue> [<oldvalue>])
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-update-server-info - Update auxiliary info file to help dumb servers
SYNOPSIS
--------
[verse]
'git update-server-info' [--force]
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-upload-archive - Send archive back to git-archive
SYNOPSIS
--------
[verse]
'git upload-archive' <directory>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-upload-pack - Send objects packed back to git-fetch-pack
SYNOPSIS
--------
[verse]
'git-upload-pack' [--strict] [--timeout=<n>] <directory>
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-var - Show a git logical variable
SYNOPSIS
--------
[verse]
'git var' ( -l | <variable> )
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-verify-pack - Validate packed git archive files
SYNOPSIS
--------
[verse]
'git verify-pack' [-v|--verbose] [-s|--stat-only] [--] <pack>.idx ...

View file

@ -7,6 +7,7 @@ git-verify-tag - Check the GPG signature of tags
SYNOPSIS
--------
[verse]
'git verify-tag' <tag>...
DESCRIPTION

View file

@ -7,6 +7,7 @@ git-web--browse - git helper script to launch a web browser
SYNOPSIS
--------
[verse]
'git web{litdd}browse' [OPTIONS] URL/FILE ...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-whatchanged - Show logs with difference each commit introduces
SYNOPSIS
--------
[verse]
'git whatchanged' <option>...
DESCRIPTION

View file

@ -8,6 +8,7 @@ git-write-tree - Create a tree object from the current index
SYNOPSIS
--------
[verse]
'git write-tree' [--missing-ok] [--prefix=<prefix>/]
DESCRIPTION

View file

@ -7,7 +7,8 @@ gitcvs-migration - git for CVS users
SYNOPSIS
--------
git cvsimport *
[verse]
'git cvsimport' *
DESCRIPTION
-----------

View file

@ -7,6 +7,7 @@ gitdiffcore - Tweaking diff output
SYNOPSIS
--------
[verse]
'git diff' *
DESCRIPTION

View file

@ -7,6 +7,7 @@ gitk - The git repository browser
SYNOPSIS
--------
[verse]
'gitk' [<option>...] [<revs>] [--] [<path>...]
DESCRIPTION

View file

@ -7,6 +7,7 @@ gittutorial-2 - A tutorial introduction to git: part two
SYNOPSIS
--------
[verse]
git *
DESCRIPTION

View file

@ -7,6 +7,7 @@ gittutorial - A tutorial introduction to git (for version 1.5.1 or newer)
SYNOPSIS
--------
[verse]
git *
DESCRIPTION

View file

@ -7,6 +7,7 @@ gitworkflows - An overview of recommended workflows with git
SYNOPSIS
--------
[verse]
git *

View file

@ -8,6 +8,7 @@ git-convert-objects - Converts old-style git repository
SYNOPSIS
--------
[verse]
'git-convert-objects'
DESCRIPTION

View file

@ -7,6 +7,7 @@ gitview - A GTK based repository browser for git
SYNOPSIS
--------
[verse]
'gitview' [options] [args]
DESCRIPTION

View file

@ -7,6 +7,7 @@ svn-fe - convert an SVN "dumpfile" to a fast-import stream
SYNOPSIS
--------
[verse]
svnadmin dump --incremental REPO | svn-fe [url] | git fast-import
DESCRIPTION