documentation: fix singular vs. plural
Diff best viewed with --color-diff. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
401a4e257e
commit
6cc668c0ab
|
@ -5,7 +5,7 @@ Tools for developing Git
|
||||||
[[summary]]
|
[[summary]]
|
||||||
== Summary
|
== Summary
|
||||||
|
|
||||||
This document gathers tips, scripts and configuration file to help people
|
This document gathers tips, scripts and configuration files to help people
|
||||||
working on Git's codebase use their favorite tools while following Git's
|
working on Git's codebase use their favorite tools while following Git's
|
||||||
coding style.
|
coding style.
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ advice.*::
|
||||||
the template shown when writing commit messages in
|
the template shown when writing commit messages in
|
||||||
linkgit:git-commit[1], and in the help message shown
|
linkgit:git-commit[1], and in the help message shown
|
||||||
by linkgit:git-switch[1] or
|
by linkgit:git-switch[1] or
|
||||||
linkgit:git-checkout[1] when switching branch.
|
linkgit:git-checkout[1] when switching branches.
|
||||||
statusUoption::
|
statusUoption::
|
||||||
Advise to consider using the `-u` option to linkgit:git-status[1]
|
Advise to consider using the `-u` option to linkgit:git-status[1]
|
||||||
when the command takes more than 2 seconds to enumerate untracked
|
when the command takes more than 2 seconds to enumerate untracked
|
||||||
|
|
|
@ -51,5 +51,5 @@ column.status::
|
||||||
See `column.ui` for details.
|
See `column.ui` for details.
|
||||||
|
|
||||||
column.tag::
|
column.tag::
|
||||||
Specify whether to output tag listing in `git tag` in columns.
|
Specify whether to output tag listings in `git tag` in columns.
|
||||||
See `column.ui` for details.
|
See `column.ui` for details.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
diff.autoRefreshIndex::
|
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.
|
files, do not consider stat-only changes as changed.
|
||||||
Instead, silently run `git update-index --refresh` to
|
Instead, silently run `git update-index --refresh` to
|
||||||
update the cached stat information for paths whose
|
update the cached stat information for paths whose
|
||||||
contents in the work tree match the contents in the
|
contents in the work tree match the contents in the
|
||||||
|
|
|
@ -53,7 +53,7 @@ fetch.pruneTags::
|
||||||
fetch.output::
|
fetch.output::
|
||||||
Control how ref update status is printed. Valid values are
|
Control how ref update status is printed. Valid values are
|
||||||
`full` and `compact`. Default value is `full`. See the
|
`full` and `compact`. Default value is `full`. See the
|
||||||
OUTPUT section in linkgit:git-fetch[1] for detail.
|
OUTPUT section in linkgit:git-fetch[1] for details.
|
||||||
|
|
||||||
fetch.negotiationAlgorithm::
|
fetch.negotiationAlgorithm::
|
||||||
Control how information about the commits in the local repository
|
Control how information about the commits in the local repository
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
mailinfo.scissors::
|
mailinfo.scissors::
|
||||||
If true, makes linkgit:git-mailinfo[1] (and therefore
|
If true, makes linkgit:git-mailinfo[1] (and therefore
|
||||||
linkgit:git-am[1]) act by default as if the --scissors option
|
linkgit:git-am[1]) act by default as if the --scissors option
|
||||||
was provided on the command-line. When active, this features
|
was provided on the command-line. When active, this feature
|
||||||
removes everything from the message body before a scissors
|
removes everything from the message body before a scissors
|
||||||
line (i.e. consisting mainly of ">8", "8<" and "-").
|
line (i.e. consisting mainly of ">8", "8<" and "-").
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
rerere.autoUpdate::
|
rerere.autoUpdate::
|
||||||
When set to true, `git-rerere` updates the index with the
|
When set to true, `git-rerere` updates the index with the
|
||||||
resulting contents after it cleanly resolves conflicts using
|
resulting contents after it cleanly resolves conflicts using
|
||||||
previously recorded resolution. Defaults to false.
|
previously recorded resolutions. Defaults to false.
|
||||||
|
|
||||||
rerere.enabled::
|
rerere.enabled::
|
||||||
Activate recording of resolved conflicts, so that identical
|
Activate recording of resolved conflicts, so that identical
|
||||||
|
|
|
@ -5,7 +5,7 @@ author.email::
|
||||||
committer.name::
|
committer.name::
|
||||||
committer.email::
|
committer.email::
|
||||||
The `user.name` and `user.email` variables determine what ends
|
The `user.name` and `user.email` variables determine what ends
|
||||||
up in the `author` and `committer` field of commit
|
up in the `author` and `committer` fields of commit
|
||||||
objects.
|
objects.
|
||||||
If you need the `author` or `committer` to be different, the
|
If you need the `author` or `committer` to be different, the
|
||||||
`author.name`, `author.email`, `committer.name` or
|
`author.name`, `author.email`, `committer.name` or
|
||||||
|
|
|
@ -24,9 +24,9 @@ among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
|
||||||
are listed first, followed by "v4.8", then "v4.8-ckX" and finally
|
are listed first, followed by "v4.8", then "v4.8-ckX" and finally
|
||||||
"v4.8-bfsX".
|
"v4.8-bfsX".
|
||||||
+
|
+
|
||||||
If more than one suffixes match the same tagname, then that tagname will
|
If more than one suffix matches the same tagname, then that tagname will
|
||||||
be sorted according to the suffix which starts at the earliest position in
|
be sorted according to the suffix which starts at the earliest position in
|
||||||
the tagname. If more than one different matching suffixes start at
|
the tagname. If more than one different matching suffix starts at
|
||||||
that earliest position, then that tagname will be sorted according to the
|
that earliest position, then that tagname will be sorted according to the
|
||||||
longest of those suffixes.
|
longest of those suffixes.
|
||||||
The sorting order between different suffixes is undefined if they are
|
The sorting order between different suffixes is undefined if they are
|
||||||
|
|
|
@ -142,7 +142,7 @@ or like this (when the `--cc` option is used):
|
||||||
+
|
+
|
||||||
The `mode <mode>,<mode>..<mode>` line appears only if at least one of
|
The `mode <mode>,<mode>..<mode>` line appears only if at least one of
|
||||||
the <mode> is different from the rest. Extended headers with
|
the <mode> is different from the rest. Extended headers with
|
||||||
information about detected contents movement (renames and
|
information about detected content movement (renames and
|
||||||
copying detection) are designed to work with diff of two
|
copying detection) are designed to work with diff of two
|
||||||
<tree-ish> and are not used by combined diff format.
|
<tree-ish> and are not used by combined diff format.
|
||||||
|
|
||||||
|
|
|
@ -22,7 +22,7 @@ SYNOPSIS
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Splits mail messages in a mailbox into commit log message,
|
Splits mail messages in a mailbox into commit log messages,
|
||||||
authorship information and patches, and applies them to the
|
authorship information and patches, and applies them to the
|
||||||
current branch. You could think of it as a reverse operation
|
current branch. You could think of it as a reverse operation
|
||||||
of linkgit:git-format-patch[1] run on a branch with a straight
|
of linkgit:git-format-patch[1] run on a branch with a straight
|
||||||
|
|
|
@ -24,7 +24,7 @@ this documentation describes modern `--write-tree` mode.
|
||||||
Performs a merge, but does not make any new commits and does not read
|
Performs a merge, but does not make any new commits and does not read
|
||||||
from or write to either the working tree or index.
|
from or write to either the working tree or index.
|
||||||
|
|
||||||
The performed merge will use the same feature as the "real"
|
The performed merge will use the same features as the "real"
|
||||||
linkgit:git-merge[1], including:
|
linkgit:git-merge[1], including:
|
||||||
|
|
||||||
* three way content merges of individual files
|
* three way content merges of individual files
|
||||||
|
@ -253,7 +253,7 @@ Do NOT attempt to guess or make the user guess the conflict types from
|
||||||
the <<CFI,Conflicted file info>> list. The information there is
|
the <<CFI,Conflicted file info>> list. The information there is
|
||||||
insufficient to do so. For example: Rename/rename(1to2) conflicts (both
|
insufficient to do so. For example: Rename/rename(1to2) conflicts (both
|
||||||
sides renamed the same file differently) will result in three different
|
sides renamed the same file differently) will result in three different
|
||||||
file having higher order stages (but each only has one higher order
|
files having higher order stages (but each only has one higher order
|
||||||
stage), with no way (short of the <<IM,Informational messages>> section)
|
stage), with no way (short of the <<IM,Informational messages>> section)
|
||||||
to determine which three files are related. File/directory conflicts
|
to determine which three files are related. File/directory conflicts
|
||||||
also result in a file with exactly one higher order stage.
|
also result in a file with exactly one higher order stage.
|
||||||
|
@ -263,7 +263,7 @@ a file with exactly one higher order stage. In all cases, the
|
||||||
<<IM,Informational messages>> section has the necessary info, though it
|
<<IM,Informational messages>> section has the necessary info, though it
|
||||||
is not designed to be machine parseable.
|
is not designed to be machine parseable.
|
||||||
|
|
||||||
Do NOT assume that each paths from <<CFI,Conflicted file info>>, and
|
Do NOT assume that each path from <<CFI,Conflicted file info>>, and
|
||||||
the logical conflicts in the <<IM,Informational messages>> have a
|
the logical conflicts in the <<IM,Informational messages>> have a
|
||||||
one-to-one mapping, nor that there is a one-to-many mapping, nor a
|
one-to-one mapping, nor that there is a one-to-many mapping, nor a
|
||||||
many-to-one mapping. Many-to-many mappings exist, meaning that each
|
many-to-one mapping. Many-to-many mappings exist, meaning that each
|
||||||
|
|
|
@ -207,7 +207,7 @@ When `--unpacked` is specified, loose objects are implicitly included in
|
||||||
this "roll-up", without respect to their reachability. This is subject
|
this "roll-up", without respect to their reachability. This is subject
|
||||||
to change in the future. This option (implying a drastically different
|
to change in the future. This option (implying a drastically different
|
||||||
repack mode) is not guaranteed to work with all other combinations of
|
repack mode) is not guaranteed to work with all other combinations of
|
||||||
option to `git repack`.
|
options to `git repack`.
|
||||||
+
|
+
|
||||||
When writing a multi-pack bitmap, `git repack` selects the largest resulting
|
When writing a multi-pack bitmap, `git repack` selects the largest resulting
|
||||||
pack as the preferred pack for object selection by the MIDX (see
|
pack as the preferred pack for object selection by the MIDX (see
|
||||||
|
|
|
@ -111,7 +111,7 @@ OPTIONS
|
||||||
FORMATS
|
FORMATS
|
||||||
-------
|
-------
|
||||||
|
|
||||||
The following format are available:
|
The following formats are available:
|
||||||
|
|
||||||
* 'short':
|
* 'short':
|
||||||
<replaced sha1>
|
<replaced sha1>
|
||||||
|
|
|
@ -115,7 +115,7 @@ both on the local side and on the remote side are updated.
|
||||||
|
|
||||||
When one or more '<ref>' are specified explicitly (whether on the
|
When one or more '<ref>' are specified explicitly (whether on the
|
||||||
command line or via `--stdin`), it can be either a
|
command line or via `--stdin`), it can be either a
|
||||||
single pattern, or a pair of such pattern separated by a colon
|
single pattern, or a pair of such patterns separated by a colon
|
||||||
":" (this means that a ref name cannot have a colon in it). A
|
":" (this means that a ref name cannot have a colon in it). A
|
||||||
single pattern '<name>' is just shorthand for '<name>:<name>'.
|
single pattern '<name>' is just shorthand for '<name>:<name>'.
|
||||||
|
|
||||||
|
@ -130,7 +130,7 @@ name. See linkgit:git-rev-parse[1].
|
||||||
- It is an error if <src> does not match exactly one of the
|
- It is an error if <src> does not match exactly one of the
|
||||||
local refs.
|
local refs.
|
||||||
|
|
||||||
- It is an error if <dst> matches more than one remote refs.
|
- It is an error if <dst> matches more than one remote ref.
|
||||||
|
|
||||||
- If <dst> does not match any remote ref, either
|
- If <dst> does not match any remote ref, either
|
||||||
|
|
||||||
|
|
|
@ -154,7 +154,7 @@ $ git show-branch master fixes mhf
|
||||||
! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
|
! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
|
||||||
---
|
---
|
||||||
+ [mhf] Allow "+remote:local" refspec to cause --force when fetching.
|
+ [mhf] Allow "+remote:local" refspec to cause --force when fetching.
|
||||||
+ [mhf~1] Use git-octopus when pulling more than one heads.
|
+ [mhf~1] Use git-octopus when pulling more than one head.
|
||||||
+ [fixes] Introduce "reset type" flag to "git reset"
|
+ [fixes] Introduce "reset type" flag to "git reset"
|
||||||
+ [mhf~2] "git fetch --force".
|
+ [mhf~2] "git fetch --force".
|
||||||
+ [mhf~3] Use .git/remote/origin, not .git/branches/origin.
|
+ [mhf~3] Use .git/remote/origin, not .git/branches/origin.
|
||||||
|
|
|
@ -61,7 +61,7 @@ EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
`git show v1.0.0`::
|
`git show v1.0.0`::
|
||||||
Shows the tag `v1.0.0`, along with the object the tags
|
Shows the tag `v1.0.0`, along with the object the tag
|
||||||
points at.
|
points at.
|
||||||
|
|
||||||
`git show v1.0.0^{tree}`::
|
`git show v1.0.0^{tree}`::
|
||||||
|
|
|
@ -49,7 +49,7 @@ OPTIONS
|
||||||
--remove::
|
--remove::
|
||||||
If a specified file is in the index but is missing then it's
|
If a specified file is in the index but is missing then it's
|
||||||
removed.
|
removed.
|
||||||
Default behavior is to ignore removed file.
|
Default behavior is to ignore removed files.
|
||||||
|
|
||||||
--refresh::
|
--refresh::
|
||||||
Looks at the current index and checks to see if merges or
|
Looks at the current index and checks to see if merges or
|
||||||
|
@ -108,7 +108,7 @@ you will need to handle the situation manually.
|
||||||
without regard to the "assume unchanged" setting.
|
without regard to the "assume unchanged" setting.
|
||||||
|
|
||||||
--[no-]skip-worktree::
|
--[no-]skip-worktree::
|
||||||
When one of these flags is specified, the object name recorded
|
When one of these flags is specified, the object names recorded
|
||||||
for the paths are not updated. Instead, these options
|
for the paths are not updated. Instead, these options
|
||||||
set and unset the "skip-worktree" bit for the paths. See
|
set and unset the "skip-worktree" bit for the paths. See
|
||||||
section "Skip-worktree bit" below for more information.
|
section "Skip-worktree bit" below for more information.
|
||||||
|
@ -119,7 +119,7 @@ you will need to handle the situation manually.
|
||||||
the `--remove` option was specified.
|
the `--remove` option was specified.
|
||||||
|
|
||||||
--[no-]fsmonitor-valid::
|
--[no-]fsmonitor-valid::
|
||||||
When one of these flags is specified, the object name recorded
|
When one of these flags is specified, the object names recorded
|
||||||
for the paths are not updated. Instead, these options
|
for the paths are not updated. Instead, these options
|
||||||
set and unset the "fsmonitor valid" bit for the paths. See
|
set and unset the "fsmonitor valid" bit for the paths. See
|
||||||
section "File System Monitor" below for more information.
|
section "File System Monitor" below for more information.
|
||||||
|
|
|
@ -3,7 +3,7 @@ git-whatchanged(1)
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-whatchanged - Show logs with difference each commit introduces
|
git-whatchanged - Show logs with differences each commit introduces
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
|
|
|
@ -26,7 +26,7 @@ arguments. Here are the rules:
|
||||||
accept dashed options after you have already given non-option
|
accept dashed options after you have already given non-option
|
||||||
arguments (which may make the command ambiguous), but you should
|
arguments (which may make the command ambiguous), but you should
|
||||||
not rely on it (because eventually we may find a way to fix
|
not rely on it (because eventually we may find a way to fix
|
||||||
these ambiguity by enforcing the "options then args" rule).
|
these ambiguities by enforcing the "options then args" rule).
|
||||||
|
|
||||||
* Revisions come first and then paths.
|
* Revisions come first and then paths.
|
||||||
E.g. in `git diff v1.0 v2.0 arch/x86 include/asm-x86`,
|
E.g. in `git diff v1.0 v2.0 arch/x86 include/asm-x86`,
|
||||||
|
|
|
@ -230,7 +230,7 @@ like these:
|
||||||
|
|
||||||
* -B/60 (the same as above, since diffcore-break defaults to 50%).
|
* -B/60 (the same as above, since diffcore-break defaults to 50%).
|
||||||
|
|
||||||
Note that earlier implementation left a broken pair as a separate
|
Note that earlier implementation left a broken pair as separate
|
||||||
creation and deletion patches. This was an unnecessary hack and
|
creation and deletion patches. This was an unnecessary hack and
|
||||||
the latest implementation always merges all the broken pairs
|
the latest implementation always merges all the broken pairs
|
||||||
back into modifications, but the resulting patch output is
|
back into modifications, but the resulting patch output is
|
||||||
|
|
|
@ -14,7 +14,7 @@ DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
Git users can broadly be grouped into four categories for the purposes of
|
Git users can broadly be grouped into four categories for the purposes of
|
||||||
describing here a small set of useful command for everyday Git.
|
describing here a small set of useful commands for everyday Git.
|
||||||
|
|
||||||
* <<STANDALONE,Individual Developer (Standalone)>> commands are essential
|
* <<STANDALONE,Individual Developer (Standalone)>> commands are essential
|
||||||
for anybody who makes a commit, even for somebody who works alone.
|
for anybody who makes a commit, even for somebody who works alone.
|
||||||
|
|
|
@ -80,7 +80,7 @@ If it exits with non-zero status, then the working tree will not be
|
||||||
committed after applying the patch.
|
committed after applying the patch.
|
||||||
|
|
||||||
It can be used to inspect the current working tree and refuse to
|
It can be used to inspect the current working tree and refuse to
|
||||||
make a commit if it does not pass certain test.
|
make a commit if it does not pass certain tests.
|
||||||
|
|
||||||
The default 'pre-applypatch' hook, when enabled, runs the
|
The default 'pre-applypatch' hook, when enabled, runs the
|
||||||
'pre-commit' hook, if the latter is enabled.
|
'pre-commit' hook, if the latter is enabled.
|
||||||
|
@ -379,7 +379,7 @@ following example for the protocol, the letter 'S' stands for
|
||||||
S: ... ...
|
S: ... ...
|
||||||
S: flush-pkt
|
S: flush-pkt
|
||||||
|
|
||||||
# Receive result from the hook.
|
# Receive results from the hook.
|
||||||
# OK, run this command successfully.
|
# OK, run this command successfully.
|
||||||
H: PKT-LINE(ok <ref>)
|
H: PKT-LINE(ok <ref>)
|
||||||
# NO, I reject it.
|
# NO, I reject it.
|
||||||
|
|
|
@ -192,7 +192,7 @@ For example:
|
||||||
[submodule "baz"]
|
[submodule "baz"]
|
||||||
url = https://example.org/baz
|
url = https://example.org/baz
|
||||||
|
|
||||||
In the above config only the submodule 'bar' and 'baz' are active,
|
In the above config only the submodules 'bar' and 'baz' are active,
|
||||||
'bar' due to (1) and 'baz' due to (3). 'foo' is inactive because
|
'bar' due to (1) and 'baz' due to (3). 'foo' is inactive because
|
||||||
(1) takes precedence over (3)
|
(1) takes precedence over (3)
|
||||||
|
|
||||||
|
|
|
@ -162,7 +162,7 @@ information as the first tab, with a different layout.
|
||||||
| REMOTE | |
|
| REMOTE | |
|
||||||
---------------------------------------------
|
---------------------------------------------
|
||||||
....
|
....
|
||||||
Note how in the third tab definition we need to use parenthesis to make `,`
|
Note how in the third tab definition we need to use parentheses to make `,`
|
||||||
have precedence over `/`.
|
have precedence over `/`.
|
||||||
--
|
--
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
Git API Documents
|
Git API Documents
|
||||||
=================
|
=================
|
||||||
|
|
||||||
Git has grown a set of internal API over time. This collection
|
Git has grown a set of internal APIs over time. This collection
|
||||||
documents them.
|
documents them.
|
||||||
|
|
||||||
////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////
|
||||||
|
|
|
@ -190,7 +190,7 @@ In a large project where raciness avoidance cost really matters,
|
||||||
however, the initial computation of all object names in the
|
however, the initial computation of all object names in the
|
||||||
index takes more than one second, and the index file is written
|
index takes more than one second, and the index file is written
|
||||||
out after all that happens. Therefore the timestamp of the
|
out after all that happens. Therefore the timestamp of the
|
||||||
index file will be more than one seconds later than the
|
index file will be more than one second later than the
|
||||||
youngest file in the working tree. This means that in these
|
youngest file in the working tree. This means that in these
|
||||||
cases there actually will not be any racily clean entry in
|
cases there actually will not be any racily clean entry in
|
||||||
the resulting index.
|
the resulting index.
|
||||||
|
|
|
@ -96,7 +96,7 @@ The value of this key is the name of the promisor remote.
|
||||||
==== `worktreeConfig`
|
==== `worktreeConfig`
|
||||||
|
|
||||||
If set, by default "git config" reads from both "config" and
|
If set, by default "git config" reads from both "config" and
|
||||||
"config.worktree" file from GIT_DIR in that order. In
|
"config.worktree" files from GIT_DIR in that order. In
|
||||||
multiple working directory mode, "config" file is shared while
|
multiple working directory mode, "config" file is shared while
|
||||||
"config.worktree" is per-working directory (i.e., it's in
|
"config.worktree" is per-working directory (i.e., it's in
|
||||||
GIT_COMMON_DIR/worktrees/<id>/config.worktree)
|
GIT_COMMON_DIR/worktrees/<id>/config.worktree)
|
||||||
|
|
|
@ -48,7 +48,7 @@ provide a refspec on the command line. This file should have the
|
||||||
following format:
|
following format:
|
||||||
|
|
||||||
------------
|
------------
|
||||||
URL: one of the above URL format
|
URL: one of the above URL formats
|
||||||
Push: <refspec>
|
Push: <refspec>
|
||||||
Pull: <refspec>
|
Pull: <refspec>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue