Skip to content

Commit

Permalink
Documentation: spell 'git cmd' without dash throughout
Browse files Browse the repository at this point in the history
The documentation was quite inconsistent when spelling 'git cmd' if it
only refers to the program, not to some specific invocation syntax:
both 'git-cmd' and 'git cmd' spellings exist.

The current trend goes towards dashless forms, and there is precedent
in 647ac70 (git-svn.txt: stop using dash-form of commands.,
2009-07-07) to actively eliminate the dashed variants.

Replace 'git-cmd' with 'git cmd' throughout, except where git-shell,
git-cvsserver, git-upload-pack, git-receive-pack, and
git-upload-archive are concerned, because those really live in the
$PATH.
  • Loading branch information
trast committed Jan 10, 2010
1 parent ca76828 commit 0b444cd
Show file tree
Hide file tree
Showing 112 changed files with 647 additions and 647 deletions.
72 changes: 36 additions & 36 deletions Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The values following the equals sign in variable assign are all either
a string, an integer, or a boolean. Boolean values may be given as yes/no,
0/1, true/false or on/off. Case is not significant in boolean values, when
converting value to the canonical form using '--bool' type specifier;
'git-config' will ensure that the output is "true" or "false".
'git config' will ensure that the output is "true" or "false".

String values may be entirely or partially enclosed in double quotes.
You need to enclose variable values in double quotes if you want to
Expand Down Expand Up @@ -442,8 +442,8 @@ core.pager::

core.whitespace::
A comma separated list of common whitespace problems to
notice. 'git-diff' will use `color.diff.whitespace` to
highlight them, and 'git-apply --whitespace=error' will
notice. 'git diff' will use `color.diff.whitespace` to
highlight them, and 'git apply --whitespace=error' will
consider them as errors. You can prefix `-` to disable
any of them (e.g. `-trailing-space`):
+
Expand Down Expand Up @@ -503,7 +503,7 @@ This setting defaults to "refs/notes/commits", and can be overridden by
the `GIT_NOTES_REF` environment variable.

add.ignore-errors::
Tells 'git-add' to continue adding files when some files cannot be
Tells 'git add' to continue adding files when some files cannot be
added due to indexing errors. Equivalent to the '--ignore-errors'
option of linkgit:git-add[1].

Expand All @@ -525,19 +525,19 @@ executed from the top-level directory of a repository, which may
not necessarily be the current directory.

apply.ignorewhitespace::
When set to 'change', tells 'git-apply' to ignore changes in
When set to 'change', tells 'git apply' to ignore changes in
whitespace, in the same way as the '--ignore-space-change'
option.
When set to one of: no, none, never, false tells 'git-apply' to
When set to one of: no, none, never, false tells 'git apply' to
respect all whitespace differences.
See linkgit:git-apply[1].

apply.whitespace::
Tells 'git-apply' how to handle whitespaces, in the same way
Tells 'git apply' how to handle whitespaces, in the same way
as the '--whitespace' option. See linkgit:git-apply[1].

branch.autosetupmerge::
Tells 'git-branch' and 'git-checkout' to setup new branches
Tells 'git branch' and 'git checkout' to setup new branches
so that linkgit:git-pull[1] will appropriately merge from the
starting point branch. Note that even if this option is not set,
this behavior can be chosen per-branch using the `--track`
Expand All @@ -548,7 +548,7 @@ branch.autosetupmerge::
branch. This option defaults to true.

branch.autosetuprebase::
When a new branch is created with 'git-branch' or 'git-checkout'
When a new branch is created with 'git branch' or 'git checkout'
that tracks another branch, this variable tells git to set
up pull to rebase instead of merge (see "branch.<name>.rebase").
When `never`, rebase is never automatically set to true.
Expand All @@ -563,24 +563,24 @@ branch.autosetuprebase::
This option defaults to never.

branch.<name>.remote::
When in branch <name>, it tells 'git-fetch' and 'git-push' which
When in branch <name>, it tells 'git fetch' and 'git push' which
remote to fetch from/push to. It defaults to `origin` if no remote is
configured. `origin` is also used if you are not on any branch.

branch.<name>.merge::
Defines, together with branch.<name>.remote, the upstream branch
for the given branch. It tells 'git-fetch'/'git-pull' which
branch to merge and can also affect 'git-push' (see push.default).
When in branch <name>, it tells 'git-fetch' the default
for the given branch. It tells 'git fetch'/'git pull' which
branch to merge and can also affect 'git push' (see push.default).
When in branch <name>, it tells 'git fetch' the default
refspec to be marked for merging in FETCH_HEAD. The value is
handled like the remote part of a refspec, and must match a
ref which is fetched from the remote given by
"branch.<name>.remote".
The merge information is used by 'git-pull' (which at first calls
'git-fetch') to lookup the default branch for merging. Without
this option, 'git-pull' defaults to merge the first refspec fetched.
The merge information is used by 'git pull' (which at first calls
'git fetch') to lookup the default branch for merging. Without
this option, 'git pull' defaults to merge the first refspec fetched.
Specify multiple values to get an octopus merge.
If you wish to setup 'git-pull' so that it merges into <name> from
If you wish to setup 'git pull' so that it merges into <name> from
another branch in the local repository, you can point
branch.<name>.merge to the desired branch, and use the special setting
`.` (a period) for branch.<name>.remote.
Expand Down Expand Up @@ -673,7 +673,7 @@ color.interactive::
colors only when the output is to the terminal. Defaults to false.

color.interactive.<slot>::
Use customized color for 'git-add --interactive'
Use customized color for 'git add --interactive'
output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
four distinct types of normal output from interactive
commands. The values of these variables may be specified as
Expand Down Expand Up @@ -718,14 +718,14 @@ commit.template::
specified user's home directory.

diff.autorefreshindex::
When using 'git-diff' to compare with work tree
When using 'git diff' to compare with work tree
files, do not consider stat-only change as changed.
Instead, silently run `git update-index --refresh` to
update the cached stat information for paths whose
contents in the work tree match the contents in the
index. This option defaults to true. Note that this
affects only 'git-diff' Porcelain, and not lower level
'diff' commands, such as 'git-diff-files'.
affects only 'git diff' Porcelain, and not lower level
'diff' commands, such as 'git diff-files'.

diff.external::
If this config variable is set, diff generation is not
Expand All @@ -737,7 +737,7 @@ diff.external::
your files, you might want to use linkgit:gitattributes[5] instead.

diff.mnemonicprefix::
If set, 'git-diff' uses a prefix pair that is different from the
If set, 'git diff' uses a prefix pair that is different from the
standard "a/" and "b/" depending on what is being compared. When
this configuration is in effect, reverse diff output also swaps
the order of the prefixes:
Expand All @@ -754,7 +754,7 @@ diff.mnemonicprefix::

diff.renameLimit::
The number of files to consider when performing the copy/rename
detection; equivalent to the 'git-diff' option '-l'.
detection; equivalent to the 'git diff' option '-l'.

diff.renames::
Tells git to detect renames. If set to any boolean value, it
Expand Down Expand Up @@ -840,7 +840,7 @@ format.pretty::
linkgit:git-whatchanged[1].

format.thread::
The default threading style for 'git-format-patch'. Can be
The default threading style for 'git format-patch'. Can be
either a boolean value, `shallow` or `deep`. `shallow`
threading makes every mail a reply to the head of the series,
where the head is chosen from the cover letter, the
Expand All @@ -858,7 +858,7 @@ format.signoff::

gc.aggressiveWindow::
The window size parameter used in the delta compression
algorithm used by 'git-gc --aggressive'. This defaults
algorithm used by 'git gc --aggressive'. This defaults
to 10.

gc.auto::
Expand All @@ -875,39 +875,39 @@ gc.autopacklimit::
default value is 50. Setting this to 0 disables it.

gc.packrefs::
'git-gc' does not run `git pack-refs` in a bare repository by
'git gc' does not run `git pack-refs` in a bare repository by
default so that older dumb-transport clients can still fetch
from the repository. Setting this to `true` lets 'git-gc'
from the repository. Setting this to `true` lets 'git gc'
to run `git pack-refs`. Setting this to `false` tells
'git-gc' never to run `git pack-refs`. The default setting is
'git gc' never to run `git pack-refs`. The default setting is
`notbare`. Enable it only when you know you do not have to
support such clients. The default setting will change to `true`
at some stage, and setting this to `false` will continue to
prevent `git pack-refs` from being run from 'git-gc'.
prevent `git pack-refs` from being run from 'git gc'.

gc.pruneexpire::
When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Override the grace period with this config variable. The value
"now" may be used to disable this grace period and always prune
unreachable objects immediately.

gc.reflogexpire::
'git-reflog expire' removes reflog entries older than
'git reflog expire' removes reflog entries older than
this time; defaults to 90 days.

gc.reflogexpireunreachable::
'git-reflog expire' removes reflog entries older than
'git reflog expire' removes reflog entries older than
this time and are not reachable from the current tip;
defaults to 30 days.

gc.rerereresolved::
Records of conflicted merge you resolved earlier are
kept for this many days when 'git-rerere gc' is run.
kept for this many days when 'git rerere gc' is run.
The default is 60 days. See linkgit:git-rerere[1].

gc.rerereunresolved::
Records of conflicted merge you have not resolved are
kept for this many days when 'git-rerere gc' is run.
kept for this many days when 'git rerere gc' is run.
The default is 15 days. See linkgit:git-rerere[1].

gitcvs.commitmsgannotation::
Expand Down Expand Up @@ -1168,7 +1168,7 @@ i18n.commitEncoding::

i18n.logOutputEncoding::
Character encoding the commit messages are converted to when
running 'git-log' and friends.
running 'git log' and friends.

imap::
The configuration variables in the 'imap' section are described
Expand Down Expand Up @@ -1202,7 +1202,7 @@ interactive.singlekey::

log.date::
Set default date-time mode for the log command. Setting log.date
value is similar to using 'git-log'\'s --date option. The value is one of the
value is similar to using 'git log'\'s --date option. The value is one of the
following alternatives: {relative,local,default,iso,rfc,short}.
See linkgit:git-log[1].

Expand Down
10 changes: 5 additions & 5 deletions Documentation/fetch-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ endif::git-pull[]

-f::
--force::
When 'git-fetch' is used with `<rbranch>:<lbranch>`
When 'git fetch' is used with `<rbranch>:<lbranch>`
refspec, it refuses to update the local branch
`<lbranch>` unless the remote branch `<rbranch>` it
fetches is a descendant of `<lbranch>`. This option
Expand Down Expand Up @@ -61,16 +61,16 @@ endif::git-pull[]

-u::
--update-head-ok::
By default 'git-fetch' refuses to update the head which
By default 'git fetch' refuses to update the head which
corresponds to the current branch. This flag disables the
check. This is purely for the internal use for 'git-pull'
to communicate with 'git-fetch', and unless you are
check. This is purely for the internal use for 'git pull'
to communicate with 'git fetch', and unless you are
implementing your own Porcelain you are not supposed to
use it.

--upload-pack <upload-pack>::
When given, and the repository to fetch from is handled
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
by 'git fetch-pack', '--exec=<upload-pack>' is passed to
the command to specify non-default path for the command
run on the other end.

Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-am.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ OPTIONS

-k::
--keep::
Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).

-c::
--scissors::
Expand All @@ -53,7 +53,7 @@ OPTIONS

-u::
--utf8::
Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
`i18n.commitencoding` can be used to specify project's
Expand All @@ -63,7 +63,7 @@ This was optional in prior versions of git, but now it is the
default. You can use `--no-utf8` to override this.

--no-utf8::
Pass `-n` flag to 'git-mailinfo' (see
Pass `-n` flag to 'git mailinfo' (see
linkgit:git-mailinfo[1]).

-3::
Expand All @@ -81,7 +81,7 @@ default. You can use `--no-utf8` to override this.
-p<n>::
--directory=<dir>::
--reject::
These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
program that applies
the patch.

Expand Down Expand Up @@ -121,7 +121,7 @@ default. You can use `--no-utf8` to override this.
to the screen before exiting. This overrides the
standard message informing you to use `--resolved`
or `--skip` to handle the failure. This is solely
for internal use between 'git-rebase' and 'git-am'.
for internal use between 'git rebase' and 'git am'.

--abort::
Restore the original branch and abort the patching operation.
Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-apply.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ OPTIONS
without using the working tree. This implies `--index`.

--build-fake-ancestor=<file>::
Newer 'git-diff' output has embedded 'index information'
Newer 'git diff' output has embedded 'index information'
for each blob to help identify the original version that
the patch applies to. When this flag is given, and if
the original versions of the blobs are available locally,
Expand All @@ -83,7 +83,7 @@ the information is read from the current index instead.
Apply the patch in reverse.

--reject::
For atomicity, 'git-apply' by default fails the whole patch and
For atomicity, 'git apply' by default fails the whole patch and
does not touch the working tree when some of the hunks
do not apply. This option makes it apply
the parts of the patch that are applicable, and leave the
Expand All @@ -109,7 +109,7 @@ any of those replacements occurred.
ever ignored.

--unidiff-zero::
By default, 'git-apply' expects that the patch being
By default, 'git apply' expects that the patch being
applied is a unified diff with at least one line of context.
This provides good safety measures, but breaks down when
applying a diff generated with `--unified=0`. To bypass these
Expand All @@ -120,7 +120,7 @@ discouraged.

--apply::
If you use any of the options marked "Turns off
'apply'" above, 'git-apply' reads and outputs the
'apply'" above, 'git apply' reads and outputs the
requested information without actually applying the
patch. Give this flag after those flags to also apply
the patch.
Expand Down Expand Up @@ -229,7 +229,7 @@ apply.whitespace::

Submodules
----------
If the patch contains any changes to submodules then 'git-apply'
If the patch contains any changes to submodules then 'git apply'
treats these changes as follows.

If `--index` is specified (explicitly or implicitly), then the submodule
Expand Down
12 changes: 6 additions & 6 deletions Documentation/git-archimport.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ branches that have different roots, it will refuse to run. In that case,
edit your <archive/branch> parameters to define clearly the scope of the
import.

'git-archimport' uses `tla` extensively in the background to access the
'git archimport' uses `tla` extensively in the background to access the
Arch repository.
Make sure you have a recent version of `tla` available in the path. `tla` must
know about the repositories you pass to 'git-archimport'.
know about the repositories you pass to 'git archimport'.

For the initial import, 'git-archimport' expects to find itself in an empty
For the initial import, 'git archimport' expects to find itself in an empty
directory. To follow the development of a project that uses Arch, rerun
'git-archimport' with the same parameters as the initial import to perform
'git archimport' with the same parameters as the initial import to perform
incremental imports.

While 'git-archimport' will try to create sensible branch names for the
While 'git archimport' will try to create sensible branch names for the
archives that it imports, it is also possible to specify git branch names
manually. To do so, write a git branch name after each <archive/branch>
parameter, separated by a colon. This way, you can shorten the Arch
Expand Down Expand Up @@ -84,7 +84,7 @@ OPTIONS

-o::
Use this for compatibility with old-style branch names used by
earlier versions of 'git-archimport'. Old-style branch names
earlier versions of 'git archimport'. Old-style branch names
were category--branch, whereas new-style branch names are
archive,category--branch--version. In both cases, names given
on the command-line will override the automatically-generated
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-archive.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ structure for the named tree, and writes it out to the standard
output. If <prefix> is specified it is
prepended to the filenames in the archive.

'git-archive' behaves differently when given a tree ID versus when
'git archive' behaves differently when given a tree ID versus when
given a commit ID or tag ID. In the first case the current time is
used as the modification time of each file in the archive. In the latter
case the commit time as recorded in the referenced commit object is
used instead. Additionally the commit ID is stored in a global
extended pax header if the tar format is used; it can be extracted
using 'git-get-tar-commit-id'. In ZIP files it is stored as a file
using 'git get-tar-commit-id'. In ZIP files it is stored as a file
comment.

OPTIONS
Expand Down
Loading

0 comments on commit 0b444cd

Please sign in to comment.