diff options
| author | Stephan Beyer <s-beyer@gmx.net> | 2008-06-08 03:36:09 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-06-08 13:46:38 -0700 |
| commit | 3240240ff427fa2e26a847c7c9fd89e6a4313daa (patch) | |
| tree | a1e21579aca42b7e4d8d718050bc522961530cfa /Documentation/git-push.txt | |
| parent | bc47c29ec18164ba1f05600333457cf6f2432856 (diff) | |
| download | git-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.gz | |
Docs: Use "-l::\n--long\n" format in OPTIONS sections
The OPTIONS section of a documentation file contains a list
of the options a git command accepts.
Currently there are several variants to describe the case that
different options (almost) do the same in the OPTIONS section.
Some are:
-f, --foo::
-f|--foo::
-f | --foo::
But AsciiDoc has the special form:
-f::
--foo::
This patch applies this form to the documentation of the whole git suite,
and removes useless em-dash prevention, so \--foo becomes --foo.
Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-push.txt')
| -rw-r--r-- | Documentation/git-push.txt | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 9d8c379717..89e0049bce 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -61,11 +61,11 @@ already exists on the remote side. This is the default operation mode if no explicit refspec is found (that is neither on the command line nor in any Push line of the corresponding remotes file---see below). -\--all:: +--all:: Instead of naming each ref to push, specifies that all refs under `$GIT_DIR/refs/heads/` be pushed. -\--mirror:: +--mirror:: Instead of naming each ref to push, specifies that all refs under `$GIT_DIR/refs/heads/` and `$GIT_DIR/refs/tags/` be mirrored to the remote repository. Newly created local @@ -75,39 +75,42 @@ nor in any Push line of the corresponding remotes file---see below). if the configuration option `remote.<remote>.mirror` is set. -\--dry-run:: +--dry-run:: Do everything except actually send the updates. -\--tags:: +--tags:: All refs under `$GIT_DIR/refs/tags` are pushed, in addition to refspecs explicitly listed on the command line. -\--receive-pack=<git-receive-pack>:: +--receive-pack=<git-receive-pack>:: Path to the 'git-receive-pack' program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. -\--exec=<git-receive-pack>:: +--exec=<git-receive-pack>:: Same as \--receive-pack=<git-receive-pack>. --f, \--force:: +-f:: +--force:: Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it. This flag disables the check. This can cause the remote repository to lose commits; use it with care. -\--repo=<repo>:: +--repo=<repo>:: When no repository is specified the command defaults to "origin"; this overrides it. -\--thin, \--no-thin:: +--thin:: +--no-thin:: These options are passed to `git-send-pack`. Thin transfer spends extra cycles to minimize the number of objects to be sent and meant to be used on slower connection. --v, \--verbose:: +-v:: +--verbose:: Run verbosely. include::urls-remotes.txt[] |