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>
maint
Elijah Newren 2023-10-08 06:45:17 +00:00 committed by Junio C Hamano
parent 3771d00257
commit 0a4f051f93
57 changed files with 93 additions and 93 deletions

View File

@ -19,7 +19,7 @@ Principles
Selecting patch(es) to review Selecting patch(es) to review
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are looking for a patch series in need of review, start by checking 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 (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 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]; the https://lore.kernel.org/git/[`lore.kernel.org` mailing list archive];

View File

@ -5,7 +5,7 @@ advice.*::
+ +
-- --
ambiguousFetchRefspec:: 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 the same remote-tracking branch namespace and causes branch
tracking set-up to fail. tracking set-up to fail.
fetchShowForcedUpdates:: fetchShowForcedUpdates::

View File

@ -2,7 +2,7 @@ commit.cleanup::
This setting overrides the default of the `--cleanup` option in This setting overrides the default of the `--cleanup` option in
`git commit`. See linkgit:git-commit[1] for details. Changing the `git commit`. See linkgit:git-commit[1] for details. Changing the
default can be useful when you always want to keep lines that begin 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 would do `git config commit.cleanup whitespace` (note that you will
have to remove the help lines that begin with `#` in the commit log have to remove the help lines that begin with `#` in the commit log
template yourself, if you do this). template yourself, if you do this).

View File

@ -36,7 +36,7 @@ Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
will only cause git to warn. 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>`. values of `<msg-id>`.





View File

@ -39,7 +39,7 @@ See the `gc.bigPackThreshold` configuration variable below. When in
use, it'll affect how the auto pack limit works. use, it'll affect how the auto pack limit works.


gc.autoDetach:: 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. if the system supports it. Default is true.


gc.bigPackThreshold:: gc.bigPackThreshold::

View File

@ -24,7 +24,7 @@ gui.matchTrackingBranch::
not. Default: "false". not. Default: "false".


gui.newBranchTemplate:: 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]. linkgit:git-gui[1].


gui.pruneDuringFetch:: gui.pruneDuringFetch::

View File

@ -5,7 +5,7 @@ man.viewer::
man.<tool>.cmd:: man.<tool>.cmd::
Specify the command to invoke the specified man viewer. The Specify the command to invoke the specified man viewer. The
specified command is evaluated in shell with the man page 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:: man.<tool>.path::
Override the path for the given tool that may be used to Override the path for the given tool that may be used to

View File

@ -1,7 +1,7 @@
notes.mergeStrategy:: notes.mergeStrategy::
Which merge strategy to choose by default when resolving notes Which merge strategy to choose by default when resolving notes
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or 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. section of linkgit:git-notes[1] for more information on each strategy.
+ +
This setting can be overridden by passing the `--strategy` option to This setting can be overridden by passing the `--strategy` option to

View File

@ -91,7 +91,7 @@ sendemail.smtpBatchSize::
See also the `--batch-size` option of linkgit:git-send-email[1]. See also the `--batch-size` option of linkgit:git-send-email[1].


sendemail.smtpReloginDelay:: 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]. See also the `--relogin-delay` option of linkgit:git-send-email[1].


sendemail.forbidSendmailVariables:: sendemail.forbidSendmailVariables::

View File

@ -1,14 +1,14 @@
stash.showIncludeUntracked:: stash.showIncludeUntracked::
If this is set to true, the `git stash show` command will show If this is set to true, the `git stash show` command will show
the untracked files of a stash entry. Defaults to false. See 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:: stash.showPatch::
If this is set to true, the `git stash show` command without an 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. 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:: stash.showStat::
If this is set to true, the `git stash show` command without an If this is set to true, the `git stash show` command without an
option will show diffstat of the stash entry. Defaults to true. option will show a diffstat of the stash entry. Defaults to true.
See description of 'show' command in linkgit:git-stash[1]. See the description of the 'show' command in linkgit:git-stash[1].

View File

@ -25,9 +25,9 @@ The `a/` and `b/` filenames are the same unless rename/copy is
involved. Especially, even for a creation or a deletion, involved. Especially, even for a creation or a deletion,
`/dev/null` is _not_ used in place of the `a/` or `b/` filenames. `/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 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: 2. It is followed by one or more extended header lines:


@ -89,7 +89,7 @@ produce a 'combined diff' when showing a merge. This is the default
format when showing merges with linkgit:git-diff[1] or format when showing merges with linkgit:git-diff[1] or
linkgit:git-show[1]. Note also that you can give suitable linkgit:git-show[1]. Note also that you can give suitable
`--diff-merges` option to any of these commands to force generation of `--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: A "combined diff" format looks like this:


@ -143,7 +143,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 content 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 the diff of two
<tree-ish> and are not used by combined diff format. <tree-ish> and are not used by combined diff format.


3. It is followed by a two-line from-file/to-file header: 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
--- a/file --- a/file
+++ b/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 format, `/dev/null` is used to signal created or deleted
files. files.
+ +

View File

@ -132,7 +132,7 @@
(ERROR) Missing space before date in an author/committer line. (ERROR) Missing space before date in an author/committer line.


`missingSpaceBeforeEmail`:: `missingSpaceBeforeEmail`::
(ERROR) Missing space before the email in author/committer line. (ERROR) Missing space before the email in an author/committer line.


`missingTag`:: `missingTag`::
(ERROR) Unexpected end after `type` line in a tag object. (ERROR) Unexpected end after `type` line in a tag object.

View File

@ -94,7 +94,7 @@ OPTIONS
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable 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). preferred encoding if it is not UTF-8).
+ +
This was optional in prior versions of git, but now it is the This was optional in prior versions of git, but now it is the
@ -192,7 +192,7 @@ include::rerere-options.txt[]


--abort:: --abort::
Restore the original branch and abort the patching operation. 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. pre-am state.


--quit:: --quit::

View File

@ -140,7 +140,7 @@ linkgit:git-config[1]).
applying a diff generated with `--unified=0`. To bypass these applying a diff generated with `--unified=0`. To bypass these
checks use `--unidiff-zero`. 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. discouraged.


--apply:: --apply::
@ -257,7 +257,7 @@ the `--unsafe-paths` option to override this safety check. This option
has no effect when `--index` or `--cached` is in use. has no effect when `--index` or `--cached` is in use.


--allow-empty:: --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. empty patches and patches with commit text only.


CONFIGURATION CONFIGURATION

View File

@ -77,7 +77,7 @@ include::blame-options.txt[]


-e:: -e::
--show-email:: --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 This can also be controlled via the `blame.showEmail` config
option. option.


@ -100,7 +100,7 @@ When neither `--porcelain` nor `--incremental` option is specified,
`git blame` will output annotation for each line with: `git blame` will output annotation for each line with:


- abbreviated object name for the commit the line came from; - 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 is specified); and
- line number - line number



View File

@ -85,7 +85,7 @@ The rule `git check-ref-format --branch $name` implements
may be stricter than what `git check-ref-format refs/heads/$name` 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, 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). 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'' expanded for the ``previous checkout syntax''
`@{-n}`. For example, `@{-1}` is a way to refer the last thing that `@{-n}`. For example, `@{-1}` is a way to refer the last thing that
was checked out using "git switch" or "git checkout" operation. was checked out using "git switch" or "git checkout" operation.

View File

@ -53,7 +53,7 @@ OPTIONS


--stage=<number>|all:: --stage=<number>|all::
Instead of checking out unmerged entries, copy out the 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. Note: --stage=all automatically implies --temp.


--temp:: --temp::
@ -66,8 +66,8 @@ OPTIONS
set. set.


--stdin:: --stdin::
Instead of taking list of paths from the command line, Instead of taking a list of paths from the command line,
read list of paths from the standard input. Paths are read the list of paths from the standard input. Paths are
separated by LF (i.e. one path per line) by default. separated by LF (i.e. one path per line) by default.


-z:: -z::

View File

@ -33,7 +33,7 @@ size-pack: disk space consumed by the packs, in KiB (unless -H is specified)
prune-packable: the number of loose objects that are also present in prune-packable: the number of loose objects that are also present in
the packs. These objects could be pruned using `git prune-packed`. 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 objects nor valid packs
+ +
size-garbage: disk space consumed by garbage files, in KiB (unless -H is size-garbage: disk space consumed by garbage files, in KiB (unless -H is

View File

@ -138,7 +138,7 @@ otherwise `stderr`.
--user-path:: --user-path::
--user-path=<path>:: --user-path=<path>::
Allow {tilde}user notation to be used in requests. When 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 git://host/{tilde}alice/foo is taken as a request to access
'foo' repository in the home directory of user `alice`. 'foo' repository in the home directory of user `alice`.
If `--user-path=path` is specified, the same request is If `--user-path=path` is specified, the same request is

View File

@ -78,7 +78,7 @@ commits (but not trees).
By default, 'git diff-tree --stdin' shows differences, By default, 'git diff-tree --stdin' shows differences,
either in machine-readable form (without `-p`) or in patch either in machine-readable form (without `-p`) or in patch
form (with `-p`). This output can be suppressed. It is form (with `-p`). This output can be suppressed. It is
only useful with `-v` flag. only useful with the `-v` flag.


-v:: -v::
This flag causes 'git diff-tree --stdin' to also show This flag causes 'git diff-tree --stdin' to also show

View File

@ -36,7 +36,7 @@ OPTIONS


--rotate-to=<file>:: --rotate-to=<file>::
Start showing the diff for the given path, 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>:: --skip-to=<file>::
Start showing the diff for the given path, skipping all Start showing the diff for the given path, skipping all

View File

@ -24,7 +24,7 @@ OPTIONS
An object to treat as the head of an unreachability trace. An object to treat as the head of an unreachability trace.
+ +
If no objects are given, 'git fsck' defaults to using the 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. (unless --no-reflogs is given) as heads.


--unreachable:: --unreachable::

View File

@ -85,7 +85,7 @@ pseudo-configuration such as the file-based `.git/hooks/*` interface
described in linkgit:githooks[5]. described in linkgit:githooks[5].


--developer-interfaces:: --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. interfaces documentation on the standard output.


-i:: -i::

View File

@ -13,12 +13,12 @@ SYNOPSIS


DESCRIPTION DESCRIPTION
----------- -----------
Sends missing objects to remote repository, and updates the Sends missing objects to the remote repository, and updates the
remote branch. remote branch.


*NOTE*: This command is temporarily disabled if your libcurl *NOTE*: This command is temporarily disabled if your libcurl
is older than 7.16, as the combination has been reported 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 OPTIONS
------- -------

View File

@ -66,10 +66,10 @@ DIRECTORY" section below.)


Instead of initializing the repository as a directory to either `$GIT_DIR` or 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 `./.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. 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>:: -b <branch-name>::
--initial-branch=<branch-name>:: --initial-branch=<branch-name>::

View File

@ -34,7 +34,7 @@ OPTIONS


-b:: -b::
If any file doesn't begin with a From line, assume it is a 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>:: -d<prec>::
Instead of the default 4 digits with leading zeros, Instead of the default 4 digits with leading zeros,

View File

@ -18,7 +18,7 @@ SYNOPSIS
DESCRIPTION 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 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 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 that does not have any better common ancestor is a 'best common

View File

@ -19,7 +19,7 @@ DESCRIPTION
This command has a modern `--write-tree` mode and a deprecated This command has a modern `--write-tree` mode and a deprecated
`--trivial-merge` mode. With the exception of the `--trivial-merge` mode. With the exception of the
<<DEPMERGE,DEPRECATED DESCRIPTION>> section at the end, the rest of <<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 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.

View File

@ -56,7 +56,7 @@ has a very simple fixed format: four lines of
tagger <tagger> tagger <tagger>


followed by some 'optional' free-form message (some tags created 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 exists, is separated by a blank line from the header. The
message part may contain a signature that Git itself doesn't message part may contain a signature that Git itself doesn't
care about, but that can be verified with gpg. care about, but that can be verified with gpg.

View File

@ -18,7 +18,7 @@ NOTE: In most cases, users should run 'git gc', which calls
'git prune'. See the section "NOTES", below. 'git prune'. See the section "NOTES", below.


This runs 'git fsck --unreachable' using all the refs 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 specified on the command line, and prunes all unpacked
objects unreachable from any of these head objects from the object database. objects unreachable from any of these head objects from the object database.
In addition, it In addition, it

View File

@ -48,7 +48,7 @@ local one.
OPTIONS[[OPTIONS]] OPTIONS[[OPTIONS]]
------------------ ------------------
<repository>:: <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 operation. This parameter can be either a URL
(see the section <<URLS,GIT URLS>> below) or the name (see the section <<URLS,GIT URLS>> below) or the name
of a remote (see the section <<REMOTES,REMOTES>> below). of a remote (see the section <<REMOTES,REMOTES>> below).

View File

@ -26,14 +26,14 @@ flag. When used with `-m`, the `-u` flag causes it to also update
the files in the work tree with the result of the merge. 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 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 OPTIONS
------- -------
-m:: -m::
Perform a merge, not just a read. The command will Perform a merge, not just a read. The command will
refuse to run if your index file has unmerged entries, 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. started.


--reset:: --reset::

View File

@ -18,10 +18,10 @@ information fed from the remote end.


This command is usually not invoked directly by the end user. 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 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]. 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 (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 local end 'git-receive-pack' runs, but to the user who is sitting at
the send-pack end, it is updating the remote. Confused?) the send-pack end, it is updating the remote. Confused?)

View File

@ -44,15 +44,15 @@ The following sequences have a special meaning:
This argument will not be passed to '<command>'. Instead, it This argument will not be passed to '<command>'. Instead, it
will cause the helper to start by sending git:// service requests to 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 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. 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. some tunnel.


'%V' (must be first characters in argument):: '%V' (must be first characters in argument)::
This argument will not be passed to '<command>'. Instead it sets 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). Default is not to send vhost in such request (if sent).


ENVIRONMENT VARIABLES ENVIRONMENT VARIABLES
@ -82,12 +82,12 @@ begins with `ext::`. Examples:


"ext::ssh -i /home/foo/.ssh/somekey user&#64;host.example %S 'foo/repo'":: "ext::ssh -i /home/foo/.ssh/somekey user&#64;host.example %S 'foo/repo'"::
Like host.example:foo/repo, but use /home/foo/.ssh/somekey as 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. edit .ssh/config.


"ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo":: "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"::
Represents repository with path /somerepo accessible over 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":: "ext::git-server-alias foo %G/repo"::
Represents a repository with path /repo accessed using the Represents a repository with path /repo accessed using the

View File

@ -25,7 +25,7 @@ It is assumed that any handshaking procedures have already been completed
(such as sending service request for git://) before this helper is started. (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 <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. context.


ENVIRONMENT VARIABLES ENVIRONMENT VARIABLES
@ -45,7 +45,7 @@ EXAMPLES
`git push fd::7,8 master (as URL)`:: `git push fd::7,8 master (as URL)`::
Push master, using file descriptor #7 to read data from Push master, using file descriptor #7 to read data from
git-receive-pack and file descriptor #8 to write data to git-receive-pack and file descriptor #8 to write data to
same service. the same service.


`git push fd::7,8/bar master`:: `git push fd::7,8/bar master`::
Same as above. Same as above.

View File

@ -35,7 +35,7 @@ Replacement references will be used by default by all Git commands
except those doing reachability traversal (prune, pack transfer and except those doing reachability traversal (prune, pack transfer and
fsck). 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'. command using the `--no-replace-objects` option just after 'git'.


For example if commit 'foo' has been replaced by commit 'bar': For example if commit 'foo' has been replaced by commit 'bar':

View File

@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION 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 (i.e. parameters that begin with a dash '-') and parameters
meant for the underlying 'git rev-list' command they use internally meant for the underlying 'git rev-list' command they use internally
and flags and parameters for the other commands they use and flags and parameters for the other commands they use

View File

@ -106,7 +106,7 @@ SPECIFYING THE REFS
There are three ways to specify which refs to update on the There are three ways to specify which refs to update on the
remote end. 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 the remote side. You cannot specify any '<ref>' if you use
this flag. this flag.



View File

@ -22,7 +22,7 @@ The 'git sh-setup' scriptlet is designed to be sourced (using
the normal Git directories and a few helper shell functions. the normal Git directories and a few helper shell functions.


Before sourcing it, your script should set up a few variables; 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 given by `usage()` shell function. `SUBDIRECTORY_OK` can be set
if the script can run from a subdirectory of the working tree if the script can run from a subdirectory of the working tree
(some commands do not). (some commands do not).

View File

@ -137,7 +137,7 @@ their commit message. The branch head that is pointed at by
$GIT_DIR/HEAD is prefixed with an asterisk `*` character while other $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other
heads are prefixed with a `!` character. 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 displayed, indented N places. If a commit is on the I-th
branch, the I-th indentation character shows a `+` sign; branch, the I-th indentation character shows a `+` sign;
otherwise it shows a space. Merge commits are denoted by otherwise it shows a space. Merge commits are denoted by

View File

@ -37,7 +37,7 @@ OPTIONS
------- -------
-s:: -s::
--strip-comments:: --strip-comments::
Skip and remove all lines starting with comment character (default '#'). Skip and remove all lines starting with a comment character (default '#').


-c:: -c::
--comment-lines:: --comment-lines::

View File

@ -95,7 +95,7 @@ OPTIONS
the index. If you want to change the working tree file, the index. If you want to change the working tree file,
you need to unset the bit to tell Git. This is you need to unset the bit to tell Git. This is
sometimes helpful when working with a big project on a 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). (e.g. cifs).
+ +
Git will fail (gracefully) in case it needs to modify this file Git will fail (gracefully) in case it needs to modify this file
@ -151,12 +151,12 @@ you will need to handle the situation manually.
automatically removed with warning messages. automatically removed with warning messages.


--stdin:: --stdin::
Instead of taking list of paths from the command line, Instead of taking a list of paths from the command line,
read list of paths from the standard input. Paths are read a list of paths from the standard input. Paths are
separated by LF (i.e. one path per line) by default. separated by LF (i.e. one path per line) by default.


--verbose:: --verbose::
Report what is being added and removed from index. Report what is being added and removed from the index.


--index-version <n>:: --index-version <n>::
Write the resulting index out in the named on-disk format version. Write the resulting index out in the named on-disk format version.

View File

@ -118,7 +118,7 @@ verify::
<oldvalue> is zero or missing, the ref must not exist. <oldvalue> is zero or missing, the ref must not exist.


option:: 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 The only valid option is `no-deref` to avoid dereferencing
a symbolic ref. a symbolic ref.



View File

@ -29,7 +29,7 @@ OUTPUT
------ ------


Currently the command updates the following files. Please see 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: what they are for:


* objects/info/packs * objects/info/packs

View File

@ -15,7 +15,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
Reads given idx file for packed Git archive created with the 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. corresponding pack file.


OPTIONS OPTIONS
@ -25,13 +25,13 @@ OPTIONS


-v:: -v::
--verbose:: --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. in the pack and a histogram of delta chain length.


-s:: -s::
--stat-only:: --stat-only::
Do not verify the pack contents; only show the histogram of delta 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. Do not interpret any more arguments as options.

View File

@ -22,7 +22,7 @@ but defaults to showing the raw format diff output and skipping merges.


The command is primarily kept for historical reasons; fingers of The command is primarily kept for historical reasons; fingers of
many people who learned Git long before `git log` was invented by 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 Examples

View File

@ -37,7 +37,7 @@ arguments. Here are the rules:
they can be disambiguated by placing `--` between them. they can be disambiguated by placing `--` between them.
E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work 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 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 between the HEAD commit and the work tree as a whole". You can say
`git diff HEAD --` to ask for the latter. `git diff HEAD --` to ask for the latter.



View File

@ -213,7 +213,7 @@ from the original, and does not count insertion. If you removed
only 10 lines from a 100-line document, even if you added 910 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 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 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 rename/copy detection, but if filepairs broken that way were not
matched with other filepairs to create rename/copy, then this matched with other filepairs to create rename/copy, then this
transformation merges them back into the original transformation merges them back into the original
@ -235,8 +235,8 @@ 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
formatted differently for easier review in case of such formatted differently for easier review in case of such
a complete rewrite by showing the entire contents of old version a complete rewrite by showing the entire contents of the old version
prefixed with '-', followed by the entire contents of new prefixed with '-', followed by the entire contents of the new
version prefixed with '+'. version prefixed with '+'.





View File

@ -48,7 +48,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256.
Observation: we cannot have more than 4G versions ;-) and Observation: we cannot have more than 4G versions ;-) and
more than 4G objects in a pack. 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: which looks like this:


(undeltified representation) (undeltified representation)
@ -62,7 +62,7 @@ Similarly, in SHA-256 repositories, these values are computed using SHA-256.
is an OBJ_OFS_DELTA object is an OBJ_OFS_DELTA object
compressed delta data 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. length format and is not constrained to 32-bit or anything.


- The trailer records a pack checksum of all of the above. - The trailer records a pack checksum of all of the above.
@ -161,7 +161,7 @@ converted to 0x10000.
| 0xxxxxxx | data | | 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 object. The following data is appended to the target object. The first
seven bits of the first octet determine the size of data in seven bits of the first octet determine the size of data in
bytes. The size must be non-zero. bytes. The size must be non-zero.
@ -294,7 +294,7 @@ Pack file entry: <+


- The same trailer as a v1 pack file: - 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. corresponding packfile.


Index checksum of all of the above. Index checksum of all of the above.

View File

@ -157,7 +157,7 @@ If the exit status is non-zero, `git commit` will abort.
The purpose of the hook is to edit the message file in place, and 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 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 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 The sample `prepare-commit-msg` hook that comes with Git removes the
help message found in the commented portion of the commit template. help message found in the commented portion of the commit template.

View File

@ -88,7 +88,7 @@ interleaved with S-R-Q.


multi_ack_detailed 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], understand the server's in-memory state. See linkgit:gitprotocol-pack[5],
section "Packfile Negotiation" for more information. section "Packfile Negotiation" for more information.



View File

@ -41,9 +41,9 @@ for details.
Repositories Repositories
~~~~~~~~~~~~ ~~~~~~~~~~~~
Gitweb can show information from one or more Git repositories. These 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 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). projects' root" subsection).


----------------------------------------------------------------------- -----------------------------------------------------------------------
@ -51,7 +51,7 @@ our $projectroot = '/path/to/parent/directory';
----------------------------------------------------------------------- -----------------------------------------------------------------------


The default value for `$projectroot` is `/pub/git`. You can change it during 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 By default all Git repositories under `$projectroot` are visible and available
to gitweb. The list of projects is generated by default by scanning the to gitweb. The list of projects is generated by default by scanning the
@ -66,7 +66,7 @@ found at "$projectroot/$repo".


Projects list file format 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 starting from $projectroot, you can provide a pre-generated list of
visible projects by setting `$projects_list` to point to a plain text visible projects by setting `$projects_list` to point to a plain text
file with a list of projects (with some additional info). file with a list of projects (with some additional info).

View File

@ -48,7 +48,7 @@ people using 80-column terminals.
--expand-tabs:: --expand-tabs::
--no-expand-tabs:: --no-expand-tabs::
Perform a tab expansion (replace each tab with enough spaces 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. in the log message before showing it in the output.
`--expand-tabs` is a short-hand for `--expand-tabs=8`, and `--expand-tabs` is a short-hand for `--expand-tabs=8`, and
`--no-expand-tabs` is a short-hand for `--expand-tabs=0`, `--no-expand-tabs` is a short-hand for `--expand-tabs=0`,

View File

@ -80,7 +80,7 @@ configuration which'll amend these rules, and nothing like a
+ +
As with pushing with linkgit:git-push[1], all of the rules described 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 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 command line option). The only exception to this is that no amount of
forcing will make the `refs/heads/*` namespace accept a non-commit forcing will make the `refs/heads/*` namespace accept a non-commit
object. object.
@ -88,7 +88,7 @@ object.
[NOTE] [NOTE]
When the remote branch you want to fetch is known to When the remote branch you want to fetch is known to
be rewound and rebased regularly, it is expected that 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 (as stored in your remote-tracking branch the last time
you fetched). You would want you fetched). You would want
to use the `+` sign to indicate non-fast-forward updates to use the `+` sign to indicate non-fast-forward updates

View File

@ -56,7 +56,7 @@ endif::git-rev-list[]
error to use this option unless `--walk-reflogs` is in use. error to use this option unless `--walk-reflogs` is in use.


--grep=<pattern>:: --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 matches the specified pattern (regular expression). With
more than one `--grep=<pattern>`, commits whose message more than one `--grep=<pattern>`, commits whose message
matches any of the given patterns are chosen (but see matches any of the given patterns are chosen (but see
@ -72,7 +72,7 @@ endif::git-rev-list[]
instead of ones that match at least one. instead of ones that match at least one.


--invert-grep:: --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>`. match the pattern specified with `--grep=<pattern>`.


-i:: -i::

View File

@ -239,7 +239,7 @@ bitmaps.


For a `.bitmap` containing `nr_entries` reachability bitmaps, the table For a `.bitmap` containing `nr_entries` reachability bitmaps, the table
contains a list of `nr_entries` <commit_pos, offset, xor_row> triplets 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 - triplet is -


* {empty} * {empty}

View File

@ -256,7 +256,7 @@ remote in a specific order.
- Dynamic object fetching currently uses the existing pack protocol V0 - Dynamic object fetching currently uses the existing pack protocol V0
which means that each object is requested via fetch-pack. The server 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. 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 Future Work