documentation: add missing article
Diff best viewed with --color-diff. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Elijah Newren committed
Oct 8, 2023 at 06:45 UTC
0a4f051f9318c3dd9db69c4bebecdc6d160a5fc6
57 files changed
+93
-93
Documentation/ReviewingGuidelines.txt
+1
-1
@@ -19,7 +19,7 @@ Principles
19
Selecting patch(es) to review
20
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21
If you are looking for a patch series in need of review, start by checking
22
-latest "What's cooking in git.git" email
22
+the latest "What's cooking in git.git" email
23
(https://lore.kernel.org/git/xmqqilm1yp3m.fsf@gitster.g/[example]). The "What's
24
cooking" emails & replies can be found using the query `s:"What's cooking"` on
25
the https://lore.kernel.org/git/[`lore.kernel.org` mailing list archive];
Documentation/config/advice.txt
+1
-1
@@ -5,7 +5,7 @@ advice.*::
5
+
6
--
7
ambiguousFetchRefspec::
8
- Advice shown when fetch refspec for multiple remotes maps to
8
+ Advice shown when a fetch refspec for multiple remotes maps to
9
the same remote-tracking branch namespace and causes branch
10
tracking set-up to fail.
11
fetchShowForcedUpdates::
Documentation/config/commit.txt
+1
-1
@@ -2,7 +2,7 @@ commit.cleanup::
2
This setting overrides the default of the `--cleanup` option in
3
`git commit`. See linkgit:git-commit[1] for details. Changing the
4
default can be useful when you always want to keep lines that begin
5
- with comment character `#` in your log message, in which case you
5
+ with the comment character `#` in your log message, in which case you
6
would do `git config commit.cleanup whitespace` (note that you will
7
have to remove the help lines that begin with `#` in the commit log
8
template yourself, if you do this).
Documentation/config/fsck.txt
+1
-1
@@ -36,7 +36,7 @@ Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
36
doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
37
will only cause git to warn.
38
+
39
-See `Fsck Messages` section of linkgit:git-fsck[1] for supported
39
+See the `Fsck Messages` section of linkgit:git-fsck[1] for supported
40
values of `<msg-id>`.
41
42
Documentation/config/gc.txt
+1
-1
@@ -39,7 +39,7 @@ See the `gc.bigPackThreshold` configuration variable below. When in
39
use, it'll affect how the auto pack limit works.
40
41
gc.autoDetach::
42
- Make `git gc --auto` return immediately and run in background
42
+ Make `git gc --auto` return immediately and run in the background
43
if the system supports it. Default is true.
44
45
gc.bigPackThreshold::
Documentation/config/gui.txt
+1
-1
@@ -24,7 +24,7 @@ gui.matchTrackingBranch::
24
not. Default: "false".
25
26
gui.newBranchTemplate::
27
- Is used as suggested name when creating new branches using the
27
+ Is used as a suggested name when creating new branches using the
28
linkgit:git-gui[1].
29
30
gui.pruneDuringFetch::
Documentation/config/man.txt
+1
-1
@@ -5,7 +5,7 @@ man.viewer::
5
man.<tool>.cmd::
6
Specify the command to invoke the specified man viewer. The
7
specified command is evaluated in shell with the man page
8
- passed as argument. (See linkgit:git-help[1].)
8
+ passed as an argument. (See linkgit:git-help[1].)
9
10
man.<tool>.path::
11
Override the path for the given tool that may be used to
Documentation/config/notes.txt
+1
-1
@@ -1,7 +1,7 @@
1
notes.mergeStrategy::
2
Which merge strategy to choose by default when resolving notes
3
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
4
- `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
4
+ `cat_sort_uniq`. Defaults to `manual`. See the "NOTES MERGE STRATEGIES"
5
section of linkgit:git-notes[1] for more information on each strategy.
6
+
7
This setting can be overridden by passing the `--strategy` option to
Documentation/config/sendemail.txt
+1
-1
@@ -91,7 +91,7 @@ sendemail.smtpBatchSize::
91
See also the `--batch-size` option of linkgit:git-send-email[1].
92
93
sendemail.smtpReloginDelay::
94
- Seconds to wait before reconnecting to smtp server.
94
+ Seconds to wait before reconnecting to the smtp server.
95
See also the `--relogin-delay` option of linkgit:git-send-email[1].
96
97
sendemail.forbidSendmailVariables::
Documentation/config/stash.txt
+4
-4
@@ -1,14 +1,14 @@
1
stash.showIncludeUntracked::
2
If this is set to true, the `git stash show` command will show
3
the untracked files of a stash entry. Defaults to false. See
4
- description of 'show' command in linkgit:git-stash[1].
4
+ the description of the 'show' command in linkgit:git-stash[1].
5
6
stash.showPatch::
7
If this is set to true, the `git stash show` command without an
8
option will show the stash entry in patch form. Defaults to false.
9
- See description of 'show' command in linkgit:git-stash[1].
9
+ See the description of the 'show' command in linkgit:git-stash[1].
10
11
stash.showStat::
12
If this is set to true, the `git stash show` command without an
13
- option will show diffstat of the stash entry. Defaults to true.
14
- See description of 'show' command in linkgit:git-stash[1].
13
+ option will show a diffstat of the stash entry. Defaults to true.
14
+ See the description of the 'show' command in linkgit:git-stash[1].
Documentation/diff-generate-patch.txt
+5
-5
@@ -25,9 +25,9 @@ The `a/` and `b/` filenames are the same unless rename/copy is
25
involved. Especially, even for a creation or a deletion,
26
`/dev/null` is _not_ used in place of the `a/` or `b/` filenames.
27
+
28
-When rename/copy is involved, `file1` and `file2` show the
28
+When a rename/copy is involved, `file1` and `file2` show the
29
name of the source file of the rename/copy and the name of
30
-the file that rename/copy produces, respectively.
30
+the file that the rename/copy produces, respectively.
31
32
2. It is followed by one or more extended header lines:
33
@@ -89,7 +89,7 @@ produce a 'combined diff' when showing a merge. This is the default
89
format when showing merges with linkgit:git-diff[1] or
90
linkgit:git-show[1]. Note also that you can give suitable
91
`--diff-merges` option to any of these commands to force generation of
92
-diffs in specific format.
92
+diffs in a specific format.
93
94
A "combined diff" format looks like this:
95
@@ -143,7 +143,7 @@ or like this (when the `--cc` option is used):
143
The `mode <mode>,<mode>..<mode>` line appears only if at least one of
144
the <mode> is different from the rest. Extended headers with
145
information about detected content movement (renames and
146
-copying detection) are designed to work with diff of two
146
+copying detection) are designed to work with the diff of two
147
<tree-ish> and are not used by combined diff format.
148
149
3. It is followed by a two-line from-file/to-file header:
@@ -151,7 +151,7 @@ copying detection) are designed to work with diff of two
151
--- a/file
152
+++ b/file
153
+
154
-Similar to two-line header for traditional 'unified' diff
154
+Similar to the two-line header for the traditional 'unified' diff
155
format, `/dev/null` is used to signal created or deleted
156
files.
157
+
Documentation/fsck-msgids.txt
+1
-1
@@ -132,7 +132,7 @@
132
(ERROR) Missing space before date in an author/committer line.
133
134
`missingSpaceBeforeEmail`::
135
- (ERROR) Missing space before the email in author/committer line.
135
+ (ERROR) Missing space before the email in an author/committer line.
136
137
`missingTag`::
138
(ERROR) Unexpected end after `type` line in a tag object.
Documentation/git-am.txt
+2
-2
@@ -94,7 +94,7 @@ OPTIONS
94
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
95
The proposed commit log message taken from the e-mail
96
is re-coded into UTF-8 encoding (configuration variable
97
- `i18n.commitEncoding` can be used to specify project's
97
+ `i18n.commitEncoding` can be used to specify the project's
98
preferred encoding if it is not UTF-8).
99
+
100
This was optional in prior versions of git, but now it is the
@@ -192,7 +192,7 @@ include::rerere-options.txt[]
192
193
--abort::
194
Restore the original branch and abort the patching operation.
195
- Revert contents of files involved in the am operation to their
195
+ Revert the contents of files involved in the am operation to their
196
pre-am state.
197
198
--quit::
Documentation/git-apply.txt
+2
-2
@@ -140,7 +140,7 @@ linkgit:git-config[1]).
140
applying a diff generated with `--unified=0`. To bypass these
141
checks use `--unidiff-zero`.
142
+
143
-Note, for the reasons stated above usage of context-free patches is
143
+Note, for the reasons stated above the usage of context-free patches is
144
discouraged.
145
146
--apply::
@@ -257,7 +257,7 @@ the `--unsafe-paths` option to override this safety check. This option
257
has no effect when `--index` or `--cached` is in use.
258
259
--allow-empty::
260
- Don't return error for patches containing no diff. This includes
260
+ Don't return an error for patches containing no diff. This includes
261
empty patches and patches with commit text only.
262
263
CONFIGURATION
Documentation/git-blame.txt
+2
-2
@@ -77,7 +77,7 @@ include::blame-options.txt[]
77
78
-e::
79
--show-email::
80
- Show the author email instead of author name (Default: off).
80
+ Show the author email instead of the author name (Default: off).
81
This can also be controlled via the `blame.showEmail` config
82
option.
83
@@ -100,7 +100,7 @@ When neither `--porcelain` nor `--incremental` option is specified,
100
`git blame` will output annotation for each line with:
101
102
- abbreviated object name for the commit the line came from;
103
-- author ident (by default author name and date, unless `-s` or `-e`
103
+- author ident (by default the author name and date, unless `-s` or `-e`
104
is specified); and
105
- line number
106
Documentation/git-check-ref-format.txt
+1
-1
@@ -85,7 +85,7 @@ The rule `git check-ref-format --branch $name` implements
85
may be stricter than what `git check-ref-format refs/heads/$name`
86
says (e.g. a dash may appear at the beginning of a ref component,
87
but it is explicitly forbidden at the beginning of a branch name).
88
-When run with `--branch` option in a repository, the input is first
88
+When run with the `--branch` option in a repository, the input is first
89
expanded for the ``previous checkout syntax''
90
`@{-n}`. For example, `@{-1}` is a way to refer the last thing that
91
was checked out using "git switch" or "git checkout" operation.
Documentation/git-checkout-index.txt
+3
-3
@@ -53,7 +53,7 @@ OPTIONS
53
54
--stage=<number>|all::
55
Instead of checking out unmerged entries, copy out the
56
- files from named stage. <number> must be between 1 and 3.
56
+ files from the named stage. <number> must be between 1 and 3.
57
Note: --stage=all automatically implies --temp.
58
59
--temp::
@@ -66,8 +66,8 @@ OPTIONS
66
set.
67
68
--stdin::
69
- Instead of taking list of paths from the command line,
70
- read list of paths from the standard input. Paths are
69
+ Instead of taking a list of paths from the command line,
70
+ read the list of paths from the standard input. Paths are
71
separated by LF (i.e. one path per line) by default.
72
73
-z::
Documentation/git-count-objects.txt
+1
-1
@@ -33,7 +33,7 @@ size-pack: disk space consumed by the packs, in KiB (unless -H is specified)
33
prune-packable: the number of loose objects that are also present in
34
the packs. These objects could be pruned using `git prune-packed`.
35
+
36
-garbage: the number of files in object database that are neither valid loose
36
+garbage: the number of files in the object database that are neither valid loose
37
objects nor valid packs
38
+
39
size-garbage: disk space consumed by garbage files, in KiB (unless -H is
Documentation/git-daemon.txt
+1
-1
@@ -138,7 +138,7 @@ otherwise `stderr`.
138
--user-path::
139
--user-path=<path>::
140
Allow {tilde}user notation to be used in requests. When
141
- specified with no parameter, requests to
141
+ specified with no parameter, a request to
142
git://host/{tilde}alice/foo is taken as a request to access
143
'foo' repository in the home directory of user `alice`.
144
If `--user-path=path` is specified, the same request is
Documentation/git-diff-tree.txt
+1
-1
@@ -78,7 +78,7 @@ commits (but not trees).
78
By default, 'git diff-tree --stdin' shows differences,
79
either in machine-readable form (without `-p`) or in patch
80
form (with `-p`). This output can be suppressed. It is
81
- only useful with `-v` flag.
81
+ only useful with the `-v` flag.
82
83
-v::
84
This flag causes 'git diff-tree --stdin' to also show
Documentation/git-difftool.txt
+1
-1
@@ -36,7 +36,7 @@ OPTIONS
36
37
--rotate-to=<file>::
38
Start showing the diff for the given path,
39
- the paths before it will move to end and output.
39
+ the paths before it will move to the end and output.
40
41
--skip-to=<file>::
42
Start showing the diff for the given path, skipping all
Documentation/git-fsck.txt
+1
-1
@@ -24,7 +24,7 @@ OPTIONS
24
An object to treat as the head of an unreachability trace.
25
+
26
If no objects are given, 'git fsck' defaults to using the
27
-index file, all SHA-1 references in `refs` namespace, and all reflogs
27
+index file, all SHA-1 references in the `refs` namespace, and all reflogs
28
(unless --no-reflogs is given) as heads.
29
30
--unreachable::
Documentation/git-help.txt
+1
-1
@@ -85,7 +85,7 @@ pseudo-configuration such as the file-based `.git/hooks/*` interface
85
described in linkgit:githooks[5].
86
87
--developer-interfaces::
88
- Print list of file formats, protocols and other developer
88
+ Print a list of file formats, protocols and other developer
89
interfaces documentation on the standard output.
90
91
-i::
Documentation/git-http-push.txt
+2
-2
@@ -13,12 +13,12 @@ SYNOPSIS
13
14
DESCRIPTION
15
-----------
16
-Sends missing objects to remote repository, and updates the
16
+Sends missing objects to the remote repository, and updates the
17
remote branch.
18
19
*NOTE*: This command is temporarily disabled if your libcurl
20
is older than 7.16, as the combination has been reported
21
-not to work and sometimes corrupts repository.
21
+not to work and sometimes corrupts the repository.
22
23
OPTIONS
24
-------
Documentation/git-init.txt
+2
-2
@@ -66,10 +66,10 @@ DIRECTORY" section below.)
66
67
Instead of initializing the repository as a directory to either `$GIT_DIR` or
68
`./.git/`, create a text file there containing the path to the actual
69
-repository. This file acts as filesystem-agnostic Git symbolic link to the
69
+repository. This file acts as a filesystem-agnostic Git symbolic link to the
70
repository.
71
+
72
-If this is reinitialization, the repository will be moved to the specified path.
72
+If this is a reinitialization, the repository will be moved to the specified path.
73
74
-b <branch-name>::
75
--initial-branch=<branch-name>::
Documentation/git-mailsplit.txt
+1
-1
@@ -34,7 +34,7 @@ OPTIONS
34
35
-b::
36
If any file doesn't begin with a From line, assume it is a
37
- single mail message instead of signaling error.
37
+ single mail message instead of signaling an error.
38
39
-d<prec>::
40
Instead of the default 4 digits with leading zeros,
Documentation/git-merge-base.txt
+1
-1
@@ -18,7 +18,7 @@ SYNOPSIS
18
DESCRIPTION
19
-----------
20
21
-'git merge-base' finds best common ancestor(s) between two commits to use
21
+'git merge-base' finds the best common ancestor(s) between two commits to use
22
in a three-way merge. One common ancestor is 'better' than another common
23
ancestor if the latter is an ancestor of the former. A common ancestor
24
that does not have any better common ancestor is a 'best common
Documentation/git-merge-tree.txt
+1
-1
@@ -19,7 +19,7 @@ DESCRIPTION
19
This command has a modern `--write-tree` mode and a deprecated
20
`--trivial-merge` mode. With the exception of the
21
<<DEPMERGE,DEPRECATED DESCRIPTION>> section at the end, the rest of
22
-this documentation describes modern `--write-tree` mode.
22
+this documentation describes the modern `--write-tree` mode.
23
24
Performs a merge, but does not make any new commits and does not read
25
from or write to either the working tree or index.
Documentation/git-mktag.txt
+1
-1
@@ -56,7 +56,7 @@ has a very simple fixed format: four lines of
56
tagger <tagger>
57
58
followed by some 'optional' free-form message (some tags created
59
-by older Git may not have `tagger` line). The message, when it
59
+by older Git may not have a `tagger` line). The message, when it
60
exists, is separated by a blank line from the header. The
61
message part may contain a signature that Git itself doesn't
62
care about, but that can be verified with gpg.
Documentation/git-prune.txt
+1
-1
@@ -18,7 +18,7 @@ NOTE: In most cases, users should run 'git gc', which calls
18
'git prune'. See the section "NOTES", below.
19
20
This runs 'git fsck --unreachable' using all the refs
21
-available in `refs/`, optionally with additional set of
21
+available in `refs/`, optionally with an additional set of
22
objects specified on the command line, and prunes all unpacked
23
objects unreachable from any of these head objects from the object database.
24
In addition, it
Documentation/git-push.txt
+1
-1
@@ -48,7 +48,7 @@ local one.
48
OPTIONS[[OPTIONS]]
49
------------------
50
<repository>::
51
- The "remote" repository that is destination of a push
51
+ The "remote" repository that is the destination of a push
52
operation. This parameter can be either a URL
53
(see the section <<URLS,GIT URLS>> below) or the name
54
of a remote (see the section <<REMOTES,REMOTES>> below).
Documentation/git-read-tree.txt
+2
-2
@@ -26,14 +26,14 @@ flag. When used with `-m`, the `-u` flag causes it to also update
26
the files in the work tree with the result of the merge.
27
28
Only trivial merges are done by 'git read-tree' itself. Only conflicting paths
29
-will be in unmerged state when 'git read-tree' returns.
29
+will be in an unmerged state when 'git read-tree' returns.
30
31
OPTIONS
32
-------
33
-m::
34
Perform a merge, not just a read. The command will
35
refuse to run if your index file has unmerged entries,
36
- indicating that you have not finished previous merge you
36
+ indicating that you have not finished a previous merge you
37
started.
38
39
--reset::
Documentation/git-receive-pack.txt
+2
-2
@@ -18,10 +18,10 @@ information fed from the remote end.
18
19
This command is usually not invoked directly by the end user.
20
The UI for the protocol is on the 'git send-pack' side, and the
21
-program pair is meant to be used to push updates to remote
21
+program pair is meant to be used to push updates to a remote
22
repository. For pull operations, see linkgit:git-fetch-pack[1].
23
24
-The command allows for creation and fast-forwarding of sha1 refs
24
+The command allows for the creation and fast-forwarding of sha1 refs
25
(heads/tags) on the remote end (strictly speaking, it is the
26
local end 'git-receive-pack' runs, but to the user who is sitting at
27
the send-pack end, it is updating the remote. Confused?)
Documentation/git-remote-ext.txt
+5
-5
@@ -44,15 +44,15 @@ The following sequences have a special meaning:
44
This argument will not be passed to '<command>'. Instead, it
45
will cause the helper to start by sending git:// service requests to
46
the remote side with the service field set to an appropriate value and
47
- the repository field set to rest of the argument. Default is not to send
47
+ the repository field set to the rest of the argument. Default is not to send
48
such a request.
49
+
50
-This is useful if remote side is git:// server accessed over
50
+This is useful if the remote side is git:// server accessed over
51
some tunnel.
52
53
'%V' (must be first characters in argument)::
54
This argument will not be passed to '<command>'. Instead it sets
55
- the vhost field in the git:// service request (to rest of the argument).
55
+ the vhost field in the git:// service request (to the rest of the argument).
56
Default is not to send vhost in such request (if sent).
57
58
ENVIRONMENT VARIABLES
@@ -82,12 +82,12 @@ begins with `ext::`. Examples:
82
83
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
84
Like host.example:foo/repo, but use /home/foo/.ssh/somekey as
85
- keypair and user as user on remote side. This avoids the need to
85
+ keypair and user as the user on the remote side. This avoids the need to
86
edit .ssh/config.
87
88
"ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"::
89
Represents repository with path /somerepo accessible over
90
- git protocol at abstract namespace address /git-server.
90
+ git protocol at the abstract namespace address /git-server.
91
92
"ext::git-server-alias foo %G/repo"::
93
Represents a repository with path /repo accessed using the
Documentation/git-remote-fd.txt
+2
-2
@@ -25,7 +25,7 @@ It is assumed that any handshaking procedures have already been completed
25
(such as sending service request for git://) before this helper is started.
26
27
<anything> can be any string. It is ignored. It is meant for providing
28
-information to user in the URL in case that URL is displayed in some
28
+information to the user in the URL in case that URL is displayed in some
29
context.
30
31
ENVIRONMENT VARIABLES
@@ -45,7 +45,7 @@ EXAMPLES
45
`git push fd::7,8 master (as URL)`::
46
Push master, using file descriptor #7 to read data from
47
git-receive-pack and file descriptor #8 to write data to
48
- same service.
48
+ the same service.
49
50
`git push fd::7,8/bar master`::
51
Same as above.
Documentation/git-replace.txt
+1
-1
@@ -35,7 +35,7 @@ Replacement references will be used by default by all Git commands
35
except those doing reachability traversal (prune, pack transfer and
36
fsck).
37
38
-It is possible to disable use of replacement references for any
38
+It is possible to disable the use of replacement references for any
39
command using the `--no-replace-objects` option just after 'git'.
40
41
For example if commit 'foo' has been replaced by commit 'bar':
Documentation/git-rev-parse.txt
+1
-1
@@ -14,7 +14,7 @@ SYNOPSIS
14
DESCRIPTION
15
-----------
16
17
-Many Git porcelainish commands take mixture of flags
17
+Many Git porcelainish commands take a mixture of flags
18
(i.e. parameters that begin with a dash '-') and parameters
19
meant for the underlying 'git rev-list' command they use internally
20
and flags and parameters for the other commands they use
Documentation/git-send-pack.txt
+1
-1
@@ -106,7 +106,7 @@ SPECIFYING THE REFS
106
There are three ways to specify which refs to update on the
107
remote end.
108
109
-With `--all` flag, all refs that exist locally are transferred to
109
+With the `--all` flag, all refs that exist locally are transferred to
110
the remote side. You cannot specify any '<ref>' if you use
111
this flag.
112
Documentation/git-sh-setup.txt
+1
-1
@@ -22,7 +22,7 @@ The 'git sh-setup' scriptlet is designed to be sourced (using
22
the normal Git directories and a few helper shell functions.
23
24
Before sourcing it, your script should set up a few variables;
25
-`USAGE` (and `LONG_USAGE`, if any) is used to define message
25
+`USAGE` (and `LONG_USAGE`, if any) is used to define the message
26
given by `usage()` shell function. `SUBDIRECTORY_OK` can be set
27
if the script can run from a subdirectory of the working tree
28
(some commands do not).
Documentation/git-show-branch.txt
+1
-1
@@ -137,7 +137,7 @@ their commit message. The branch head that is pointed at by
137
$GIT_DIR/HEAD is prefixed with an asterisk `*` character while other
138
heads are prefixed with a `!` character.
139
140
-Following these N lines, one-line log for each commit is
140
+Following these N lines, a one-line log for each commit is
141
displayed, indented N places. If a commit is on the I-th
142
branch, the I-th indentation character shows a `+` sign;
143
otherwise it shows a space. Merge commits are denoted by
Documentation/git-stripspace.txt
+1
-1
@@ -37,7 +37,7 @@ OPTIONS
37
-------
38
-s::
39
--strip-comments::
40
- Skip and remove all lines starting with comment character (default '#').
40
+ Skip and remove all lines starting with a comment character (default '#').
41
42
-c::
43
--comment-lines::
Documentation/git-update-index.txt
+4
-4
@@ -95,7 +95,7 @@ OPTIONS
95
the index. If you want to change the working tree file,
96
you need to unset the bit to tell Git. This is
97
sometimes helpful when working with a big project on a
98
- filesystem that has very slow lstat(2) system call
98
+ filesystem that has a very slow lstat(2) system call
99
(e.g. cifs).
100
+
101
Git will fail (gracefully) in case it needs to modify this file
@@ -151,12 +151,12 @@ you will need to handle the situation manually.
151
automatically removed with warning messages.
152
153
--stdin::
154
- Instead of taking list of paths from the command line,
155
- read list of paths from the standard input. Paths are
154
+ Instead of taking a list of paths from the command line,
155
+ read a list of paths from the standard input. Paths are
156
separated by LF (i.e. one path per line) by default.
157
158
--verbose::
159
- Report what is being added and removed from index.
159
+ Report what is being added and removed from the index.
160
161
--index-version <n>::
162
Write the resulting index out in the named on-disk format version.
Documentation/git-update-ref.txt
+1
-1
@@ -118,7 +118,7 @@ verify::
118
<oldvalue> is zero or missing, the ref must not exist.
119
120
option::
121
- Modify behavior of the next command naming a <ref>.
121
+ Modify the behavior of the next command naming a <ref>.
122
The only valid option is `no-deref` to avoid dereferencing
123
a symbolic ref.
124
Documentation/git-update-server-info.txt
+1
-1
@@ -29,7 +29,7 @@ OUTPUT
29
------
30
31
Currently the command updates the following files. Please see
32
-linkgit:gitrepository-layout[5] for description of
32
+linkgit:gitrepository-layout[5] for a description of
33
what they are for:
34
35
* objects/info/packs
Documentation/git-verify-pack.txt
+3
-3
@@ -15,7 +15,7 @@ SYNOPSIS
15
DESCRIPTION
16
-----------
17
Reads given idx file for packed Git archive created with the
18
-'git pack-objects' command and verifies idx file and the
18
+'git pack-objects' command and verifies the idx file and the
19
corresponding pack file.
20
21
OPTIONS
@@ -25,13 +25,13 @@ OPTIONS
25
26
-v::
27
--verbose::
28
- After verifying the pack, show list of objects contained
28
+ After verifying the pack, show the list of objects contained
29
in the pack and a histogram of delta chain length.
30
31
-s::
32
--stat-only::
33
Do not verify the pack contents; only show the histogram of delta
34
- chain length. With `--verbose`, list of objects is also shown.
34
+ chain length. With `--verbose`, the list of objects is also shown.
35
36
\--::
37
Do not interpret any more arguments as options.
Documentation/git-whatchanged.txt
+1
-1
@@ -22,7 +22,7 @@ but defaults to showing the raw format diff output and skipping merges.
22
23
The command is primarily kept for historical reasons; fingers of
24
many people who learned Git long before `git log` was invented by
25
-reading Linux kernel mailing list are trained to type it.
25
+reading the Linux kernel mailing list are trained to type it.
26
27
28
Examples
Documentation/gitcli.txt
+1
-1
@@ -37,7 +37,7 @@ arguments. Here are the rules:
37
they can be disambiguated by placing `--` between them.
38
E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work
39
tree. Please show changes between the version I staged in the index
40
- and what I have in the work tree for that file", not "show difference
40
+ and what I have in the work tree for that file", not "show the difference
41
between the HEAD commit and the work tree as a whole". You can say
42
`git diff HEAD --` to ask for the latter.
43
Documentation/gitdiffcore.txt
+3
-3
@@ -213,7 +213,7 @@ from the original, and does not count insertion. If you removed
213
only 10 lines from a 100-line document, even if you added 910
214
new lines to make a new 1000-line document, you did not do a
215
complete rewrite. diffcore-break breaks such a case in order to
216
-help diffcore-rename to consider such filepairs as candidate of
216
+help diffcore-rename to consider such filepairs as a candidate of
217
rename/copy detection, but if filepairs broken that way were not
218
matched with other filepairs to create rename/copy, then this
219
transformation merges them back into the original
@@ -235,8 +235,8 @@ creation and deletion patches. This was an unnecessary hack and
235
the latest implementation always merges all the broken pairs
236
back into modifications, but the resulting patch output is
237
formatted differently for easier review in case of such
238
-a complete rewrite by showing the entire contents of old version
239
-prefixed with '-', followed by the entire contents of new
238
+a complete rewrite by showing the entire contents of the old version
239
+prefixed with '-', followed by the entire contents of the new
240
version prefixed with '+'.
241
242
Documentation/gitformat-pack.txt
+4
-4
@@ -48,7 +48,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256.
48
Observation: we cannot have more than 4G versions ;-) and
49
more than 4G objects in a pack.
50
51
- - The header is followed by number of object entries, each of
51
+ - The header is followed by a number of object entries, each of
52
which looks like this:
53
54
(undeltified representation)
@@ -62,7 +62,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256.
62
is an OBJ_OFS_DELTA object
63
compressed delta data
64
65
- Observation: length of each object is encoded in a variable
65
+ Observation: the length of each object is encoded in a variable
66
length format and is not constrained to 32-bit or anything.
67
68
- The trailer records a pack checksum of all of the above.
@@ -161,7 +161,7 @@ converted to 0x10000.
161
| 0xxxxxxx | data |
162
+----------+============+
163
164
-This is the instruction to construct target object without the base
164
+This is the instruction to construct the target object without the base
165
object. The following data is appended to the target object. The first
166
seven bits of the first octet determine the size of data in
167
bytes. The size must be non-zero.
@@ -294,7 +294,7 @@ Pack file entry: <+
294
295
- The same trailer as a v1 pack file:
296
297
- A copy of the pack checksum at the end of
297
+ A copy of the pack checksum at the end of the
298
corresponding packfile.
299
300
Index checksum of all of the above.
Documentation/githooks.txt
+1
-1
@@ -157,7 +157,7 @@ If the exit status is non-zero, `git commit` will abort.
157
The purpose of the hook is to edit the message file in place, and
158
it is not suppressed by the `--no-verify` option. A non-zero exit
159
means a failure of the hook and aborts the commit. It should not
160
-be used as replacement for pre-commit hook.
160
+be used as a replacement for the pre-commit hook.
161
162
The sample `prepare-commit-msg` hook that comes with Git removes the
163
help message found in the commented portion of the commit template.
Documentation/gitprotocol-capabilities.txt
+1
-1
@@ -88,7 +88,7 @@ interleaved with S-R-Q.
88
89
multi_ack_detailed
90
------------------
91
-This is an extension of multi_ack that permits client to better
91
+This is an extension of multi_ack that permits the client to better
92
understand the server's in-memory state. See linkgit:gitprotocol-pack[5],
93
section "Packfile Negotiation" for more information.
94
Documentation/gitweb.txt
+4
-4
@@ -41,9 +41,9 @@ for details.
41
Repositories
42
~~~~~~~~~~~~
43
Gitweb can show information from one or more Git repositories. These
44
-repositories have to be all on local filesystem, and have to share common
44
+repositories have to be all on local filesystem, and have to share a common
45
repository root, i.e. be all under a single parent repository (but see also
46
-"Advanced web server setup" section, "Webserver configuration with multiple
46
+the "Advanced web server setup" section, "Webserver configuration with multiple
47
projects' root" subsection).
48
49
-----------------------------------------------------------------------
@@ -51,7 +51,7 @@ our $projectroot = '/path/to/parent/directory';
51
-----------------------------------------------------------------------
52
53
The default value for `$projectroot` is `/pub/git`. You can change it during
54
-building gitweb via `GITWEB_PROJECTROOT` build configuration variable.
54
+building gitweb via the `GITWEB_PROJECTROOT` build configuration variable.
55
56
By default all Git repositories under `$projectroot` are visible and available
57
to gitweb. The list of projects is generated by default by scanning the
@@ -66,7 +66,7 @@ found at "$projectroot/$repo".
66
67
Projects list file format
68
~~~~~~~~~~~~~~~~~~~~~~~~~
69
-Instead of having gitweb find repositories by scanning filesystem
69
+Instead of having gitweb find repositories by scanning the filesystem
70
starting from $projectroot, you can provide a pre-generated list of
71
visible projects by setting `$projects_list` to point to a plain text
72
file with a list of projects (with some additional info).
Documentation/pretty-options.txt
+1
-1
@@ -48,7 +48,7 @@ people using 80-column terminals.
48
--expand-tabs::
49
--no-expand-tabs::
50
Perform a tab expansion (replace each tab with enough spaces
51
- to fill to the next display column that is multiple of '<n>')
51
+ to fill to the next display column that is a multiple of '<n>')
52
in the log message before showing it in the output.
53
`--expand-tabs` is a short-hand for `--expand-tabs=8`, and
54
`--no-expand-tabs` is a short-hand for `--expand-tabs=0`,
Documentation/pull-fetch-param.txt
+2
-2
@@ -80,7 +80,7 @@ configuration which'll amend these rules, and nothing like a
80
+
81
As with pushing with linkgit:git-push[1], all of the rules described
82
above about what's not allowed as an update can be overridden by
83
-adding an optional leading `+` to a refspec (or using `--force`
83
+adding an optional leading `+` to a refspec (or using the `--force`
84
command line option). The only exception to this is that no amount of
85
forcing will make the `refs/heads/*` namespace accept a non-commit
86
object.
@@ -88,7 +88,7 @@ object.
88
[NOTE]
89
When the remote branch you want to fetch is known to
90
be rewound and rebased regularly, it is expected that
91
-its new tip will not be descendant of its previous tip
91
+its new tip will not be a descendant of its previous tip
92
(as stored in your remote-tracking branch the last time
93
you fetched). You would want
94
to use the `+` sign to indicate non-fast-forward updates
Documentation/rev-list-options.txt
+2
-2
@@ -56,7 +56,7 @@ endif::git-rev-list[]
56
error to use this option unless `--walk-reflogs` is in use.
57
58
--grep=<pattern>::
59
- Limit the commits output to ones with log message that
59
+ Limit the commits output to ones with a log message that
60
matches the specified pattern (regular expression). With
61
more than one `--grep=<pattern>`, commits whose message
62
matches any of the given patterns are chosen (but see
@@ -72,7 +72,7 @@ endif::git-rev-list[]
72
instead of ones that match at least one.
73
74
--invert-grep::
75
- Limit the commits output to ones with log message that do not
75
+ Limit the commits output to ones with a log message that do not
76
match the pattern specified with `--grep=<pattern>`.
77
78
-i::
Documentation/technical/bitmap-format.txt
+1
-1
@@ -239,7 +239,7 @@ bitmaps.
239
240
For a `.bitmap` containing `nr_entries` reachability bitmaps, the table
241
contains a list of `nr_entries` <commit_pos, offset, xor_row> triplets
242
-(sorted in the ascending order of `commit_pos`). The content of i'th
242
+(sorted in the ascending order of `commit_pos`). The content of the i'th
243
triplet is -
244
245
* {empty}
Documentation/technical/partial-clone.txt
+1
-1
@@ -256,7 +256,7 @@ remote in a specific order.
256
- Dynamic object fetching currently uses the existing pack protocol V0
257
which means that each object is requested via fetch-pack. The server
258
will send a full set of info/refs when the connection is established.
259
- If there are large number of refs, this may incur significant overhead.
259
+ If there are a large number of refs, this may incur significant overhead.
260
261
262
Future Work