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>
diff --git a/Documentation/ReviewingGuidelines.txt b/Documentation/ReviewingGuidelines.txt index 0e323d5..3e98c8a 100644 --- a/Documentation/ReviewingGuidelines.txt +++ b/Documentation/ReviewingGuidelines.txt
@@ -19,7 +19,7 @@ Selecting patch(es) to review ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are looking for a patch series in need of review, start by checking -latest "What's cooking in git.git" email +the latest "What's cooking in git.git" email (https://lore.kernel.org/git/xmqqilm1yp3m.fsf@gitster.g/[example]). The "What's cooking" emails & replies can be found using the query `s:"What's cooking"` on the https://lore.kernel.org/git/[`lore.kernel.org` mailing list archive];
diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index c5cde1c..2737381 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt
@@ -5,7 +5,7 @@ + -- ambiguousFetchRefspec:: - Advice shown when fetch refspec for multiple remotes maps to + Advice shown when a fetch refspec for multiple remotes maps to the same remote-tracking branch namespace and causes branch tracking set-up to fail. fetchShowForcedUpdates::
diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index bcb46cf..62f0d92 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt
@@ -2,7 +2,7 @@ This setting overrides the default of the `--cleanup` option in `git commit`. See linkgit:git-commit[1] for details. Changing the default can be useful when you always want to keep lines that begin - with comment character `#` in your log message, in which case you + with the comment character `#` in your log message, in which case you would do `git config commit.cleanup whitespace` (note that you will have to remove the help lines that begin with `#` in the commit log template yourself, if you do this).
diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt index 0687e86..5711416 100644 --- a/Documentation/config/fsck.txt +++ b/Documentation/config/fsck.txt
@@ -36,7 +36,7 @@ doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` will only cause git to warn. + -See `Fsck Messages` section of linkgit:git-fsck[1] for supported +See the `Fsck Messages` section of linkgit:git-fsck[1] for supported values of `<msg-id>`.
diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.txt index 17e2a8c..31f1fff 100644 --- a/Documentation/config/gc.txt +++ b/Documentation/config/gc.txt
@@ -39,7 +39,7 @@ use, it'll affect how the auto pack limit works. gc.autoDetach:: - Make `git gc --auto` return immediately and run in background + Make `git gc --auto` return immediately and run in the background if the system supports it. Default is true. gc.bigPackThreshold::
diff --git a/Documentation/config/gui.txt b/Documentation/config/gui.txt index 0c087fd..171be77 100644 --- a/Documentation/config/gui.txt +++ b/Documentation/config/gui.txt
@@ -24,7 +24,7 @@ not. Default: "false". gui.newBranchTemplate:: - Is used as suggested name when creating new branches using the + Is used as a suggested name when creating new branches using the linkgit:git-gui[1]. gui.pruneDuringFetch::
diff --git a/Documentation/config/man.txt b/Documentation/config/man.txt index a727d98..5a0f82c 100644 --- a/Documentation/config/man.txt +++ b/Documentation/config/man.txt
@@ -5,7 +5,7 @@ man.<tool>.cmd:: Specify the command to invoke the specified man viewer. The specified command is evaluated in shell with the man page - passed as argument. (See linkgit:git-help[1].) + passed as an argument. (See linkgit:git-help[1].) man.<tool>.path:: Override the path for the given tool that may be used to
diff --git a/Documentation/config/notes.txt b/Documentation/config/notes.txt index c7c4811..43db8e8 100644 --- a/Documentation/config/notes.txt +++ b/Documentation/config/notes.txt
@@ -1,7 +1,7 @@ notes.mergeStrategy:: Which merge strategy to choose by default when resolving notes conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or - `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" + `cat_sort_uniq`. Defaults to `manual`. See the "NOTES MERGE STRATEGIES" section of linkgit:git-notes[1] for more information on each strategy. + This setting can be overridden by passing the `--strategy` option to
diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.txt index 792e68a..7fc770e 100644 --- a/Documentation/config/sendemail.txt +++ b/Documentation/config/sendemail.txt
@@ -91,7 +91,7 @@ See also the `--batch-size` option of linkgit:git-send-email[1]. sendemail.smtpReloginDelay:: - Seconds to wait before reconnecting to smtp server. + Seconds to wait before reconnecting to the smtp server. See also the `--relogin-delay` option of linkgit:git-send-email[1]. sendemail.forbidSendmailVariables::
diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.txt index b9f609e..ec1edae 100644 --- a/Documentation/config/stash.txt +++ b/Documentation/config/stash.txt
@@ -1,14 +1,14 @@ stash.showIncludeUntracked:: If this is set to true, the `git stash show` command will show the untracked files of a stash entry. Defaults to false. See - description of 'show' command in linkgit:git-stash[1]. + the description of the 'show' command in linkgit:git-stash[1]. stash.showPatch:: If this is set to true, the `git stash show` command without an option will show the stash entry in patch form. Defaults to false. - See description of 'show' command in linkgit:git-stash[1]. + See the description of the 'show' command in linkgit:git-stash[1]. stash.showStat:: If this is set to true, the `git stash show` command without an - option will show diffstat of the stash entry. Defaults to true. - See description of 'show' command in linkgit:git-stash[1]. + option will show a diffstat of the stash entry. Defaults to true. + See the description of the 'show' command in linkgit:git-stash[1].
diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt index 4b307cb..cf1958c 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.txt
@@ -25,9 +25,9 @@ involved. Especially, even for a creation or a deletion, `/dev/null` is _not_ used in place of the `a/` or `b/` filenames. + -When rename/copy is involved, `file1` and `file2` show the +When a rename/copy is involved, `file1` and `file2` show the name of the source file of the rename/copy and the name of -the file that rename/copy produces, respectively. +the file that the rename/copy produces, respectively. 2. It is followed by one or more extended header lines: @@ -89,7 +89,7 @@ format when showing merges with linkgit:git-diff[1] or linkgit:git-show[1]. Note also that you can give suitable `--diff-merges` option to any of these commands to force generation of -diffs in specific format. +diffs in a specific format. A "combined diff" format looks like this: @@ -143,7 +143,7 @@ The `mode <mode>,<mode>..<mode>` line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected content movement (renames and -copying detection) are designed to work with diff of two +copying detection) are designed to work with the diff of two <tree-ish> and are not used by combined diff format. 3. It is followed by a two-line from-file/to-file header: @@ -151,7 +151,7 @@ --- a/file +++ b/file + -Similar to two-line header for traditional 'unified' diff +Similar to the two-line header for the traditional 'unified' diff format, `/dev/null` is used to signal created or deleted files. +
diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt index 8505c24..f643585 100644 --- a/Documentation/fsck-msgids.txt +++ b/Documentation/fsck-msgids.txt
@@ -132,7 +132,7 @@ (ERROR) Missing space before date in an author/committer line. `missingSpaceBeforeEmail`:: - (ERROR) Missing space before the email in author/committer line. + (ERROR) Missing space before the email in an author/committer line. `missingTag`:: (ERROR) Unexpected end after `type` line in a tag object.
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 51c2671..00a5ec2 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt
@@ -94,7 +94,7 @@ 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 + `i18n.commitEncoding` can be used to specify the project's preferred encoding if it is not UTF-8). + This was optional in prior versions of git, but now it is the @@ -192,7 +192,7 @@ --abort:: Restore the original branch and abort the patching operation. - Revert contents of files involved in the am operation to their + Revert the contents of files involved in the am operation to their pre-am state. --quit::
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index b6e7510..95bde30 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt
@@ -140,7 +140,7 @@ applying a diff generated with `--unified=0`. To bypass these checks use `--unidiff-zero`. + -Note, for the reasons stated above usage of context-free patches is +Note, for the reasons stated above the usage of context-free patches is discouraged. --apply:: @@ -257,7 +257,7 @@ has no effect when `--index` or `--cached` is in use. --allow-empty:: - Don't return error for patches containing no diff. This includes + Don't return an error for patches containing no diff. This includes empty patches and patches with commit text only. CONFIGURATION
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index a927c7c..6f39147 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt
@@ -77,7 +77,7 @@ -e:: --show-email:: - Show the author email instead of author name (Default: off). + Show the author email instead of the author name (Default: off). This can also be controlled via the `blame.showEmail` config option. @@ -100,7 +100,7 @@ `git blame` will output annotation for each line with: - abbreviated object name for the commit the line came from; -- author ident (by default author name and date, unless `-s` or `-e` +- author ident (by default the author name and date, unless `-s` or `-e` is specified); and - line number
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index ee6a414..1d6e08e 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt
@@ -85,7 +85,7 @@ may be stricter than what `git check-ref-format refs/heads/$name` says (e.g. a dash may appear at the beginning of a ref component, but it is explicitly forbidden at the beginning of a branch name). -When run with `--branch` option in a repository, the input is first +When run with the `--branch` option in a repository, the input is first expanded for the ``previous checkout syntax'' `@{-n}`. For example, `@{-1}` is a way to refer the last thing that was checked out using "git switch" or "git checkout" operation.
diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index d1738f4..4e252761 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt
@@ -53,7 +53,7 @@ --stage=<number>|all:: Instead of checking out unmerged entries, copy out the - files from named stage. <number> must be between 1 and 3. + files from the named stage. <number> must be between 1 and 3. Note: --stage=all automatically implies --temp. --temp:: @@ -66,8 +66,8 @@ set. --stdin:: - Instead of taking list of paths from the command line, - read list of paths from the standard input. Paths are + Instead of taking a list of paths from the command line, + read the list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default. -z::
diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt index b28cc3a..97f9f12 100644 --- a/Documentation/git-count-objects.txt +++ b/Documentation/git-count-objects.txt
@@ -33,7 +33,7 @@ prune-packable: the number of loose objects that are also present in the packs. These objects could be pruned using `git prune-packed`. + -garbage: the number of files in object database that are neither valid loose +garbage: the number of files in the object database that are neither valid loose objects nor valid packs + size-garbage: disk space consumed by garbage files, in KiB (unless -H is
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 236df51..e064f91 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt
@@ -138,7 +138,7 @@ --user-path:: --user-path=<path>:: Allow {tilde}user notation to be used in requests. When - specified with no parameter, requests to + specified with no parameter, a request to git://host/{tilde}alice/foo is taken as a request to access 'foo' repository in the home directory of user `alice`. If `--user-path=path` is specified, the same request is
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 1e34f80..c2772a5 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt
@@ -78,7 +78,7 @@ By default, 'git diff-tree --stdin' shows differences, either in machine-readable form (without `-p`) or in patch form (with `-p`). This output can be suppressed. It is - only useful with `-v` flag. + only useful with the `-v` flag. -v:: This flag causes 'git diff-tree --stdin' to also show
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt index 179e5ae..50cb080 100644 --- a/Documentation/git-difftool.txt +++ b/Documentation/git-difftool.txt
@@ -36,7 +36,7 @@ --rotate-to=<file>:: Start showing the diff for the given path, - the paths before it will move to end and output. + the paths before it will move to the end and output. --skip-to=<file>:: Start showing the diff for the given path, skipping all
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index e4980d2..5b82e46 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt
@@ -24,7 +24,7 @@ An object to treat as the head of an unreachability trace. + If no objects are given, 'git fsck' defaults to using the -index file, all SHA-1 references in `refs` namespace, and all reflogs +index file, all SHA-1 references in the `refs` namespace, and all reflogs (unless --no-reflogs is given) as heads. --unreachable::
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index ee18a2b..22dfd78 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt
@@ -85,7 +85,7 @@ described in linkgit:githooks[5]. --developer-interfaces:: - Print list of file formats, protocols and other developer + Print a list of file formats, protocols and other developer interfaces documentation on the standard output. -i::
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index 8b4a579..c0c841b 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt
@@ -13,12 +13,12 @@ DESCRIPTION ----------- -Sends missing objects to remote repository, and updates the +Sends missing objects to the remote repository, and updates the remote branch. *NOTE*: This command is temporarily disabled if your libcurl is older than 7.16, as the combination has been reported -not to work and sometimes corrupts repository. +not to work and sometimes corrupts the repository. OPTIONS -------
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 138dc4a..3c3c1e7 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt
@@ -66,10 +66,10 @@ Instead of initializing the repository as a directory to either `$GIT_DIR` or `./.git/`, create a text file there containing the path to the actual -repository. This file acts as filesystem-agnostic Git symbolic link to the +repository. This file acts as a filesystem-agnostic Git symbolic link to the repository. + -If this is reinitialization, the repository will be moved to the specified path. +If this is a reinitialization, the repository will be moved to the specified path. -b <branch-name>:: --initial-branch=<branch-name>::
diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt index e3b2a88..3f0a666 100644 --- a/Documentation/git-mailsplit.txt +++ b/Documentation/git-mailsplit.txt
@@ -34,7 +34,7 @@ -b:: If any file doesn't begin with a From line, assume it is a - single mail message instead of signaling error. + single mail message instead of signaling an error. -d<prec>:: Instead of the default 4 digits with leading zeros,
diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index b01ba3d..463764b 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt
@@ -18,7 +18,7 @@ DESCRIPTION ----------- -'git merge-base' finds best common ancestor(s) between two commits to use +'git merge-base' finds the best common ancestor(s) between two commits to use in a three-way merge. One common ancestor is 'better' than another common ancestor if the latter is an ancestor of the former. A common ancestor that does not have any better common ancestor is a 'best common
diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt index 9f951c7..b50acac 100644 --- a/Documentation/git-merge-tree.txt +++ b/Documentation/git-merge-tree.txt
@@ -19,7 +19,7 @@ This command has a modern `--write-tree` mode and a deprecated `--trivial-merge` mode. With the exception of the <<DEPMERGE,DEPRECATED DESCRIPTION>> section at the end, the rest of -this documentation describes modern `--write-tree` mode. +this documentation describes the modern `--write-tree` mode. Performs a merge, but does not make any new commits and does not read from or write to either the working tree or index.
diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index 7a01496..006d759 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt
@@ -56,7 +56,7 @@ tagger <tagger> followed by some 'optional' free-form message (some tags created -by older Git may not have `tagger` line). The message, when it +by older Git may not have a `tagger` line). The message, when it exists, is separated by a blank line from the header. The message part may contain a signature that Git itself doesn't care about, but that can be verified with gpg.
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index 03552dd..9a45571 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt
@@ -18,7 +18,7 @@ 'git prune'. See the section "NOTES", below. This runs 'git fsck --unreachable' using all the refs -available in `refs/`, optionally with additional set of +available in `refs/`, optionally with an additional set of objects specified on the command line, and prunes all unpacked objects unreachable from any of these head objects from the object database. In addition, it
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 5b4edaf..c12caed 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt
@@ -48,7 +48,7 @@ OPTIONS[[OPTIONS]] ------------------ <repository>:: - The "remote" repository that is destination of a push + The "remote" repository that is the destination of a push operation. This parameter can be either a URL (see the section <<URLS,GIT URLS>> below) or the name of a remote (see the section <<REMOTES,REMOTES>> below).
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 3206531..1c48c28 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt
@@ -26,14 +26,14 @@ the files in the work tree with the result of the merge. Only trivial merges are done by 'git read-tree' itself. Only conflicting paths -will be in unmerged state when 'git read-tree' returns. +will be in an unmerged state when 'git read-tree' returns. OPTIONS ------- -m:: Perform a merge, not just a read. The command will refuse to run if your index file has unmerged entries, - indicating that you have not finished previous merge you + indicating that you have not finished a previous merge you started. --reset::
diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index 65ff518..20aca92 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt
@@ -18,10 +18,10 @@ This command is usually not invoked directly by the end user. The UI for the protocol is on the 'git send-pack' side, and the -program pair is meant to be used to push updates to remote +program pair is meant to be used to push updates to a remote repository. For pull operations, see linkgit:git-fetch-pack[1]. -The command allows for creation and fast-forwarding of sha1 refs +The command allows for the creation and fast-forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the local end 'git-receive-pack' runs, but to the user who is sitting at the send-pack end, it is updating the remote. Confused?)
diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt index 17d84f2..b33ee3c 100644 --- a/Documentation/git-remote-ext.txt +++ b/Documentation/git-remote-ext.txt
@@ -44,15 +44,15 @@ This argument will not be passed to '<command>'. Instead, it will cause the helper to start by sending git:// service requests to the remote side with the service field set to an appropriate value and - the repository field set to rest of the argument. Default is not to send + the repository field set to the rest of the argument. Default is not to send such a request. + -This is useful if remote side is git:// server accessed over +This is useful if the remote side is git:// server accessed over some tunnel. '%V' (must be first characters in argument):: This argument will not be passed to '<command>'. Instead it sets - the vhost field in the git:// service request (to rest of the argument). + the vhost field in the git:// service request (to the rest of the argument). Default is not to send vhost in such request (if sent). ENVIRONMENT VARIABLES @@ -82,12 +82,12 @@ "ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'":: Like host.example:foo/repo, but use /home/foo/.ssh/somekey as - keypair and user as user on remote side. This avoids the need to + keypair and user as the user on the remote side. This avoids the need to edit .ssh/config. "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo":: Represents repository with path /somerepo accessible over - git protocol at abstract namespace address /git-server. + git protocol at the abstract namespace address /git-server. "ext::git-server-alias foo %G/repo":: Represents a repository with path /repo accessed using the
diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index 0451ceb..6ed71bd 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt
@@ -25,7 +25,7 @@ (such as sending service request for git://) before this helper is started. <anything> can be any string. It is ignored. It is meant for providing -information to user in the URL in case that URL is displayed in some +information to the user in the URL in case that URL is displayed in some context. ENVIRONMENT VARIABLES @@ -45,7 +45,7 @@ `git push fd::7,8 master (as URL)`:: Push master, using file descriptor #7 to read data from git-receive-pack and file descriptor #8 to write data to - same service. + the same service. `git push fd::7,8/bar master`:: Same as above.
diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt index fdd2e0f..4f25712 100644 --- a/Documentation/git-replace.txt +++ b/Documentation/git-replace.txt
@@ -35,7 +35,7 @@ except those doing reachability traversal (prune, pack transfer and fsck). -It is possible to disable use of replacement references for any +It is possible to disable the use of replacement references for any command using the `--no-replace-objects` option just after 'git'. For example if commit 'foo' has been replaced by commit 'bar':
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 7b3ce30..f42fb93 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt
@@ -14,7 +14,7 @@ DESCRIPTION ----------- -Many Git porcelainish commands take mixture of flags +Many Git porcelainish commands take a mixture of flags (i.e. parameters that begin with a dash '-') and parameters meant for the underlying 'git rev-list' command they use internally and flags and parameters for the other commands they use
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 9c1ed75..b9e73f2 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt
@@ -106,7 +106,7 @@ There are three ways to specify which refs to update on the remote end. -With `--all` flag, all refs that exist locally are transferred to +With the `--all` flag, all refs that exist locally are transferred to the remote side. You cannot specify any '<ref>' if you use this flag.
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 8632612..bdaf6e5 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt
@@ -22,7 +22,7 @@ the normal Git directories and a few helper shell functions. Before sourcing it, your script should set up a few variables; -`USAGE` (and `LONG_USAGE`, if any) is used to define message +`USAGE` (and `LONG_USAGE`, if any) is used to define the message given by `usage()` shell function. `SUBDIRECTORY_OK` can be set if the script can run from a subdirectory of the working tree (some commands do not).
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 080b524..ddf24ae 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt
@@ -137,7 +137,7 @@ $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other heads are prefixed with a `!` character. -Following these N lines, one-line log for each commit is +Following these N lines, a one-line log for each commit is displayed, indented N places. If a commit is on the I-th branch, the I-th indentation character shows a `+` sign; otherwise it shows a space. Merge commits are denoted by
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index 3dc630d..6b92cc7 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt
@@ -37,7 +37,7 @@ ------- -s:: --strip-comments:: - Skip and remove all lines starting with comment character (default '#'). + Skip and remove all lines starting with a comment character (default '#'). -c:: --comment-lines::
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 7f0c950..7ac2e37 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt
@@ -95,7 +95,7 @@ the index. If you want to change the working tree file, you need to unset the bit to tell Git. This is sometimes helpful when working with a big project on a - filesystem that has very slow lstat(2) system call + filesystem that has a very slow lstat(2) system call (e.g. cifs). + Git will fail (gracefully) in case it needs to modify this file @@ -151,12 +151,12 @@ automatically removed with warning messages. --stdin:: - Instead of taking list of paths from the command line, - read list of paths from the standard input. Paths are + Instead of taking a list of paths from the command line, + read a list of paths from the standard input. Paths are separated by LF (i.e. one path per line) by default. --verbose:: - Report what is being added and removed from index. + Report what is being added and removed from the index. --index-version <n>:: Write the resulting index out in the named on-disk format version.
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 48b6683..0561808 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt
@@ -118,7 +118,7 @@ <oldvalue> is zero or missing, the ref must not exist. option:: - Modify behavior of the next command naming a <ref>. + Modify the behavior of the next command naming a <ref>. The only valid option is `no-deref` to avoid dereferencing a symbolic ref.
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index 17e429d..ff32986 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt
@@ -29,7 +29,7 @@ ------ Currently the command updates the following files. Please see -linkgit:gitrepository-layout[5] for description of +linkgit:gitrepository-layout[5] for a description of what they are for: * objects/info/packs
diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index b8720dc..d7e8869 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt
@@ -15,7 +15,7 @@ DESCRIPTION ----------- Reads given idx file for packed Git archive created with the -'git pack-objects' command and verifies idx file and the +'git pack-objects' command and verifies the idx file and the corresponding pack file. OPTIONS @@ -25,13 +25,13 @@ -v:: --verbose:: - After verifying the pack, show list of objects contained + After verifying the pack, show the list of objects contained in the pack and a histogram of delta chain length. -s:: --stat-only:: Do not verify the pack contents; only show the histogram of delta - chain length. With `--verbose`, list of objects is also shown. + chain length. With `--verbose`, the list of objects is also shown. \--:: Do not interpret any more arguments as options.
diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index fc2dc5a..8e55e0b 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt
@@ -22,7 +22,7 @@ The command is primarily kept for historical reasons; fingers of many people who learned Git long before `git log` was invented by -reading Linux kernel mailing list are trained to type it. +reading the Linux kernel mailing list are trained to type it. Examples
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 71ffe55..e5fac94 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt
@@ -37,7 +37,7 @@ they can be disambiguated by placing `--` between them. E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work tree. Please show changes between the version I staged in the index - and what I have in the work tree for that file", not "show difference + and what I have in the work tree for that file", not "show the difference between the HEAD commit and the work tree as a whole". You can say `git diff HEAD --` to ask for the latter.
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 411ce86..bc65f91 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt
@@ -213,7 +213,7 @@ only 10 lines from a 100-line document, even if you added 910 new lines to make a new 1000-line document, you did not do a complete rewrite. diffcore-break breaks such a case in order to -help diffcore-rename to consider such filepairs as candidate of +help diffcore-rename to consider such filepairs as a candidate of rename/copy detection, but if filepairs broken that way were not matched with other filepairs to create rename/copy, then this transformation merges them back into the original @@ -235,8 +235,8 @@ the latest implementation always merges all the broken pairs back into modifications, but the resulting patch output is formatted differently for easier review in case of such -a complete rewrite by showing the entire contents of old version -prefixed with '-', followed by the entire contents of new +a complete rewrite by showing the entire contents of the old version +prefixed with '-', followed by the entire contents of the new version prefixed with '+'.
diff --git a/Documentation/gitformat-pack.txt b/Documentation/gitformat-pack.txt index 992f9d7..8fac3fc 100644 --- a/Documentation/gitformat-pack.txt +++ b/Documentation/gitformat-pack.txt
@@ -48,7 +48,7 @@ Observation: we cannot have more than 4G versions ;-) and more than 4G objects in a pack. - - The header is followed by number of object entries, each of + - The header is followed by a number of object entries, each of which looks like this: (undeltified representation) @@ -62,7 +62,7 @@ is an OBJ_OFS_DELTA object compressed delta data - Observation: length of each object is encoded in a variable + Observation: the length of each object is encoded in a variable length format and is not constrained to 32-bit or anything. - The trailer records a pack checksum of all of the above. @@ -161,7 +161,7 @@ | 0xxxxxxx | data | +----------+============+ -This is the instruction to construct target object without the base +This is the instruction to construct the target object without the base object. The following data is appended to the target object. The first seven bits of the first octet determine the size of data in bytes. The size must be non-zero. @@ -294,7 +294,7 @@ - The same trailer as a v1 pack file: - A copy of the pack checksum at the end of + A copy of the pack checksum at the end of the corresponding packfile. Index checksum of all of the above.
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index e62ad34..883982e 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt
@@ -157,7 +157,7 @@ The purpose of the hook is to edit the message file in place, and it is not suppressed by the `--no-verify` option. A non-zero exit means a failure of the hook and aborts the commit. It should not -be used as replacement for pre-commit hook. +be used as a replacement for the pre-commit hook. The sample `prepare-commit-msg` hook that comes with Git removes the help message found in the commented portion of the commit template.
diff --git a/Documentation/gitprotocol-capabilities.txt b/Documentation/gitprotocol-capabilities.txt index 388846d..d6c6eff 100644 --- a/Documentation/gitprotocol-capabilities.txt +++ b/Documentation/gitprotocol-capabilities.txt
@@ -88,7 +88,7 @@ multi_ack_detailed ------------------ -This is an extension of multi_ack that permits client to better +This is an extension of multi_ack that permits the client to better understand the server's in-memory state. See linkgit:gitprotocol-pack[5], section "Packfile Negotiation" for more information.
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index 41ce55e..1030e96 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt
@@ -41,9 +41,9 @@ Repositories ~~~~~~~~~~~~ Gitweb can show information from one or more Git repositories. These -repositories have to be all on local filesystem, and have to share common +repositories have to be all on local filesystem, and have to share a common repository root, i.e. be all under a single parent repository (but see also -"Advanced web server setup" section, "Webserver configuration with multiple +the "Advanced web server setup" section, "Webserver configuration with multiple projects' root" subsection). ----------------------------------------------------------------------- @@ -51,7 +51,7 @@ ----------------------------------------------------------------------- The default value for `$projectroot` is `/pub/git`. You can change it during -building gitweb via `GITWEB_PROJECTROOT` build configuration variable. +building gitweb via the `GITWEB_PROJECTROOT` build configuration variable. By default all Git repositories under `$projectroot` are visible and available to gitweb. The list of projects is generated by default by scanning the @@ -66,7 +66,7 @@ Projects list file format ~~~~~~~~~~~~~~~~~~~~~~~~~ -Instead of having gitweb find repositories by scanning filesystem +Instead of having gitweb find repositories by scanning the filesystem starting from $projectroot, you can provide a pre-generated list of visible projects by setting `$projects_list` to point to a plain text file with a list of projects (with some additional info).
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 15c6f27..23888cd 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt
@@ -48,7 +48,7 @@ --expand-tabs:: --no-expand-tabs:: Perform a tab expansion (replace each tab with enough spaces - to fill to the next display column that is multiple of '<n>') + to fill to the next display column that is a multiple of '<n>') in the log message before showing it in the output. `--expand-tabs` is a short-hand for `--expand-tabs=8`, and `--no-expand-tabs` is a short-hand for `--expand-tabs=0`,
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 74143ef..c718f79 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt
@@ -80,7 +80,7 @@ + As with pushing with linkgit:git-push[1], all of the rules described above about what's not allowed as an update can be overridden by -adding an optional leading `+` to a refspec (or using `--force` +adding an optional leading `+` to a refspec (or using the `--force` command line option). The only exception to this is that no amount of forcing will make the `refs/heads/*` namespace accept a non-commit object. @@ -88,7 +88,7 @@ [NOTE] When the remote branch you want to fetch is known to be rewound and rebased regularly, it is expected that -its new tip will not be descendant of its previous tip +its new tip will not be a descendant of its previous tip (as stored in your remote-tracking branch the last time you fetched). You would want to use the `+` sign to indicate non-fast-forward updates
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 66d71d1..2bf239f 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt
@@ -56,7 +56,7 @@ error to use this option unless `--walk-reflogs` is in use. --grep=<pattern>:: - Limit the commits output to ones with log message that + Limit the commits output to ones with a log message that matches the specified pattern (regular expression). With more than one `--grep=<pattern>`, commits whose message matches any of the given patterns are chosen (but see @@ -72,7 +72,7 @@ instead of ones that match at least one. --invert-grep:: - Limit the commits output to ones with log message that do not + Limit the commits output to ones with a log message that do not match the pattern specified with `--grep=<pattern>`. -i::
diff --git a/Documentation/technical/bitmap-format.txt b/Documentation/technical/bitmap-format.txt index f761828..f5d2009 100644 --- a/Documentation/technical/bitmap-format.txt +++ b/Documentation/technical/bitmap-format.txt
@@ -239,7 +239,7 @@ For a `.bitmap` containing `nr_entries` reachability bitmaps, the table contains a list of `nr_entries` <commit_pos, offset, xor_row> triplets -(sorted in the ascending order of `commit_pos`). The content of i'th +(sorted in the ascending order of `commit_pos`). The content of the i'th triplet is - * {empty}
diff --git a/Documentation/technical/partial-clone.txt b/Documentation/technical/partial-clone.txt index 29876ca..cd948b0 100644 --- a/Documentation/technical/partial-clone.txt +++ b/Documentation/technical/partial-clone.txt
@@ -256,7 +256,7 @@ - Dynamic object fetching currently uses the existing pack protocol V0 which means that each object is requested via fetch-pack. The server will send a full set of info/refs when the connection is established. - If there are large number of refs, this may incur significant overhead. + If there are a large number of refs, this may incur significant overhead. Future Work