documentation: wording improvements
Diff best viewed with --color-diff. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:

committed by
Junio C Hamano

parent
3a06386e31
commit
cf6cac2005
@ -1,5 +1,5 @@
|
|||||||
Like other projects, we also have some guidelines to keep to the
|
Like other projects, we also have some guidelines for our code. For
|
||||||
code. For Git in general, a few rough rules are:
|
Git in general, a few rough rules are:
|
||||||
|
|
||||||
- Most importantly, we never say "It's in POSIX; we'll happily
|
- Most importantly, we never say "It's in POSIX; we'll happily
|
||||||
ignore your needs should your system not conform to it."
|
ignore your needs should your system not conform to it."
|
||||||
|
@ -32,7 +32,7 @@ information on using the script.
|
|||||||
|
|
||||||
This is adapted from Linux's suggestion in its CodingStyle document:
|
This is adapted from Linux's suggestion in its CodingStyle document:
|
||||||
|
|
||||||
- To follow rules of the CodingGuideline, it's useful to put the following in
|
- To follow the rules in CodingGuidelines, it's useful to put the following in
|
||||||
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
|
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
|
||||||
----
|
----
|
||||||
;; note the first part is useful for C editing, too
|
;; note the first part is useful for C editing, too
|
||||||
|
@ -11,7 +11,7 @@ file. The file `/etc/gitconfig` can be used to store a system-wide
|
|||||||
default configuration.
|
default configuration.
|
||||||
|
|
||||||
The configuration variables are used by both the Git plumbing
|
The configuration variables are used by both the Git plumbing
|
||||||
and the porcelains. The variables are divided into sections, wherein
|
and the porcelain commands. The variables are divided into sections, wherein
|
||||||
the fully qualified variable name of the variable itself is the last
|
the fully qualified variable name of the variable itself is the last
|
||||||
dot-separated segment and the section name is everything before the last
|
dot-separated segment and the section name is everything before the last
|
||||||
dot. The variable names are case-insensitive, allow only alphanumeric
|
dot. The variable names are case-insensitive, allow only alphanumeric
|
||||||
@ -103,7 +103,7 @@ was found. See below for examples.
|
|||||||
Conditional includes
|
Conditional includes
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
You can include a config file from another conditionally by setting a
|
You can conditionally include a config file from another by setting a
|
||||||
`includeIf.<condition>.path` variable to the name of the file to be
|
`includeIf.<condition>.path` variable to the name of the file to be
|
||||||
included.
|
included.
|
||||||
|
|
||||||
|
@ -2,7 +2,7 @@ apply.ignoreWhitespace::
|
|||||||
When set to 'change', tells 'git apply' to ignore changes in
|
When set to 'change', tells 'git apply' to ignore changes in
|
||||||
whitespace, in the same way as the `--ignore-space-change`
|
whitespace, in the same way as the `--ignore-space-change`
|
||||||
option.
|
option.
|
||||||
When set to one of: no, none, never, false tells 'git apply' to
|
When set to one of: no, none, never, false, it tells 'git apply' to
|
||||||
respect all whitespace differences.
|
respect all whitespace differences.
|
||||||
See linkgit:git-apply[1].
|
See linkgit:git-apply[1].
|
||||||
|
|
||||||
|
@ -36,7 +36,7 @@ branch.sort::
|
|||||||
|
|
||||||
branch.<name>.remote::
|
branch.<name>.remote::
|
||||||
When on branch <name>, it tells 'git fetch' and 'git push'
|
When on branch <name>, it tells 'git fetch' and 'git push'
|
||||||
which remote to fetch from/push to. The remote to push to
|
which remote to fetch from or push to. The remote to push to
|
||||||
may be overridden with `remote.pushDefault` (for all branches).
|
may be overridden with `remote.pushDefault` (for all branches).
|
||||||
The remote to push to, for the current branch, may be further
|
The remote to push to, for the current branch, may be further
|
||||||
overridden by `branch.<name>.pushRemote`. If no remote is
|
overridden by `branch.<name>.pushRemote`. If no remote is
|
||||||
|
@ -4,8 +4,8 @@ clone.defaultRemoteName::
|
|||||||
option to linkgit:git-clone[1].
|
option to linkgit:git-clone[1].
|
||||||
|
|
||||||
clone.rejectShallow::
|
clone.rejectShallow::
|
||||||
Reject to clone a repository if it is a shallow one, can be overridden by
|
Reject to clone a repository if it is a shallow one; this can be overridden by
|
||||||
passing option `--reject-shallow` in command line. See linkgit:git-clone[1]
|
passing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]
|
||||||
|
|
||||||
clone.filterSubmodules::
|
clone.filterSubmodules::
|
||||||
If a partial clone filter is provided (see `--filter` in
|
If a partial clone filter is provided (see `--filter` in
|
||||||
|
@ -31,6 +31,6 @@ credentialCache.ignoreSIGHUP::
|
|||||||
|
|
||||||
credentialStore.lockTimeoutMS::
|
credentialStore.lockTimeoutMS::
|
||||||
The length of time, in milliseconds, for git-credential-store to retry
|
The length of time, in milliseconds, for git-credential-store to retry
|
||||||
when trying to lock the credentials file. Value 0 means not to retry at
|
when trying to lock the credentials file. A value of 0 means not to retry at
|
||||||
all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
|
all; -1 means to try indefinitely. Default is 1000 (i.e., retry for
|
||||||
1s).
|
1s).
|
||||||
|
@ -52,8 +52,8 @@ fetch.pruneTags::
|
|||||||
|
|
||||||
fetch.output::
|
fetch.output::
|
||||||
Control how ref update status is printed. Valid values are
|
Control how ref update status is printed. Valid values are
|
||||||
`full` and `compact`. Default value is `full`. See section
|
`full` and `compact`. Default value is `full`. See the
|
||||||
OUTPUT in linkgit:git-fetch[1] for detail.
|
OUTPUT section in linkgit:git-fetch[1] for detail.
|
||||||
|
|
||||||
fetch.negotiationAlgorithm::
|
fetch.negotiationAlgorithm::
|
||||||
Control how information about the commits in the local repository
|
Control how information about the commits in the local repository
|
||||||
|
@ -17,7 +17,7 @@ Unlike variables like `color.ui` and `core.editor` the
|
|||||||
`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
|
`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
|
||||||
fall back on the `fsck.<msg-id>` configuration if they aren't set. To
|
fall back on the `fsck.<msg-id>` configuration if they aren't set. To
|
||||||
uniformly configure the same fsck settings in different circumstances
|
uniformly configure the same fsck settings in different circumstances
|
||||||
all three of them they must all set to the same values.
|
all three of them must be set to the same values.
|
||||||
+
|
+
|
||||||
When `fsck.<msg-id>` is set, errors can be switched to warnings and
|
When `fsck.<msg-id>` is set, errors can be switched to warnings and
|
||||||
vice versa by configuring the `fsck.<msg-id>` setting where the
|
vice versa by configuring the `fsck.<msg-id>` setting where the
|
||||||
@ -59,7 +59,7 @@ Unlike variables like `color.ui` and `core.editor` the
|
|||||||
`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
|
`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
|
||||||
fall back on the `fsck.skipList` configuration if they aren't set. To
|
fall back on the `fsck.skipList` configuration if they aren't set. To
|
||||||
uniformly configure the same fsck settings in different circumstances
|
uniformly configure the same fsck settings in different circumstances
|
||||||
all three of them they must all set to the same values.
|
all three of them must be set to the same values.
|
||||||
+
|
+
|
||||||
Older versions of Git (before 2.20) documented that the object names
|
Older versions of Git (before 2.20) documented that the object names
|
||||||
list should be sorted. This was never a requirement, the object names
|
list should be sorted. This was never a requirement, the object names
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
fsmonitor.allowRemote::
|
fsmonitor.allowRemote::
|
||||||
By default, the fsmonitor daemon refuses to work against network-mounted
|
By default, the fsmonitor daemon refuses to work with network-mounted
|
||||||
repositories. Setting `fsmonitor.allowRemote` to `true` overrides this
|
repositories. Setting `fsmonitor.allowRemote` to `true` overrides this
|
||||||
behavior. Only respected when `core.fsmonitor` is set to `true`.
|
behavior. Only respected when `core.fsmonitor` is set to `true`.
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ gc.auto::
|
|||||||
default value is 6700.
|
default value is 6700.
|
||||||
+
|
+
|
||||||
Setting this to 0 disables not only automatic packing based on the
|
Setting this to 0 disables not only automatic packing based on the
|
||||||
number of loose objects, but any other heuristic `git gc --auto` will
|
number of loose objects, but also any other heuristic `git gc --auto` will
|
||||||
otherwise use to determine if there's work to do, such as
|
otherwise use to determine if there's work to do, such as
|
||||||
`gc.autoPackLimit`.
|
`gc.autoPackLimit`.
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@ gpg.program::
|
|||||||
same command-line interface as GPG, namely, to verify a detached
|
same command-line interface as GPG, namely, to verify a detached
|
||||||
signature, "`gpg --verify $signature - <$file`" is run, and the
|
signature, "`gpg --verify $signature - <$file`" is run, and the
|
||||||
program is expected to signal a good signature by exiting with
|
program is expected to signal a good signature by exiting with
|
||||||
code 0, and to generate an ASCII-armored detached signature, the
|
code 0. To generate an ASCII-armored detached signature, the
|
||||||
standard input of "`gpg -bsau $key`" is fed with the contents to be
|
standard input of "`gpg -bsau $key`" is fed with the contents to be
|
||||||
signed, and the program is expected to send the result to its
|
signed, and the program is expected to send the result to its
|
||||||
standard output.
|
standard output.
|
||||||
|
@ -260,7 +260,7 @@ http.noEPSV::
|
|||||||
|
|
||||||
http.userAgent::
|
http.userAgent::
|
||||||
The HTTP USER_AGENT string presented to an HTTP server. The default
|
The HTTP USER_AGENT string presented to an HTTP server. The default
|
||||||
value represents the version of the client Git such as git/1.7.1.
|
value represents the version of the Git client such as git/1.7.1.
|
||||||
This option allows you to override this value to a more common value
|
This option allows you to override this value to a more common value
|
||||||
such as Mozilla/4.0. This may be necessary, for instance, if
|
such as Mozilla/4.0. This may be necessary, for instance, if
|
||||||
connecting through a firewall that restricts HTTP connections to a set
|
connecting through a firewall that restricts HTTP connections to a set
|
||||||
|
@ -37,7 +37,7 @@ imap.preformattedHTML::
|
|||||||
format=fixed email. Default is `false`.
|
format=fixed email. Default is `false`.
|
||||||
|
|
||||||
imap.authMethod::
|
imap.authMethod::
|
||||||
Specify authenticate method for authentication with IMAP server.
|
Specify the authentication method for authenticating with the IMAP server.
|
||||||
If Git was built with the NO_CURL option, or if your curl version is older
|
If Git was built with the NO_CURL option, or if your curl version is older
|
||||||
than 7.34.0, or if you're running git-imap-send with the `--no-curl`
|
than 7.34.0, or if you're running git-imap-send with the `--no-curl`
|
||||||
option, the only supported method is 'CRAM-MD5'. If this is not set
|
option, the only supported method is 'CRAM-MD5'. If this is not set
|
||||||
|
@ -47,7 +47,7 @@ mergetool.meld.useAutoMerge::
|
|||||||
|
|
||||||
mergetool.vimdiff.layout::
|
mergetool.vimdiff.layout::
|
||||||
The vimdiff backend uses this variable to control how its split
|
The vimdiff backend uses this variable to control how its split
|
||||||
windows look like. Applies even if you are using Neovim (`nvim`) or
|
windows appear. Applies even if you are using Neovim (`nvim`) or
|
||||||
gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
|
gVim (`gvim`) as the merge tool. See BACKEND SPECIFIC HINTS section
|
||||||
ifndef::git-mergetool[]
|
ifndef::git-mergetool[]
|
||||||
in linkgit:git-mergetool[1].
|
in linkgit:git-mergetool[1].
|
||||||
|
@ -83,7 +83,7 @@ pack.indexVersion::
|
|||||||
the new pack index with capabilities for packs larger than 4 GB
|
the new pack index with capabilities for packs larger than 4 GB
|
||||||
as well as proper protection against the repacking of corrupted
|
as well as proper protection against the repacking of corrupted
|
||||||
packs. Version 2 is the default. Note that version 2 is enforced
|
packs. Version 2 is the default. Note that version 2 is enforced
|
||||||
and this config option ignored whenever the corresponding pack is
|
and this config option is ignored whenever the corresponding pack is
|
||||||
larger than 2 GB.
|
larger than 2 GB.
|
||||||
+
|
+
|
||||||
If you have an old Git that does not understand the version 2 `*.idx` file,
|
If you have an old Git that does not understand the version 2 `*.idx` file,
|
||||||
@ -102,8 +102,8 @@ pack.packSizeLimit::
|
|||||||
in the creation of multiple packfiles.
|
in the creation of multiple packfiles.
|
||||||
+
|
+
|
||||||
Note that this option is rarely useful, and may result in a larger total
|
Note that this option is rarely useful, and may result in a larger total
|
||||||
on-disk size (because Git will not store deltas between packs), as well
|
on-disk size (because Git will not store deltas between packs) and
|
||||||
as worse runtime performance (object lookup within multiple packs is
|
worse runtime performance (object lookup within multiple packs is
|
||||||
slower than a single pack, and optimizations like reachability bitmaps
|
slower than a single pack, and optimizations like reachability bitmaps
|
||||||
cannot cope with multiple packs).
|
cannot cope with multiple packs).
|
||||||
+
|
+
|
||||||
|
@ -19,7 +19,7 @@ receive.certNonceSeed::
|
|||||||
key.
|
key.
|
||||||
|
|
||||||
receive.certNonceSlop::
|
receive.certNonceSlop::
|
||||||
When a `git push --signed` sent a push certificate with a
|
When a `git push --signed` sends a push certificate with a
|
||||||
"nonce" that was issued by a receive-pack serving the same
|
"nonce" that was issued by a receive-pack serving the same
|
||||||
repository within this many seconds, export the "nonce"
|
repository within this many seconds, export the "nonce"
|
||||||
found in the certificate to `GIT_PUSH_CERT_NONCE` to the
|
found in the certificate to `GIT_PUSH_CERT_NONCE` to the
|
||||||
|
@ -14,7 +14,7 @@ repository that contains a bare repository and running a Git command
|
|||||||
within that directory.
|
within that directory.
|
||||||
+
|
+
|
||||||
This config setting is only respected in protected configuration (see
|
This config setting is only respected in protected configuration (see
|
||||||
<<SCOPES>>). This prevents the untrusted repository from tampering with
|
<<SCOPES>>). This prevents untrusted repositories from tampering with
|
||||||
this value.
|
this value.
|
||||||
|
|
||||||
safe.directory::
|
safe.directory::
|
||||||
@ -32,7 +32,7 @@ override any such directories specified in the system config), add a
|
|||||||
`safe.directory` entry with an empty value.
|
`safe.directory` entry with an empty value.
|
||||||
+
|
+
|
||||||
This config setting is only respected in protected configuration (see
|
This config setting is only respected in protected configuration (see
|
||||||
<<SCOPES>>). This prevents the untrusted repository from tampering with this
|
<<SCOPES>>). This prevents untrusted repositories from tampering with this
|
||||||
value.
|
value.
|
||||||
+
|
+
|
||||||
The value of this setting is interpolated, i.e. `~/<path>` expands to a
|
The value of this setting is interpolated, i.e. `~/<path>` expands to a
|
||||||
|
@ -2,7 +2,7 @@ submodule.<name>.url::
|
|||||||
The URL for a submodule. This variable is copied from the .gitmodules
|
The URL for a submodule. This variable is copied from the .gitmodules
|
||||||
file to the git config via 'git submodule init'. The user can change
|
file to the git config via 'git submodule init'. The user can change
|
||||||
the configured URL before obtaining the submodule via 'git submodule
|
the configured URL before obtaining the submodule via 'git submodule
|
||||||
update'. If neither submodule.<name>.active or submodule.active are
|
update'. If neither submodule.<name>.active nor submodule.active are
|
||||||
set, the presence of this variable is used as a fallback to indicate
|
set, the presence of this variable is used as a fallback to indicate
|
||||||
whether the submodule is of interest to git commands.
|
whether the submodule is of interest to git commands.
|
||||||
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
|
See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
|
||||||
|
@ -66,6 +66,6 @@ trace2.destinationDebug::
|
|||||||
|
|
||||||
trace2.maxFiles::
|
trace2.maxFiles::
|
||||||
Integer. When writing trace files to a target directory, do not
|
Integer. When writing trace files to a target directory, do not
|
||||||
write additional traces if we would exceed this many files. Instead,
|
write additional traces if doing so would exceed this many files. Instead,
|
||||||
write a sentinel file that will block further tracing to this
|
write a sentinel file that will block further tracing to this
|
||||||
directory. Defaults to 0, which disables this check.
|
directory. Defaults to 0, which disables this check.
|
||||||
|
@ -7,7 +7,7 @@ transfer.credentialsInUrl::
|
|||||||
and any other direct use of the configured URL.
|
and any other direct use of the configured URL.
|
||||||
+
|
+
|
||||||
Note that this is currently limited to detecting credentials in
|
Note that this is currently limited to detecting credentials in
|
||||||
`remote.<name>.url` configuration, it won't detect credentials in
|
`remote.<name>.url` configuration; it won't detect credentials in
|
||||||
`remote.<name>.pushurl` configuration.
|
`remote.<name>.pushurl` configuration.
|
||||||
+
|
+
|
||||||
You might want to enable this to prevent inadvertent credentials
|
You might want to enable this to prevent inadvertent credentials
|
||||||
@ -26,7 +26,7 @@ exposure, e.g. because:
|
|||||||
documented in procfs(5) allows for configuring this behavior.
|
documented in procfs(5) allows for configuring this behavior.
|
||||||
+
|
+
|
||||||
If such concerns don't apply to you then you probably don't need to be
|
If such concerns don't apply to you then you probably don't need to be
|
||||||
concerned about credentials exposure due to storing that sensitive
|
concerned about credentials exposure due to storing sensitive
|
||||||
data in git's configuration files. If you do want to use this, set
|
data in git's configuration files. If you do want to use this, set
|
||||||
`transfer.credentialsInUrl` to one of these values:
|
`transfer.credentialsInUrl` to one of these values:
|
||||||
+
|
+
|
||||||
|
@ -10,7 +10,7 @@ committer.email::
|
|||||||
If you need the `author` or `committer` to be different, the
|
If you need the `author` or `committer` to be different, the
|
||||||
`author.name`, `author.email`, `committer.name` or
|
`author.name`, `author.email`, `committer.name` or
|
||||||
`committer.email` variables can be set.
|
`committer.email` variables can be set.
|
||||||
Also, all of these can be overridden by the `GIT_AUTHOR_NAME`,
|
All of these can be overridden by the `GIT_AUTHOR_NAME`,
|
||||||
`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
|
`GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`,
|
||||||
`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
|
`GIT_COMMITTER_EMAIL` and `EMAIL` environment variables.
|
||||||
+
|
+
|
||||||
|
@ -146,7 +146,7 @@ information about detected contents movement (renames and
|
|||||||
copying detection) are designed to work with diff of two
|
copying detection) are designed to work with diff of two
|
||||||
<tree-ish> and are not used by combined diff format.
|
<tree-ish> and are not used by combined diff format.
|
||||||
|
|
||||||
3. It is followed by two-line from-file/to-file header
|
3. It is followed by a two-line from-file/to-file header:
|
||||||
|
|
||||||
--- a/file
|
--- a/file
|
||||||
+++ b/file
|
+++ b/file
|
||||||
@ -157,7 +157,7 @@ files.
|
|||||||
+
|
+
|
||||||
However, if the --combined-all-paths option is provided, instead of a
|
However, if the --combined-all-paths option is provided, instead of a
|
||||||
two-line from-file/to-file you get a N+1 line from-file/to-file header,
|
two-line from-file/to-file you get a N+1 line from-file/to-file header,
|
||||||
where N is the number of parents in the merge commit
|
where N is the number of parents in the merge commit:
|
||||||
|
|
||||||
--- a/file
|
--- a/file
|
||||||
--- a/file
|
--- a/file
|
||||||
|
@ -733,7 +733,7 @@ matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
|
|||||||
--rotate-to=<file>::
|
--rotate-to=<file>::
|
||||||
Discard the files before the named <file> from the output
|
Discard the files before the named <file> from the output
|
||||||
(i.e. 'skip to'), or move them to the end of the output
|
(i.e. 'skip to'), or move them to the end of the output
|
||||||
(i.e. 'rotate to'). These were invented primarily for use
|
(i.e. 'rotate to'). These options were invented primarily for the use
|
||||||
of the `git difftool` command, and may not be very useful
|
of the `git difftool` command, and may not be very useful
|
||||||
otherwise.
|
otherwise.
|
||||||
|
|
||||||
|
@ -159,7 +159,7 @@ discouraged.
|
|||||||
|
|
||||||
--allow-binary-replacement::
|
--allow-binary-replacement::
|
||||||
--binary::
|
--binary::
|
||||||
Historically we did not allow binary patch applied
|
Historically we did not allow binary patch application
|
||||||
without an explicit permission from the user, and this
|
without an explicit permission from the user, and this
|
||||||
flag was the way to do so. Currently we always allow binary
|
flag was the way to do so. Currently we always allow binary
|
||||||
patch application, so this is a no-op.
|
patch application, so this is a no-op.
|
||||||
|
@ -21,14 +21,14 @@ structure for the named tree, and writes it out to the standard
|
|||||||
output. If <prefix> is specified it is
|
output. If <prefix> is specified it is
|
||||||
prepended to the filenames in the archive.
|
prepended to the filenames in the archive.
|
||||||
|
|
||||||
'git archive' behaves differently when given a tree ID versus when
|
'git archive' behaves differently when given a tree ID as opposed to a
|
||||||
given a commit ID or tag ID. In the first case the current time is
|
commit ID or tag ID. When a tree ID is provided, the current time is
|
||||||
used as the modification time of each file in the archive. In the latter
|
used as the modification time of each file in the archive. On the
|
||||||
case the commit time as recorded in the referenced commit object is
|
other hand, when a commit ID or tag ID is provided, the commit time as
|
||||||
used instead. Additionally the commit ID is stored in a global
|
recorded in the referenced commit object is used instead.
|
||||||
extended pax header if the tar format is used; it can be extracted
|
Additionally the commit ID is stored in a global extended pax header
|
||||||
using 'git get-tar-commit-id'. In ZIP files it is stored as a file
|
if the tar format is used; it can be extracted using 'git
|
||||||
comment.
|
get-tar-commit-id'. In ZIP files it is stored as a file comment.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
|
@ -13,10 +13,11 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Captures information about the user's machine, Git client, and repository state,
|
Collects information about the user's machine, Git client, and repository
|
||||||
as well as a form requesting information about the behavior the user observed,
|
state, in addition to a form requesting information about the behavior the
|
||||||
into a single text file which the user can then share, for example to the Git
|
user observed, and stores it in a single text file which the user can then
|
||||||
mailing list, in order to report an observed bug.
|
share, for example to the Git mailing list, in order to report an observed
|
||||||
|
bug.
|
||||||
|
|
||||||
The following information is requested from the user:
|
The following information is requested from the user:
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Will copy all files listed from the index to the working directory
|
Copies all listed files from the index to the working directory
|
||||||
(not overwriting existing files).
|
(not overwriting existing files).
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
|
@ -12,7 +12,7 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This counts the number of unpacked object files and disk space consumed by
|
Counts the number of unpacked object files and disk space consumed by
|
||||||
them, to help you decide when it is a good time to repack.
|
them, to help you decide when it is a good time to repack.
|
||||||
|
|
||||||
|
|
||||||
@ -20,7 +20,7 @@ OPTIONS
|
|||||||
-------
|
-------
|
||||||
-v::
|
-v::
|
||||||
--verbose::
|
--verbose::
|
||||||
Report in more detail:
|
Provide more detailed reports:
|
||||||
+
|
+
|
||||||
count: the number of loose objects
|
count: the number of loose objects
|
||||||
+
|
+
|
||||||
|
@ -94,7 +94,7 @@ unlocked) before it returned `password=secr3t`.
|
|||||||
that `git credential` will ask for a new password in its next
|
that `git credential` will ask for a new password in its next
|
||||||
invocation. In either case, `git credential` should be fed with
|
invocation. In either case, `git credential` should be fed with
|
||||||
the credential description obtained from step (2) (which also
|
the credential description obtained from step (2) (which also
|
||||||
contain the ones provided in step (1)).
|
contains the fields provided in step (1)).
|
||||||
|
|
||||||
[[IOFMT]]
|
[[IOFMT]]
|
||||||
INPUT/OUTPUT FORMAT
|
INPUT/OUTPUT FORMAT
|
||||||
|
@ -13,10 +13,10 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Compares the content and mode of the blobs found in a tree object
|
Compare the content and mode of the blobs found in a tree object
|
||||||
with the corresponding tracked files in the working tree, or with the
|
with the corresponding tracked files in the working tree, or with the
|
||||||
corresponding paths in the index. When <path> arguments are present,
|
corresponding paths in the index. When <path> arguments are present,
|
||||||
compares only paths matching those patterns. Otherwise all tracked
|
compare only paths matching those patterns. Otherwise all tracked
|
||||||
files are compared.
|
files are compared.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
|
@ -15,7 +15,7 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Compares the content and mode of the blobs found via two tree objects.
|
Compare the content and mode of blobs found via two tree objects.
|
||||||
|
|
||||||
If there is only one <tree-ish> given, the commit is compared with its parents
|
If there is only one <tree-ish> given, the commit is compared with its parents
|
||||||
(see --stdin below).
|
(see --stdin below).
|
||||||
|
@ -622,7 +622,7 @@ in octal. Git only supports the following modes:
|
|||||||
* `100755` or `755`: A normal, but executable, file.
|
* `100755` or `755`: A normal, but executable, file.
|
||||||
* `120000`: A symlink, the content of the file will be the link target.
|
* `120000`: A symlink, the content of the file will be the link target.
|
||||||
* `160000`: A gitlink, SHA-1 of the object refers to a commit in
|
* `160000`: A gitlink, SHA-1 of the object refers to a commit in
|
||||||
another repository. Git links can only be specified by SHA or through
|
another repository. Git links can only be specified either by SHA or through
|
||||||
a commit mark. They are used to implement submodules.
|
a commit mark. They are used to implement submodules.
|
||||||
* `040000`: A subdirectory. Subdirectories can only be specified by
|
* `040000`: A subdirectory. Subdirectories can only be specified by
|
||||||
SHA or through a tree mark set with `--import-marks`.
|
SHA or through a tree mark set with `--import-marks`.
|
||||||
|
@ -39,10 +39,10 @@ OPTIONS
|
|||||||
of from the command-line.
|
of from the command-line.
|
||||||
|
|
||||||
--path::
|
--path::
|
||||||
Hash object as it were located at the given path. The location of
|
Hash object as if it were located at the given path. The location of
|
||||||
file does not directly influence on the hash value, but path is
|
the file does not directly influence the hash value, but the path is
|
||||||
used to determine what Git filters should be applied to the object
|
used to determine which Git filters should be applied to the object
|
||||||
before it can be placed to the object database, and, as result of
|
before it can be placed in the object database. As a result of
|
||||||
applying filters, the actual blob put into the object database may
|
applying filters, the actual blob put into the object database may
|
||||||
differ from the given file. This option is mainly useful for hashing
|
differ from the given file. This option is mainly useful for hashing
|
||||||
temporary files located outside of the working directory or files
|
temporary files located outside of the working directory or files
|
||||||
|
@ -109,7 +109,7 @@ other display programs (see below).
|
|||||||
format. A web browser will be used for that purpose.
|
format. A web browser will be used for that purpose.
|
||||||
+
|
+
|
||||||
The web browser can be specified using the configuration variable
|
The web browser can be specified using the configuration variable
|
||||||
`help.browser`, or `web.browser` if the former is not set. If none of
|
`help.browser`, or `web.browser` if the former is not set. If neither of
|
||||||
these config variables is set, the 'git web{litdd}browse' helper script
|
these config variables is set, the 'git web{litdd}browse' helper script
|
||||||
(called by 'git help') will pick a suitable default. See
|
(called by 'git help') will pick a suitable default. See
|
||||||
linkgit:git-web{litdd}browse[1] for more information about this.
|
linkgit:git-web{litdd}browse[1] for more information about this.
|
||||||
|
@ -23,7 +23,7 @@ discussion of `GIT_PROTOCOL` in the ENVIRONMENT section below.
|
|||||||
It verifies that the directory has the magic file
|
It verifies that the directory has the magic file
|
||||||
"git-daemon-export-ok", and it will refuse to export any Git directory
|
"git-daemon-export-ok", and it will refuse to export any Git directory
|
||||||
that hasn't explicitly been marked for export this way (unless the
|
that hasn't explicitly been marked for export this way (unless the
|
||||||
`GIT_HTTP_EXPORT_ALL` environmental variable is set).
|
`GIT_HTTP_EXPORT_ALL` environment variable is set).
|
||||||
|
|
||||||
By default, only the `upload-pack` service is enabled, which serves
|
By default, only the `upload-pack` service is enabled, which serves
|
||||||
'git fetch-pack' and 'git ls-remote' clients, which are invoked from
|
'git fetch-pack' and 'git ls-remote' clients, which are invoked from
|
||||||
@ -42,12 +42,12 @@ http.getanyfile::
|
|||||||
any file within the repository, including objects that are
|
any file within the repository, including objects that are
|
||||||
no longer reachable from a branch but are still present.
|
no longer reachable from a branch but are still present.
|
||||||
It is enabled by default, but a repository can disable it
|
It is enabled by default, but a repository can disable it
|
||||||
by setting this configuration item to `false`.
|
by setting this configuration value to `false`.
|
||||||
|
|
||||||
http.uploadpack::
|
http.uploadpack::
|
||||||
This serves 'git fetch-pack' and 'git ls-remote' clients.
|
This serves 'git fetch-pack' and 'git ls-remote' clients.
|
||||||
It is enabled by default, but a repository can disable it
|
It is enabled by default, but a repository can disable it
|
||||||
by setting this configuration item to `false`.
|
by setting this configuration value to `false`.
|
||||||
|
|
||||||
http.receivepack::
|
http.receivepack::
|
||||||
This serves 'git send-pack' clients, allowing push. It is
|
This serves 'git send-pack' clients, allowing push. It is
|
||||||
@ -265,12 +265,12 @@ by the invoking web server, including:
|
|||||||
* QUERY_STRING
|
* QUERY_STRING
|
||||||
* REQUEST_METHOD
|
* REQUEST_METHOD
|
||||||
|
|
||||||
The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to
|
The `GIT_HTTP_EXPORT_ALL` environment variable may be passed to
|
||||||
'git-http-backend' to bypass the check for the "git-daemon-export-ok"
|
'git-http-backend' to bypass the check for the "git-daemon-export-ok"
|
||||||
file in each repository before allowing export of that repository.
|
file in each repository before allowing export of that repository.
|
||||||
|
|
||||||
The `GIT_HTTP_MAX_REQUEST_BUFFER` environment variable (or the
|
The `GIT_HTTP_MAX_REQUEST_BUFFER` environment variable (or the
|
||||||
`http.maxRequestBuffer` config variable) may be set to change the
|
`http.maxRequestBuffer` config option) may be set to change the
|
||||||
largest ref negotiation request that git will handle during a fetch; any
|
largest ref negotiation request that git will handle during a fetch; any
|
||||||
fetch requiring a larger buffer will not succeed. This value should not
|
fetch requiring a larger buffer will not succeed. This value should not
|
||||||
normally need to be changed, but may be helpful if you are fetching from
|
normally need to be changed, but may be helpful if you are fetching from
|
||||||
|
@ -31,7 +31,7 @@ commit-id::
|
|||||||
Report what is downloaded.
|
Report what is downloaded.
|
||||||
|
|
||||||
-w <filename>::
|
-w <filename>::
|
||||||
Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on
|
Writes the commit-id into the specified filename under $GIT_DIR/refs/<filename> on
|
||||||
the local end after the transfer is complete.
|
the local end after the transfer is complete.
|
||||||
|
|
||||||
--stdin::
|
--stdin::
|
||||||
|
@ -83,8 +83,8 @@ and where it is pushed is determined by using the destination side.
|
|||||||
Without `--force`, the <src> ref is stored at the remote only if
|
Without `--force`, the <src> ref is stored at the remote only if
|
||||||
<dst> does not exist, or <dst> is a proper subset (i.e. an
|
<dst> does not exist, or <dst> is a proper subset (i.e. an
|
||||||
ancestor) of <src>. This check, known as "fast-forward check",
|
ancestor) of <src>. This check, known as "fast-forward check",
|
||||||
is performed in order to avoid accidentally overwriting the
|
is performed to avoid accidentally overwriting the
|
||||||
remote ref and lose other peoples' commits from there.
|
remote ref and losing other peoples' commits from there.
|
||||||
|
|
||||||
With `--force`, the fast-forward check is disabled for all refs.
|
With `--force`, the fast-forward check is disabled for all refs.
|
||||||
|
|
||||||
|
@ -16,10 +16,10 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Reads a packed archive (.pack) from the specified file, and
|
Reads a packed archive (.pack) from the specified file,
|
||||||
builds a pack index file (.idx) for it. Optionally writes a
|
builds a pack index file (.idx) for it, and optionally writes a
|
||||||
reverse-index (.rev) for the specified pack. The packed
|
reverse-index (.rev) for the specified pack. The packed
|
||||||
archive together with the pack index can then be placed in
|
archive, together with the pack index, can then be placed in
|
||||||
the objects/pack/ directory of a Git repository.
|
the objects/pack/ directory of a Git repository.
|
||||||
|
|
||||||
|
|
||||||
@ -68,8 +68,8 @@ OPTIONS
|
|||||||
updated to use objects contained in the pack.
|
updated to use objects contained in the pack.
|
||||||
|
|
||||||
--keep=<msg>::
|
--keep=<msg>::
|
||||||
Like --keep create a .keep file before moving the index into
|
Like --keep, create a .keep file before moving the index into
|
||||||
its final destination, but rather than creating an empty file
|
its final destination. However, instead of creating an empty file
|
||||||
place '<msg>' followed by an LF into the .keep file. The '<msg>'
|
place '<msg>' followed by an LF into the .keep file. The '<msg>'
|
||||||
message can later be searched for within all .keep files to
|
message can later be searched for within all .keep files to
|
||||||
locate any which have outlived their usefulness.
|
locate any which have outlived their usefulness.
|
||||||
|
@ -99,7 +99,7 @@ specified.
|
|||||||
|
|
||||||
'group' (or 'true')::
|
'group' (or 'true')::
|
||||||
|
|
||||||
Make the repository group-writable, (and g+sx, since the git group may be not
|
Make the repository group-writable, (and g+sx, since the git group may not be
|
||||||
the primary group of all users). This is used to loosen the permissions of an
|
the primary group of all users). This is used to loosen the permissions of an
|
||||||
otherwise safe umask(2) value. Note that the umask still applies to the other
|
otherwise safe umask(2) value. Note that the umask still applies to the other
|
||||||
permission bits (e.g. if umask is '0022', using 'group' will not remove read
|
permission bits (e.g. if umask is '0022', using 'group' will not remove read
|
||||||
|
@ -25,12 +25,12 @@ SYNOPSIS
|
|||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This merges the file listing in the index with the actual working
|
This command merges the file listing in the index with the actual working
|
||||||
directory list, and shows different combinations of the two.
|
directory list, and shows different combinations of the two.
|
||||||
|
|
||||||
One or more of the options below may be used to determine the files
|
Several flags can be used to determine which files are
|
||||||
shown, and each file may be printed multiple times if there are
|
shown, and each file may be printed multiple times if there are
|
||||||
multiple entries in the index or multiple statuses are applicable for
|
multiple entries in the index or if multiple statuses are applicable for
|
||||||
the relevant file selection options.
|
the relevant file selection options.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
|
@ -102,9 +102,9 @@ prefetch::
|
|||||||
requested refs within `refs/prefetch/`. Also, tags are not updated.
|
requested refs within `refs/prefetch/`. Also, tags are not updated.
|
||||||
+
|
+
|
||||||
This is done to avoid disrupting the remote-tracking branches. The end users
|
This is done to avoid disrupting the remote-tracking branches. The end users
|
||||||
expect these refs to stay unmoved unless they initiate a fetch. With prefetch
|
expect these refs to stay unmoved unless they initiate a fetch. However,
|
||||||
task, however, the objects necessary to complete a later real fetch would
|
with the prefetch task, the objects necessary to complete a later real fetch
|
||||||
already be obtained, so the real fetch would go faster. In the ideal case,
|
would already be obtained, making the real fetch faster. In the ideal case,
|
||||||
it will just become an update to a bunch of remote-tracking branches without
|
it will just become an update to a bunch of remote-tracking branches without
|
||||||
any object transfer.
|
any object transfer.
|
||||||
|
|
||||||
|
@ -336,7 +336,7 @@ After seeing a conflict, you can do two things:
|
|||||||
You can work through the conflict with a number of tools:
|
You can work through the conflict with a number of tools:
|
||||||
|
|
||||||
* Use a mergetool. `git mergetool` to launch a graphical
|
* Use a mergetool. `git mergetool` to launch a graphical
|
||||||
mergetool which will work you through the merge.
|
mergetool which will work through the merge with you.
|
||||||
|
|
||||||
* Look at the diffs. `git diff` will show a three-way diff,
|
* Look at the diffs. `git diff` will show a three-way diff,
|
||||||
highlighting changes from both the `HEAD` and `MERGE_HEAD`
|
highlighting changes from both the `HEAD` and `MERGE_HEAD`
|
||||||
|
@ -115,7 +115,7 @@ These are safe to remove once a file has been merged and its
|
|||||||
`git mergetool` session has completed.
|
`git mergetool` session has completed.
|
||||||
|
|
||||||
Setting the `mergetool.keepBackup` configuration variable to `false`
|
Setting the `mergetool.keepBackup` configuration variable to `false`
|
||||||
causes `git mergetool` to automatically remove the backup as files
|
causes `git mergetool` to automatically remove the backup files as files
|
||||||
are successfully merged.
|
are successfully merged.
|
||||||
|
|
||||||
BACKEND SPECIFIC HINTS
|
BACKEND SPECIFIC HINTS
|
||||||
|
@ -25,13 +25,13 @@ OPTIONS
|
|||||||
|
|
||||||
--missing::
|
--missing::
|
||||||
Allow missing objects. The default behaviour (without this option)
|
Allow missing objects. The default behaviour (without this option)
|
||||||
is to verify that each tree entry's sha1 identifies an existing
|
is to verify that each tree entry's hash identifies an existing
|
||||||
object. This option has no effect on the treatment of gitlink entries
|
object. This option has no effect on the treatment of gitlink entries
|
||||||
(aka "submodules") which are always allowed to be missing.
|
(aka "submodules") which are always allowed to be missing.
|
||||||
|
|
||||||
--batch::
|
--batch::
|
||||||
Allow building of more than one tree object before exiting. Each
|
Allow building of more than one tree object before exiting. Each
|
||||||
tree is separated by a single blank line. The final new-line is
|
tree is separated by a single blank line. The final newline is
|
||||||
optional. Note - if the `-z` option is used, lines are terminated
|
optional. Note - if the `-z` option is used, lines are terminated
|
||||||
with NUL.
|
with NUL.
|
||||||
|
|
||||||
|
@ -70,7 +70,7 @@ to revert to color all lines according to the outer diff markers
|
|||||||
Defaults to 60. Try a larger value if `git range-diff` erroneously
|
Defaults to 60. Try a larger value if `git range-diff` erroneously
|
||||||
considers a large change a total rewrite (deletion of one commit
|
considers a large change a total rewrite (deletion of one commit
|
||||||
and addition of another), and a smaller one in the reverse case.
|
and addition of another), and a smaller one in the reverse case.
|
||||||
See the ``Algorithm`` section below for an explanation why this is
|
See the ``Algorithm`` section below for an explanation of why this is
|
||||||
needed.
|
needed.
|
||||||
|
|
||||||
--left-only::
|
--left-only::
|
||||||
|
@ -25,7 +25,7 @@ fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m`
|
|||||||
flag. When used with `-m`, the `-u` flag causes it to also update
|
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.
|
||||||
|
|
||||||
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 unmerged state when 'git read-tree' returns.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
|
@ -82,7 +82,7 @@ begins with `ext::`. Examples:
|
|||||||
|
|
||||||
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
|
"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
|
Like host.example:foo/repo, but use /home/foo/.ssh/somekey as
|
||||||
keypair and user as user on remote side. This avoids needing to
|
keypair and user as user on 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"::
|
||||||
|
@ -165,7 +165,7 @@ depth is 4095.
|
|||||||
Exclude the given pack from repacking. This is the equivalent
|
Exclude the given pack from repacking. This is the equivalent
|
||||||
of having `.keep` file on the pack. `<pack-name>` is the
|
of having `.keep` file on the pack. `<pack-name>` is the
|
||||||
pack file name without leading directory (e.g. `pack-123.pack`).
|
pack file name without leading directory (e.g. `pack-123.pack`).
|
||||||
The option could be specified multiple times to keep multiple
|
The option can be specified multiple times to keep multiple
|
||||||
packs.
|
packs.
|
||||||
|
|
||||||
--unpack-unreachable=<when>::
|
--unpack-unreachable=<when>::
|
||||||
|
@ -105,7 +105,7 @@ in linkgit:git-checkout[1] for details.
|
|||||||
specified. Unmerged paths on the working tree are left alone.
|
specified. Unmerged paths on the working tree are left alone.
|
||||||
|
|
||||||
--ignore-skip-worktree-bits::
|
--ignore-skip-worktree-bits::
|
||||||
In sparse checkout mode, by default is to only update entries
|
In sparse checkout mode, the default is to only update entries
|
||||||
matched by `<pathspec>` and sparse patterns in
|
matched by `<pathspec>` and sparse patterns in
|
||||||
$GIT_DIR/info/sparse-checkout. This option ignores the sparse
|
$GIT_DIR/info/sparse-checkout. This option ignores the sparse
|
||||||
patterns and unconditionally restores any files in
|
patterns and unconditionally restores any files in
|
||||||
|
@ -17,7 +17,7 @@ DESCRIPTION
|
|||||||
:git-rev-list: 1
|
:git-rev-list: 1
|
||||||
include::rev-list-description.txt[]
|
include::rev-list-description.txt[]
|
||||||
|
|
||||||
'rev-list' is a very essential Git command, since it
|
'rev-list' is an essential Git command, since it
|
||||||
provides the ability to build and traverse commit ancestry graphs. For
|
provides the ability to build and traverse commit ancestry graphs. For
|
||||||
this reason, it has a lot of different options that enables it to be
|
this reason, it has a lot of different options that enables it to be
|
||||||
used by commands as different as 'git bisect' and
|
used by commands as different as 'git bisect' and
|
||||||
|
@ -36,7 +36,7 @@ Each of these options must appear first on the command line.
|
|||||||
--sq-quote::
|
--sq-quote::
|
||||||
Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
|
Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
|
||||||
section below). In contrast to the `--sq` option below, this
|
section below). In contrast to the `--sq` option below, this
|
||||||
mode does only quoting. Nothing else is done to command input.
|
mode only does quoting. Nothing else is done to command input.
|
||||||
|
|
||||||
Options for --parseopt
|
Options for --parseopt
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
@ -468,8 +468,8 @@ Information
|
|||||||
|
|
||||||
--dump-aliases::
|
--dump-aliases::
|
||||||
Instead of the normal operation, dump the shorthand alias names from
|
Instead of the normal operation, dump the shorthand alias names from
|
||||||
the configured alias file(s), one per line in alphabetical order. Note,
|
the configured alias file(s), one per line in alphabetical order. Note
|
||||||
this only includes the alias name and not its expanded email addresses.
|
that this only includes the alias name and not its expanded email addresses.
|
||||||
See 'sendemail.aliasesfile' for more information about aliases.
|
See 'sendemail.aliasesfile' for more information about aliases.
|
||||||
|
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ be in a separate packet, and the list must end with a flush packet.
|
|||||||
--force::
|
--force::
|
||||||
Usually, the command refuses to update a remote ref that
|
Usually, the command refuses to update a remote ref that
|
||||||
is not an ancestor of the local ref used to overwrite it.
|
is not an ancestor of the local ref used to overwrite it.
|
||||||
This flag disables the check. What this means is that
|
This flag disables the check. This means that
|
||||||
the remote repository can lose commits; use it with
|
the remote repository can lose commits; use it with
|
||||||
care.
|
care.
|
||||||
|
|
||||||
@ -117,7 +117,7 @@ When one or more '<ref>' are specified explicitly (whether on the
|
|||||||
command line or via `--stdin`), it can be either a
|
command line or via `--stdin`), it can be either a
|
||||||
single pattern, or a pair of such pattern separated by a colon
|
single pattern, or a pair of such pattern separated by a colon
|
||||||
":" (this means that a ref name cannot have a colon in it). A
|
":" (this means that a ref name cannot have a colon in it). A
|
||||||
single pattern '<name>' is just a shorthand for '<name>:<name>'.
|
single pattern '<name>' is just shorthand for '<name>:<name>'.
|
||||||
|
|
||||||
Each pattern pair consists of the source side (before the colon)
|
Each pattern pair consists of the source side (before the colon)
|
||||||
and the destination side (after the colon). The ref to be
|
and the destination side (after the colon). The ref to be
|
||||||
@ -143,9 +143,9 @@ name. See linkgit:git-rev-parse[1].
|
|||||||
|
|
||||||
Without `--force`, the <src> ref is stored at the remote only if
|
Without `--force`, the <src> ref is stored at the remote only if
|
||||||
<dst> does not exist, or <dst> is a proper subset (i.e. an
|
<dst> does not exist, or <dst> is a proper subset (i.e. an
|
||||||
ancestor) of <src>. This check, known as "fast-forward check",
|
ancestor) of <src>. This check, known as the "fast-forward check",
|
||||||
is performed in order to avoid accidentally overwriting the
|
is performed to avoid accidentally overwriting the
|
||||||
remote ref and lose other peoples' commits from there.
|
remote ref and losing other people's commits from there.
|
||||||
|
|
||||||
With `--force`, the fast-forward check is disabled for all refs.
|
With `--force`, the fast-forward check is disabled for all refs.
|
||||||
|
|
||||||
|
@ -251,7 +251,7 @@ Submodules have more state and instead report
|
|||||||
m the submodule has modified content
|
m the submodule has modified content
|
||||||
? the submodule has untracked files
|
? the submodule has untracked files
|
||||||
|
|
||||||
since modified content or untracked files in a submodule cannot be added
|
This is since modified content or untracked files in a submodule cannot be added
|
||||||
via `git add` in the superproject to prepare a commit.
|
via `git add` in the superproject to prepare a commit.
|
||||||
|
|
||||||
'm' and '?' are applied recursively. For example if a nested submodule
|
'm' and '?' are applied recursively. For example if a nested submodule
|
||||||
|
@ -41,7 +41,7 @@ OPTIONS
|
|||||||
|
|
||||||
-c::
|
-c::
|
||||||
--comment-lines::
|
--comment-lines::
|
||||||
Prepend comment character and blank to each line. Lines will automatically
|
Prepend the comment character and a blank space to each line. Lines will automatically
|
||||||
be terminated with a newline. On empty lines, only the comment character
|
be terminated with a newline. On empty lines, only the comment character
|
||||||
will be prepended.
|
will be prepended.
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ no value.
|
|||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
-l::
|
-l::
|
||||||
Cause the logical variables to be listed. In addition, all the
|
Display the logical variables. In addition, all the
|
||||||
variables of the Git configuration file .git/config are listed
|
variables of the Git configuration file .git/config are listed
|
||||||
as well. (However, the configuration variables listing functionality
|
as well. (However, the configuration variables listing functionality
|
||||||
is deprecated in favor of `git config -l`.)
|
is deprecated in favor of `git config -l`.)
|
||||||
|
@ -20,7 +20,7 @@ New users are encouraged to use linkgit:git-log[1] instead. The
|
|||||||
`whatchanged` command is essentially the same as linkgit:git-log[1]
|
`whatchanged` command is essentially the same as linkgit:git-log[1]
|
||||||
but defaults to show the raw format diff output and to skip merges.
|
but defaults to show the raw format diff output and to skip merges.
|
||||||
|
|
||||||
The command is kept primarily 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 Linux kernel mailing list are trained to type it.
|
||||||
|
|
||||||
|
@ -86,10 +86,10 @@ In the bundle format, there can be a comment following a prerequisite obj-id.
|
|||||||
This is a comment and it has no specific meaning. The writer of the bundle MAY
|
This is a comment and it has no specific meaning. The writer of the bundle MAY
|
||||||
put any string here. The reader of the bundle MUST ignore the comment.
|
put any string here. The reader of the bundle MUST ignore the comment.
|
||||||
|
|
||||||
Note on the shallow clone and a Git bundle
|
Note on shallow clones and Git bundles
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Note that the prerequisites does not represent a shallow-clone boundary. The
|
Note that the prerequisites do not represent a shallow-clone boundary. The
|
||||||
semantics of the prerequisites and the shallow-clone boundaries are different,
|
semantics of the prerequisites and the shallow-clone boundaries are different,
|
||||||
and the Git bundle v2 format cannot represent a shallow clone repository.
|
and the Git bundle v2 format cannot represent a shallow clone repository.
|
||||||
|
|
||||||
|
@ -345,7 +345,7 @@ for the user.
|
|||||||
|
|
||||||
The default 'update' hook, when enabled--and with
|
The default 'update' hook, when enabled--and with
|
||||||
`hooks.allowunannotated` config option unset or set to false--prevents
|
`hooks.allowunannotated` config option unset or set to false--prevents
|
||||||
unannotated tags to be pushed.
|
unannotated tags from being pushed.
|
||||||
|
|
||||||
[[proc-receive]]
|
[[proc-receive]]
|
||||||
proc-receive
|
proc-receive
|
||||||
|
@ -61,8 +61,8 @@ complete cut across the DAG, or the client has said "done".
|
|||||||
Without multi_ack, a client sends have lines in --date-order until
|
Without multi_ack, a client sends have lines in --date-order until
|
||||||
the server has found a common base. That means the client will send
|
the server has found a common base. That means the client will send
|
||||||
have lines that are already known by the server to be common, because
|
have lines that are already known by the server to be common, because
|
||||||
they overlap in time with another branch that the server hasn't found
|
they overlap in time with another branch on which the server hasn't found
|
||||||
a common base on yet.
|
a common base yet.
|
||||||
|
|
||||||
For example suppose the client has commits in caps that the server
|
For example suppose the client has commits in caps that the server
|
||||||
doesn't and the server has commits in lower case that the client
|
doesn't and the server has commits in lower case that the client
|
||||||
@ -135,7 +135,7 @@ to disable the feature in a backwards-compatible manner.
|
|||||||
side-band, side-band-64k
|
side-band, side-band-64k
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
This capability means that server can send, and client understand multiplexed
|
This capability means that the server can send, and the client can understand, multiplexed
|
||||||
progress reports and error info interleaved with the packfile itself.
|
progress reports and error info interleaved with the packfile itself.
|
||||||
|
|
||||||
These two options are mutually exclusive. A modern client always
|
These two options are mutually exclusive. A modern client always
|
||||||
@ -163,14 +163,14 @@ Further, with side-band and its up to 1000-byte messages, it's actually
|
|||||||
same deal, you have up to 65519 bytes of data and 1 byte for the stream
|
same deal, you have up to 65519 bytes of data and 1 byte for the stream
|
||||||
code.
|
code.
|
||||||
|
|
||||||
The client MUST send only maximum of one of "side-band" and "side-
|
The client MUST send only one of "side-band" and "side-
|
||||||
band-64k". Server MUST diagnose it as an error if client requests
|
band-64k". The server MUST diagnose it as an error if client requests
|
||||||
both.
|
both.
|
||||||
|
|
||||||
ofs-delta
|
ofs-delta
|
||||||
---------
|
---------
|
||||||
|
|
||||||
Server can send, and client understand PACKv2 with delta referring to
|
The server can send, and the client can understand, PACKv2 with delta referring to
|
||||||
its base by position in pack rather than by an obj-id. That is, they can
|
its base by position in pack rather than by an obj-id. That is, they can
|
||||||
send/read OBJ_OFS_DELTA (aka type 6) in a packfile.
|
send/read OBJ_OFS_DELTA (aka type 6) in a packfile.
|
||||||
|
|
||||||
@ -252,7 +252,7 @@ the current shallow boundary, instead of the depth from remote refs.
|
|||||||
no-progress
|
no-progress
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
The client was started with "git clone -q" or something, and doesn't
|
The client was started with "git clone -q" or something similar, and doesn't
|
||||||
want that side band 2. Basically the client just says "I do not
|
want that side band 2. Basically the client just says "I do not
|
||||||
wish to receive stream 2 on sideband, so do not send it to me, and if
|
wish to receive stream 2 on sideband, so do not send it to me, and if
|
||||||
you did, I will drop it on the floor anyway". However, the sideband
|
you did, I will drop it on the floor anyway". However, the sideband
|
||||||
|
@ -379,7 +379,7 @@ C: Place any object seen into set `advertised`.
|
|||||||
C: Build an empty set, `common`, to hold the objects that are later
|
C: Build an empty set, `common`, to hold the objects that are later
|
||||||
determined to be on both ends.
|
determined to be on both ends.
|
||||||
|
|
||||||
C: Build a set, `want`, of the objects from `advertised` the client
|
C: Build a set, `want`, of the objects from `advertised` that the client
|
||||||
wants to fetch, based on what it saw during ref discovery.
|
wants to fetch, based on what it saw during ref discovery.
|
||||||
|
|
||||||
C: Start a queue, `c_pending`, ordered by commit time (popping newest
|
C: Start a queue, `c_pending`, ordered by commit time (popping newest
|
||||||
@ -423,7 +423,7 @@ multiple commands. Object names MUST be given using the object format
|
|||||||
negotiated through the `object-format` capability (default SHA-1).
|
negotiated through the `object-format` capability (default SHA-1).
|
||||||
|
|
||||||
The `have` list is created by popping the first 32 commits
|
The `have` list is created by popping the first 32 commits
|
||||||
from `c_pending`. Less can be supplied if `c_pending` empties.
|
from `c_pending`. Fewer can be supplied if `c_pending` empties.
|
||||||
|
|
||||||
If the client has sent 256 "have" commits and has not yet
|
If the client has sent 256 "have" commits and has not yet
|
||||||
received one of those back from `s_common`, or the client has
|
received one of those back from `s_common`, or the client has
|
||||||
|
@ -20,13 +20,13 @@ Gitweb provides a web interface to Git repositories. Its features include:
|
|||||||
* Browsing every revision of the repository.
|
* Browsing every revision of the repository.
|
||||||
* Viewing the contents of files in the repository at any revision.
|
* Viewing the contents of files in the repository at any revision.
|
||||||
* Viewing the revision log of branches, history of files and directories,
|
* Viewing the revision log of branches, history of files and directories,
|
||||||
see what was changed when, by who.
|
seeing what was changed, when, and by whom.
|
||||||
* Viewing the blame/annotation details of any file (if enabled).
|
* Viewing the blame/annotation details of any file (if enabled).
|
||||||
* Generating RSS and Atom feeds of commits, for any branch.
|
* Generating RSS and Atom feeds of commits, for any branch.
|
||||||
The feeds are auto-discoverable in modern web browsers.
|
The feeds are auto-discoverable in modern web browsers.
|
||||||
* Viewing everything that was changed in a revision, and step through
|
* Viewing everything that was changed in a revision, and step through
|
||||||
revisions one at a time, viewing the history of the repository.
|
revisions one at a time, viewing the history of the repository.
|
||||||
* Finding commits which commit messages matches given search term.
|
* Finding commits whose commit messages match a given search term.
|
||||||
|
|
||||||
See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for gitweb source code,
|
See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for gitweb source code,
|
||||||
browsed using gitweb itself.
|
browsed using gitweb itself.
|
||||||
|
@ -104,7 +104,7 @@ by doing the following:
|
|||||||
files in mbox format).
|
files in mbox format).
|
||||||
|
|
||||||
- Write his own patches to address issues raised on the list but
|
- Write his own patches to address issues raised on the list but
|
||||||
nobody has stepped up solving. Send it out just like other
|
nobody has stepped up to solve. Send it out just like other
|
||||||
contributors do, and pick them up just like patches from other
|
contributors do, and pick them up just like patches from other
|
||||||
contributors (see above).
|
contributors (see above).
|
||||||
|
|
||||||
@ -417,7 +417,7 @@ are merged together, the reference to the variable newly added by
|
|||||||
the latter topic will still use the old name in the result.
|
the latter topic will still use the old name in the result.
|
||||||
|
|
||||||
The Meta/Reintegrate script that is used by redo-jch and redo-seen
|
The Meta/Reintegrate script that is used by redo-jch and redo-seen
|
||||||
scripts implements a crude but usable way to work this issue around.
|
scripts implements a crude but usable way to work around this issue.
|
||||||
When the script merges branch $X, it checks if "refs/merge-fix/$X"
|
When the script merges branch $X, it checks if "refs/merge-fix/$X"
|
||||||
exists, and if so, the effect of it is squashed into the result of
|
exists, and if so, the effect of it is squashed into the result of
|
||||||
the mechanical merge. In other words,
|
the mechanical merge. In other words,
|
||||||
|
@ -11,7 +11,7 @@ Message-ID: <BAYC1-PASMTP12374B54BA370A1E1C6E78AE4E0@CEZ.ICE>
|
|||||||
How to use the subtree merge strategy
|
How to use the subtree merge strategy
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
There are situations where you want to include contents in your project
|
There are situations where you want to include content in your project
|
||||||
from an independently developed project. You can just pull from the
|
from an independently developed project. You can just pull from the
|
||||||
other project as long as there are no conflicting paths.
|
other project as long as there are no conflicting paths.
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ mind.
|
|||||||
------------
|
------------
|
||||||
+
|
+
|
||||||
Commit objects created with the above setting record the value
|
Commit objects created with the above setting record the value
|
||||||
of `i18n.commitEncoding` in its `encoding` header. This is to
|
of `i18n.commitEncoding` in their `encoding` header. This is to
|
||||||
help other people who look at them later. Lack of this header
|
help other people who look at them later. Lack of this header
|
||||||
implies that the commit log message is encoded in UTF-8.
|
implies that the commit log message is encoded in UTF-8.
|
||||||
|
|
||||||
|
@ -32,10 +32,10 @@ have special meaning:
|
|||||||
- `+` is used to "open a new tab"
|
- `+` is used to "open a new tab"
|
||||||
- `,` is used to "open a new vertical split"
|
- `,` is used to "open a new vertical split"
|
||||||
- `/` is used to "open a new horizontal split"
|
- `/` is used to "open a new horizontal split"
|
||||||
- `@` is used to indicate which is the file containing the final version after
|
- `@` is used to indicate the file containing the final version after
|
||||||
solving the conflicts. If not present, `MERGED` will be used by default.
|
solving the conflicts. If not present, `MERGED` will be used by default.
|
||||||
|
|
||||||
The precedence of the operators is this one (you can use parentheses to change
|
The precedence of the operators is as follows (you can use parentheses to change
|
||||||
it):
|
it):
|
||||||
|
|
||||||
`@` > `+` > `/` > `,`
|
`@` > `+` > `/` > `,`
|
||||||
|
@ -102,4 +102,4 @@ stateless request, receive an application-specific
|
|||||||
response, and disconnect. It is a one round trip facility for
|
response, and disconnect. It is a one round trip facility for
|
||||||
querying the server. The Simple-IPC routines hide the socket,
|
querying the server. The Simple-IPC routines hide the socket,
|
||||||
named pipe, and thread pool details and allow the application
|
named pipe, and thread pool details and allow the application
|
||||||
layer to focus on the application at hand.
|
layer to focus on the task at hand.
|
||||||
|
@ -114,7 +114,7 @@ result in an empty bitmap (no bits set).
|
|||||||
|
|
||||||
* N entries with compressed bitmaps, one for each indexed commit
|
* N entries with compressed bitmaps, one for each indexed commit
|
||||||
+
|
+
|
||||||
Where `N` is the total amount of entries in this bitmap index.
|
Where `N` is the total number of entries in this bitmap index.
|
||||||
Each entry contains the following:
|
Each entry contains the following:
|
||||||
|
|
||||||
** {empty}
|
** {empty}
|
||||||
|
@ -185,7 +185,7 @@ quite straightforward: for each parallel-eligible entry, the main
|
|||||||
process must remove all files that prevent this entry from being written
|
process must remove all files that prevent this entry from being written
|
||||||
(before enqueueing it). This includes any non-directory file in the
|
(before enqueueing it). This includes any non-directory file in the
|
||||||
leading path of the entry. Later, when a worker gets assigned the entry,
|
leading path of the entry. Later, when a worker gets assigned the entry,
|
||||||
it looks again for the non-directories files and for an already existing
|
it looks again for the non-directory files and for an already existing
|
||||||
file at the entry's path. If any of these checks finds something, the
|
file at the entry's path. If any of these checks finds something, the
|
||||||
worker knows that there was a path collision.
|
worker knows that there was a path collision.
|
||||||
|
|
||||||
|
@ -265,7 +265,7 @@ Future Work
|
|||||||
- Improve the way to specify the order in which promisor remotes are
|
- Improve the way to specify the order in which promisor remotes are
|
||||||
tried.
|
tried.
|
||||||
+
|
+
|
||||||
For example this could allow to specify explicitly something like:
|
For example this could allow specifying explicitly something like:
|
||||||
"When fetching from this remote, I want to use these promisor remotes
|
"When fetching from this remote, I want to use these promisor remotes
|
||||||
in this order, though, when pushing or fetching to that remote, I want
|
in this order, though, when pushing or fetching to that remote, I want
|
||||||
to use those promisor remotes in that order."
|
to use those promisor remotes in that order."
|
||||||
|
@ -165,9 +165,9 @@ Avoiding runtime penalty
|
|||||||
|
|
||||||
In order to avoid the above runtime penalty, post 1.4.2 Git used
|
In order to avoid the above runtime penalty, post 1.4.2 Git used
|
||||||
to have a code that made sure the index file
|
to have a code that made sure the index file
|
||||||
got timestamp newer than the youngest files in the index when
|
got a timestamp newer than the youngest files in the index when
|
||||||
there are many young files with the same timestamp as the
|
there were many young files with the same timestamp as the
|
||||||
resulting index file would otherwise would have by waiting
|
resulting index file otherwise would have by waiting
|
||||||
before finishing writing the index file out.
|
before finishing writing the index file out.
|
||||||
|
|
||||||
I suspected that in practice the situation where many paths in the
|
I suspected that in practice the situation where many paths in the
|
||||||
|
@ -115,7 +115,7 @@ Varint encoding
|
|||||||
Varint encoding is identical to the ofs-delta encoding method used
|
Varint encoding is identical to the ofs-delta encoding method used
|
||||||
within pack files.
|
within pack files.
|
||||||
|
|
||||||
Decoder works such as:
|
Decoder works as follows:
|
||||||
|
|
||||||
....
|
....
|
||||||
val = buf[ptr] & 0x7f
|
val = buf[ptr] & 0x7f
|
||||||
|
@ -6,9 +6,9 @@ address of the remote server, and the path to the repository.
|
|||||||
Depending on the transport protocol, some of this information may be
|
Depending on the transport protocol, some of this information may be
|
||||||
absent.
|
absent.
|
||||||
|
|
||||||
Git supports ssh, git, http, and https protocols (in addition, ftp,
|
Git supports ssh, git, http, and https protocols (in addition, ftp
|
||||||
and ftps can be used for fetching, but this is inefficient and
|
and ftps can be used for fetching, but this is inefficient and
|
||||||
deprecated; do not use it).
|
deprecated; do not use them).
|
||||||
|
|
||||||
The native transport (i.e. git:// URL) does no authentication and
|
The native transport (i.e. git:// URL) does no authentication and
|
||||||
should be used with caution on unsecured networks.
|
should be used with caution on unsecured networks.
|
||||||
|
Reference in New Issue
Block a user