2008-06-06 09:07:32 +02:00
|
|
|
git(1)
|
2005-05-10 23:32:30 +02:00
|
|
|
======
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
git - the stupid content tracker
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2006-08-25 03:05:48 +02:00
|
|
|
[verse]
|
2013-09-09 15:47:43 +02:00
|
|
|
'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
|
2012-02-15 00:54:21 +01:00
|
|
|
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
|
git: add -P as a short option for --no-pager
It is possible to configure 'less', the pager, to use an alternate
screen to show the content, for example, by setting LESS=RS in the
environment. When it is closed in this configuration, it switches
back to the original screen, and all content is gone.
It is not uncommon to request that the output remains visible in
the terminal. For this, the option --no-pager can be used. But
it is a bit cumbersome to type, even when command completion is
available. Provide a short option, -P, to make the option more
easily accessible.
Signed-off-by: Johannes Sixt <j6t@kdbg.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-05-03 19:15:08 +02:00
|
|
|
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
|
2011-07-09 01:14:10 +02:00
|
|
|
[--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
|
2016-10-07 20:18:48 +02:00
|
|
|
[--super-prefix=<path>]
|
2012-02-15 00:54:21 +01:00
|
|
|
<command> [<args>]
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2006-04-02 23:54:34 +02:00
|
|
|
Git is a fast, scalable, distributed revision control system with an
|
|
|
|
unusually rich command set that provides both high-level operations
|
|
|
|
and full access to internals.
|
|
|
|
|
2008-07-01 00:01:21 +02:00
|
|
|
See linkgit:gittutorial[7] to get started, then see
|
2014-10-10 23:25:37 +02:00
|
|
|
linkgit:giteveryday[7] for a useful minimum set of
|
2012-08-17 21:48:52 +02:00
|
|
|
commands. The link:user-manual.html[Git User's Manual] has a more
|
|
|
|
in-depth introduction.
|
2005-11-16 00:31:25 +01:00
|
|
|
|
2012-08-17 21:48:52 +02:00
|
|
|
After you mastered the basic concepts, you can come back to this
|
2013-01-21 20:17:53 +01:00
|
|
|
page to learn what commands Git offers. You can learn more about
|
|
|
|
individual Git commands with "git help command". linkgit:gitcli[7]
|
2014-05-21 20:52:26 +02:00
|
|
|
manual page gives you an overview of the command-line command syntax.
|
2006-06-07 20:43:50 +02:00
|
|
|
|
2016-06-22 19:38:25 +02:00
|
|
|
A formatted and hyperlinked copy of the latest Git documentation
|
|
|
|
can be viewed at `https://git.github.io/htmldocs/git.html`.
|
2007-04-30 13:21:38 +02:00
|
|
|
|
2007-02-14 00:15:05 +01:00
|
|
|
|
2005-11-16 00:31:25 +01:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
--version::
|
2013-01-21 20:17:53 +01:00
|
|
|
Prints the Git suite version that the 'git' program came from.
|
2005-11-16 00:31:25 +01:00
|
|
|
|
|
|
|
--help::
|
2006-03-09 17:24:19 +01:00
|
|
|
Prints the synopsis and a list of the most commonly used
|
2016-06-28 13:40:11 +02:00
|
|
|
commands. If the option `--all` or `-a` is given then all
|
2013-01-21 20:17:53 +01:00
|
|
|
available commands are printed. If a Git command is named this
|
2007-12-04 06:44:29 +01:00
|
|
|
option will bring up the manual page for that command.
|
2007-12-04 06:44:29 +01:00
|
|
|
+
|
|
|
|
Other options are available to control how the manual page is
|
2007-12-29 07:20:38 +01:00
|
|
|
displayed. See linkgit:git-help[1] for more information,
|
2008-07-03 08:06:23 +02:00
|
|
|
because `git --help ...` is converted internally into `git
|
|
|
|
help ...`.
|
2005-11-16 00:31:25 +01:00
|
|
|
|
2013-09-09 15:47:43 +02:00
|
|
|
-C <path>::
|
|
|
|
Run as if git was started in '<path>' instead of the current working
|
|
|
|
directory. When multiple `-C` options are given, each subsequent
|
|
|
|
non-absolute `-C <path>` is interpreted relative to the preceding `-C
|
|
|
|
<path>`.
|
|
|
|
+
|
|
|
|
This option affects options that expect path name like `--git-dir` and
|
|
|
|
`--work-tree` in that their interpretations of the path names would be
|
|
|
|
made relative to the working directory caused by the `-C` option. For
|
|
|
|
example the following invocations are equivalent:
|
|
|
|
|
|
|
|
git --git-dir=a.git --work-tree=b -C c status
|
|
|
|
git --git-dir=c/a.git --work-tree=c/b status
|
|
|
|
|
2010-03-26 23:53:57 +01:00
|
|
|
-c <name>=<value>::
|
|
|
|
Pass a configuration parameter to the command. The value
|
|
|
|
given will override values from configuration files.
|
|
|
|
The <name> is expected in the same format as listed by
|
|
|
|
'git config' (subkeys separated by dots).
|
2014-08-05 00:40:19 +02:00
|
|
|
+
|
|
|
|
Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
|
|
|
|
`foo.bar` to the boolean true value (just like `[foo]bar` would in a
|
|
|
|
config file). Including the equals but with an empty value (like `git -c
|
2017-09-28 16:06:48 +02:00
|
|
|
foo.bar= ...`) sets `foo.bar` to the empty string which `git config
|
2017-08-15 00:12:18 +02:00
|
|
|
--bool` will convert to `false`.
|
2010-03-26 23:53:57 +01:00
|
|
|
|
2010-10-08 19:31:15 +02:00
|
|
|
--exec-path[=<path>]::
|
2013-01-21 20:17:53 +01:00
|
|
|
Path to wherever your core Git programs are installed.
|
2005-11-16 00:31:25 +01:00
|
|
|
This can also be controlled by setting the GIT_EXEC_PATH
|
2008-07-03 07:08:12 +02:00
|
|
|
environment variable. If no path is given, 'git' will print
|
2005-11-16 00:31:25 +01:00
|
|
|
the current setting and then exit.
|
|
|
|
|
2009-04-05 04:15:16 +02:00
|
|
|
--html-path::
|
2013-01-21 20:17:53 +01:00
|
|
|
Print the path, without trailing slash, where Git's HTML
|
2011-05-02 08:07:45 +02:00
|
|
|
documentation is installed and exit.
|
2009-04-05 04:15:16 +02:00
|
|
|
|
2011-05-01 10:16:25 +02:00
|
|
|
--man-path::
|
2011-05-02 08:07:45 +02:00
|
|
|
Print the manpath (see `man(1)`) for the man pages for
|
2013-01-21 20:17:53 +01:00
|
|
|
this version of Git and exit.
|
2011-05-01 10:16:25 +02:00
|
|
|
|
|
|
|
--info-path::
|
2011-05-02 08:07:45 +02:00
|
|
|
Print the path where the Info files documenting this
|
2013-01-21 20:17:53 +01:00
|
|
|
version of Git are installed and exit.
|
2009-04-05 04:15:16 +02:00
|
|
|
|
2008-06-08 03:36:09 +02:00
|
|
|
-p::
|
|
|
|
--paginate::
|
2010-02-14 13:02:35 +01:00
|
|
|
Pipe all output into 'less' (or if set, $PAGER) if standard
|
|
|
|
output is a terminal. This overrides the `pager.<cmd>`
|
|
|
|
configuration options (see the "Configuration Mechanism" section
|
|
|
|
below).
|
2006-07-25 20:24:22 +02:00
|
|
|
|
git: add -P as a short option for --no-pager
It is possible to configure 'less', the pager, to use an alternate
screen to show the content, for example, by setting LESS=RS in the
environment. When it is closed in this configuration, it switches
back to the original screen, and all content is gone.
It is not uncommon to request that the output remains visible in
the terminal. For this, the option --no-pager can be used. But
it is a bit cumbersome to type, even when command completion is
available. Provide a short option, -P, to make the option more
easily accessible.
Signed-off-by: Johannes Sixt <j6t@kdbg.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-05-03 19:15:08 +02:00
|
|
|
-P::
|
2007-08-19 19:24:36 +02:00
|
|
|
--no-pager::
|
2013-01-21 20:17:53 +01:00
|
|
|
Do not pipe Git output into a pager.
|
2007-08-19 19:24:36 +02:00
|
|
|
|
2006-07-25 20:24:22 +02:00
|
|
|
--git-dir=<path>::
|
|
|
|
Set the path to the repository. This can also be controlled by
|
2016-06-08 00:35:07 +02:00
|
|
|
setting the `GIT_DIR` environment variable. It can be an absolute
|
2008-04-28 22:09:20 +02:00
|
|
|
path or relative path to current working directory.
|
2006-07-25 20:24:22 +02:00
|
|
|
|
2007-06-06 09:10:42 +02:00
|
|
|
--work-tree=<path>::
|
2011-01-24 00:49:41 +01:00
|
|
|
Set the path to the working tree. It can be an absolute path
|
|
|
|
or a path relative to the current working directory.
|
2007-06-06 09:10:42 +02:00
|
|
|
This can also be controlled by setting the GIT_WORK_TREE
|
|
|
|
environment variable and the core.worktree configuration
|
2011-01-24 00:49:41 +01:00
|
|
|
variable (see core.worktree in linkgit:git-config[1] for a
|
|
|
|
more detailed discussion).
|
2007-06-06 09:10:42 +02:00
|
|
|
|
2011-07-09 01:14:10 +02:00
|
|
|
--namespace=<path>::
|
2013-01-21 20:17:53 +01:00
|
|
|
Set the Git namespace. See linkgit:gitnamespaces[7] for more
|
2011-07-09 01:14:10 +02:00
|
|
|
details. Equivalent to setting the `GIT_NAMESPACE` environment
|
|
|
|
variable.
|
|
|
|
|
2016-10-07 20:18:48 +02:00
|
|
|
--super-prefix=<path>::
|
|
|
|
Currently for internal use only. Set a prefix which gives a path from
|
|
|
|
above a repository down to its root. One use is to give submodules
|
|
|
|
context about the superproject that invoked it.
|
|
|
|
|
2006-07-25 20:24:22 +02:00
|
|
|
--bare::
|
2007-08-28 07:41:23 +02:00
|
|
|
Treat the repository as a bare repository. If GIT_DIR
|
|
|
|
environment is not set, it is set to the current working
|
|
|
|
directory.
|
|
|
|
|
2009-10-12 22:30:32 +02:00
|
|
|
--no-replace-objects::
|
2013-01-21 20:17:53 +01:00
|
|
|
Do not use replacement refs to replace Git objects. See
|
2009-10-12 22:30:32 +02:00
|
|
|
linkgit:git-replace[1] for more information.
|
|
|
|
|
add global --literal-pathspecs option
Git takes pathspec arguments in many places to limit the
scope of an operation. These pathspecs are treated not as
literal paths, but as glob patterns that can be fed to
fnmatch. When a user is giving a specific pattern, this is a
nice feature.
However, when programatically providing pathspecs, it can be
a nuisance. For example, to find the latest revision which
modified "$foo", one can use "git rev-list -- $foo". But if
"$foo" contains glob characters (e.g., "f*"), it will
erroneously match more entries than desired. The caller
needs to quote the characters in $foo, and even then, the
results may not be exactly the same as with a literal
pathspec. For instance, the depth checks in
match_pathspec_depth do not kick in if we match via fnmatch.
This patch introduces a global command-line option (i.e.,
one for "git" itself, not for specific commands) to turn
this behavior off. It also has a matching environment
variable, which can make it easier if you are a script or
porcelain interface that is going to issue many such
commands.
This option cannot turn off globbing for particular
pathspecs. That could eventually be done with a ":(noglob)"
magic pathspec prefix. However, that level of granularity is
more cumbersome to use for many cases, and doing ":(noglob)"
right would mean converting the whole codebase to use
"struct pathspec", as the usual "const char **pathspec"
cannot represent extra per-item flags.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 23:37:30 +01:00
|
|
|
--literal-pathspecs::
|
2013-07-14 10:36:07 +02:00
|
|
|
Treat pathspecs literally (i.e. no globbing, no pathspec magic).
|
|
|
|
This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
|
add global --literal-pathspecs option
Git takes pathspec arguments in many places to limit the
scope of an operation. These pathspecs are treated not as
literal paths, but as glob patterns that can be fed to
fnmatch. When a user is giving a specific pattern, this is a
nice feature.
However, when programatically providing pathspecs, it can be
a nuisance. For example, to find the latest revision which
modified "$foo", one can use "git rev-list -- $foo". But if
"$foo" contains glob characters (e.g., "f*"), it will
erroneously match more entries than desired. The caller
needs to quote the characters in $foo, and even then, the
results may not be exactly the same as with a literal
pathspec. For instance, the depth checks in
match_pathspec_depth do not kick in if we match via fnmatch.
This patch introduces a global command-line option (i.e.,
one for "git" itself, not for specific commands) to turn
this behavior off. It also has a matching environment
variable, which can make it easier if you are a script or
porcelain interface that is going to issue many such
commands.
This option cannot turn off globbing for particular
pathspecs. That could eventually be done with a ":(noglob)"
magic pathspec prefix. However, that level of granularity is
more cumbersome to use for many cases, and doing ":(noglob)"
right would mean converting the whole codebase to use
"struct pathspec", as the usual "const char **pathspec"
cannot represent extra per-item flags.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 23:37:30 +01:00
|
|
|
variable to `1`.
|
|
|
|
|
2013-09-23 20:54:35 +02:00
|
|
|
--glob-pathspecs::
|
2013-07-14 10:36:08 +02:00
|
|
|
Add "glob" magic to all pathspec. This is equivalent to setting
|
|
|
|
the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
|
|
|
|
globbing on individual pathspecs can be done using pathspec
|
|
|
|
magic ":(literal)"
|
|
|
|
|
2013-09-23 20:54:35 +02:00
|
|
|
--noglob-pathspecs::
|
2013-07-14 10:36:08 +02:00
|
|
|
Add "literal" magic to all pathspec. This is equivalent to setting
|
|
|
|
the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
|
|
|
|
globbing on individual pathspecs can be done using pathspec
|
|
|
|
magic ":(glob)"
|
2005-12-13 11:38:24 +01:00
|
|
|
|
2013-09-23 20:54:35 +02:00
|
|
|
--icase-pathspecs::
|
2013-07-14 10:36:09 +02:00
|
|
|
Add "icase" magic to all pathspec. This is equivalent to setting
|
|
|
|
the `GIT_ICASE_PATHSPECS` environment variable to `1`.
|
2005-12-13 11:38:24 +01:00
|
|
|
|
git: add --no-optional-locks option
Some tools like IDEs or fancy editors may periodically run
commands like "git status" in the background to keep track
of the state of the repository. Some of these commands may
refresh the index and write out the result in an
opportunistic way: if they can get the index lock, then they
update the on-disk index with any updates they find. And if
not, then their in-core refresh is lost and just has to be
recomputed by the next caller.
But taking the index lock may conflict with other operations
in the repository. Especially ones that the user is doing
themselves, which _aren't_ opportunistic. In other words,
"git status" knows how to back off when somebody else is
holding the lock, but other commands don't know that status
would be happy to drop the lock if somebody else wanted it.
There are a couple possible solutions:
1. Have some kind of "pseudo-lock" that allows other
commands to tell status that they want the lock.
This is likely to be complicated and error-prone to
implement (and maybe even impossible with just
dotlocks to work from, as it requires some
inter-process communication).
2. Avoid background runs of commands like "git status"
that want to do opportunistic updates, preferring
instead plumbing like diff-files, etc.
This is awkward for a couple of reasons. One is that
"status --porcelain" reports a lot more about the
repository state than is available from individual
plumbing commands. And two is that we actually _do_
want to see the refreshed index. We just don't want to
take a lock or write out the result. Whereas commands
like diff-files expect us to refresh the index
separately and write it to disk so that they can depend
on the result. But that write is exactly what we're
trying to avoid.
3. Ask "status" not to lock or write the index.
This is easy to implement. The big downside is that any
work done in refreshing the index for such a call is
lost when the process exits. So a background process
may end up re-hashing a changed file multiple times
until the user runs a command that does an index
refresh themselves.
This patch implements the option 3. The idea (and the test)
is largely stolen from a Git for Windows patch by Johannes
Schindelin, 67e5ce7f63 (status: offer *not* to lock the
index and update it, 2016-08-12). The twist here is that
instead of making this an option to "git status", it becomes
a "git" option and matching environment variable.
The reason there is two-fold:
1. An environment variable is carried through to
sub-processes. And whether an invocation is a
background process or not should apply to the whole
process tree. So you could do "git --no-optional-locks
foo", and if "foo" is a script or alias that calls
"status", you'll still get the effect.
2. There may be other programs that want the same
treatment.
I've punted here on finding more callers to convert,
since "status" is the obvious one to call as a repeated
background job. But "git diff"'s opportunistic refresh
of the index may be a good candidate.
The test is taken from 67e5ce7f63, and it's worth repeating
Johannes's explanation:
Note that the regression test added in this commit does
not *really* verify that no index.lock file was written;
that test is not possible in a portable way. Instead, we
verify that .git/index is rewritten *only* when `git
status` is run without `--no-optional-locks`.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-09-27 08:54:30 +02:00
|
|
|
--no-optional-locks::
|
|
|
|
Do not perform optional operations that require locks. This is
|
|
|
|
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
|
|
|
|
|
2018-05-20 20:39:57 +02:00
|
|
|
--list-cmds=group[,group...]::
|
|
|
|
List commands by group. This is an internal/experimental
|
|
|
|
option and may change or be removed in the future. Supported
|
|
|
|
groups are: builtins, parseopt (builtin commands that use
|
2018-05-20 20:39:59 +02:00
|
|
|
parse-options), main (all commands in libexec directory),
|
2018-05-20 20:40:00 +02:00
|
|
|
others (all other commands in `$PATH` that have git- prefix),
|
2018-05-20 20:40:07 +02:00
|
|
|
list-<category> (see categories in command-list.txt),
|
2018-05-20 20:40:09 +02:00
|
|
|
nohelpers (exclude helper commands), alias and config
|
|
|
|
(retrieve command list from config variable completion.commands)
|
2018-05-20 20:39:57 +02:00
|
|
|
|
2006-04-02 23:54:34 +02:00
|
|
|
GIT COMMANDS
|
|
|
|
------------
|
2005-12-13 11:38:24 +01:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
We divide Git into high level ("porcelain") commands and low level
|
2006-04-02 23:54:34 +02:00
|
|
|
("plumbing") commands.
|
2005-12-10 08:41:03 +01:00
|
|
|
|
2006-04-02 23:54:34 +02:00
|
|
|
High-level commands (porcelain)
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
We separate the porcelain commands into the main commands and some
|
|
|
|
ancillary user utilities.
|
|
|
|
|
|
|
|
Main porcelain commands
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
2005-08-27 06:33:46 +02:00
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-mainporcelain.txt[]
|
2005-08-16 00:48:47 +02:00
|
|
|
|
2005-08-15 17:23:06 +02:00
|
|
|
Ancillary Commands
|
2006-04-02 23:54:34 +02:00
|
|
|
~~~~~~~~~~~~~~~~~~
|
2005-07-14 09:10:48 +02:00
|
|
|
Manipulators:
|
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-ancillarymanipulators.txt[]
|
2005-05-10 23:32:37 +02:00
|
|
|
|
2005-08-15 17:23:06 +02:00
|
|
|
Interrogators:
|
2005-05-10 23:32:37 +02:00
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-ancillaryinterrogators.txt[]
|
2005-08-23 10:49:47 +02:00
|
|
|
|
2007-01-19 07:32:38 +01:00
|
|
|
|
|
|
|
Interacting with Others
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
These commands are to interact with foreign SCM and with other
|
|
|
|
people via patch over e-mail.
|
|
|
|
|
|
|
|
include::cmds-foreignscminterface.txt[]
|
|
|
|
|
|
|
|
|
2006-10-29 21:09:48 +01:00
|
|
|
Low-level commands (plumbing)
|
|
|
|
-----------------------------
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
Although Git includes its
|
2006-10-29 21:09:48 +01:00
|
|
|
own porcelain layer, its low-level commands are sufficient to support
|
|
|
|
development of alternative porcelains. Developers of such porcelains
|
2007-12-29 07:20:38 +01:00
|
|
|
might start by reading about linkgit:git-update-index[1] and
|
|
|
|
linkgit:git-read-tree[1].
|
2006-10-29 21:09:48 +01:00
|
|
|
|
2007-01-19 07:32:38 +01:00
|
|
|
The interface (input, output, set of options and the semantics)
|
|
|
|
to these low-level commands are meant to be a lot more stable
|
|
|
|
than Porcelain level commands, because these commands are
|
|
|
|
primarily for scripted use. The interface to Porcelain commands
|
|
|
|
on the other hand are subject to change in order to improve the
|
|
|
|
end user experience.
|
|
|
|
|
|
|
|
The following description divides
|
|
|
|
the low-level commands into commands that manipulate objects (in
|
2006-10-29 21:09:48 +01:00
|
|
|
the repository, index, and working tree), commands that interrogate and
|
|
|
|
compare objects, and commands that move objects and references between
|
|
|
|
repositories.
|
|
|
|
|
2007-01-19 07:32:38 +01:00
|
|
|
|
2006-10-29 21:09:48 +01:00
|
|
|
Manipulation commands
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-plumbingmanipulators.txt[]
|
2006-10-29 21:09:48 +01:00
|
|
|
|
|
|
|
|
|
|
|
Interrogation commands
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-plumbinginterrogators.txt[]
|
2006-10-29 21:09:48 +01:00
|
|
|
|
|
|
|
In general, the interrogate commands do not touch the files in
|
|
|
|
the working tree.
|
|
|
|
|
|
|
|
|
|
|
|
Synching repositories
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2007-01-19 00:03:13 +01:00
|
|
|
include::cmds-synchingrepositories.txt[]
|
2006-10-29 21:09:48 +01:00
|
|
|
|
2009-08-07 16:24:21 +02:00
|
|
|
The following are helper commands used by the above; end users
|
2007-01-19 07:32:38 +01:00
|
|
|
typically do not use them directly.
|
|
|
|
|
|
|
|
include::cmds-synchelpers.txt[]
|
|
|
|
|
|
|
|
|
|
|
|
Internal helper commands
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
These are internal helper commands used by other commands; end
|
|
|
|
users typically do not use them directly.
|
|
|
|
|
|
|
|
include::cmds-purehelpers.txt[]
|
|
|
|
|
2006-10-29 21:09:48 +01:00
|
|
|
|
2005-10-29 23:32:56 +02:00
|
|
|
Configuration Mechanism
|
|
|
|
-----------------------
|
|
|
|
|
2013-02-14 16:36:54 +01:00
|
|
|
Git uses a simple text format to store customizations that are per
|
|
|
|
repository and are per user. Such a configuration file may look
|
|
|
|
like this:
|
2005-10-29 23:32:56 +02:00
|
|
|
|
|
|
|
------------
|
|
|
|
#
|
2005-12-08 01:05:21 +01:00
|
|
|
# A '#' or ';' character indicates a comment.
|
2005-10-29 23:32:56 +02:00
|
|
|
#
|
|
|
|
|
|
|
|
; core variables
|
|
|
|
[core]
|
|
|
|
; Don't trust file modes
|
|
|
|
filemode = false
|
|
|
|
|
|
|
|
; user identity
|
|
|
|
[user]
|
|
|
|
name = "Junio C Hamano"
|
2013-02-14 16:36:54 +01:00
|
|
|
email = "gitster@pobox.com"
|
2005-10-29 23:32:56 +02:00
|
|
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
Various commands read from the configuration file and adjust
|
2010-02-14 13:02:35 +01:00
|
|
|
their operation accordingly. See linkgit:git-config[1] for a
|
2013-02-14 16:36:54 +01:00
|
|
|
list and more details about the configuration mechanism.
|
2005-10-29 23:32:56 +02:00
|
|
|
|
|
|
|
|
2005-05-22 19:44:16 +02:00
|
|
|
Identifier Terminology
|
2005-05-10 23:32:30 +02:00
|
|
|
----------------------
|
|
|
|
<object>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates the object name for any type of object.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
<blob>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates a blob object name.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
<tree>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates a tree object name.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
<commit>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates a commit object name.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
<tree-ish>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates a tree, commit or tag object name. A
|
2005-05-22 19:44:16 +02:00
|
|
|
command that takes a <tree-ish> argument ultimately wants to
|
|
|
|
operate on a <tree> object but automatically dereferences
|
|
|
|
<commit> and <tag> objects that point at a <tree>.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
2007-03-05 20:46:05 +01:00
|
|
|
<commit-ish>::
|
|
|
|
Indicates a commit or tag object name. A
|
|
|
|
command that takes a <commit-ish> argument ultimately wants to
|
|
|
|
operate on a <commit> object but automatically dereferences
|
|
|
|
<tag> objects that point at a <commit>.
|
|
|
|
|
2005-05-10 23:32:30 +02:00
|
|
|
<type>::
|
|
|
|
Indicates that an object type is required.
|
2005-12-08 01:05:21 +01:00
|
|
|
Currently one of: `blob`, `tree`, `commit`, or `tag`.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
<file>::
|
2005-12-08 01:05:21 +01:00
|
|
|
Indicates a filename - almost always relative to the
|
|
|
|
root of the tree structure `GIT_INDEX_FILE` describes.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
2005-05-10 23:32:38 +02:00
|
|
|
Symbolic Identifiers
|
|
|
|
--------------------
|
2013-01-21 20:17:53 +01:00
|
|
|
Any Git command accepting any <object> can also use the following
|
2005-05-22 19:44:16 +02:00
|
|
|
symbolic notation:
|
2005-05-10 23:32:38 +02:00
|
|
|
|
|
|
|
HEAD::
|
2011-06-23 18:35:10 +02:00
|
|
|
indicates the head of the current branch.
|
2005-12-08 01:05:21 +01:00
|
|
|
|
2005-05-10 23:32:38 +02:00
|
|
|
<tag>::
|
2005-12-08 01:05:21 +01:00
|
|
|
a valid tag 'name'
|
2011-06-23 18:35:10 +02:00
|
|
|
(i.e. a `refs/tags/<tag>` reference).
|
2005-12-08 01:05:21 +01:00
|
|
|
|
2005-05-10 23:32:38 +02:00
|
|
|
<head>::
|
2005-12-08 01:05:21 +01:00
|
|
|
a valid head 'name'
|
2011-06-23 18:35:10 +02:00
|
|
|
(i.e. a `refs/heads/<head>` reference).
|
2005-12-08 01:05:21 +01:00
|
|
|
|
2006-10-25 20:33:08 +02:00
|
|
|
For a more complete list of ways to spell object names, see
|
2010-10-11 18:03:32 +02:00
|
|
|
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
|
2006-10-25 20:33:08 +02:00
|
|
|
|
2005-05-10 23:32:38 +02:00
|
|
|
|
|
|
|
File/Directory Structure
|
|
|
|
------------------------
|
|
|
|
|
2008-07-01 00:01:21 +02:00
|
|
|
Please see the linkgit:gitrepository-layout[5] document.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2008-07-01 00:01:21 +02:00
|
|
|
Read linkgit:githooks[5] for more details about each hook.
|
2006-03-25 04:21:07 +01:00
|
|
|
|
2005-05-10 23:32:38 +02:00
|
|
|
Higher level SCMs may provide and manage additional information in the
|
2005-12-08 01:05:21 +01:00
|
|
|
`$GIT_DIR`.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2005-09-02 01:56:13 +02:00
|
|
|
|
2005-05-10 23:32:30 +02:00
|
|
|
Terminology
|
|
|
|
-----------
|
2008-07-01 00:01:21 +02:00
|
|
|
Please see linkgit:gitglossary[7].
|
2005-05-10 23:32:30 +02:00
|
|
|
|
|
|
|
|
|
|
|
Environment Variables
|
|
|
|
---------------------
|
2013-01-21 20:17:53 +01:00
|
|
|
Various Git commands use the following environment variables:
|
2005-05-10 23:32:30 +02:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
The Git Repository
|
2005-05-10 23:32:38 +02:00
|
|
|
~~~~~~~~~~~~~~~~~~
|
2013-01-21 20:17:53 +01:00
|
|
|
These environment variables apply to 'all' core Git commands. Nb: it
|
2005-05-10 23:32:38 +02:00
|
|
|
is worth noting that they may be used/overridden by SCMS sitting above
|
2015-07-24 06:00:54 +02:00
|
|
|
Git so take care if using a foreign front-end.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_INDEX_FILE`::
|
2005-05-10 23:32:38 +02:00
|
|
|
This environment allows the specification of an alternate
|
2005-11-11 02:12:27 +01:00
|
|
|
index file. If not specified, the default of `$GIT_DIR/index`
|
|
|
|
is used.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_INDEX_VERSION`::
|
2014-02-23 21:49:57 +01:00
|
|
|
This environment variable allows the specification of an index
|
|
|
|
version for new repositories. It won't affect existing index
|
2015-03-24 01:28:33 +01:00
|
|
|
files. By default index file version 2 or 3 is used. See
|
|
|
|
linkgit:git-update-index[1] for more information.
|
2014-02-23 21:49:57 +01:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_OBJECT_DIRECTORY`::
|
2005-05-10 23:32:38 +02:00
|
|
|
If the object storage directory is specified via this
|
|
|
|
environment variable then the sha1 directories are created
|
|
|
|
underneath - otherwise the default `$GIT_DIR/objects`
|
|
|
|
directory is used.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
|
2013-01-21 20:17:53 +01:00
|
|
|
Due to the immutable nature of Git objects, old objects can be
|
2005-05-10 23:32:38 +02:00
|
|
|
archived into shared, read-only directories. This variable
|
2007-12-03 21:55:57 +01:00
|
|
|
specifies a ":" separated (on Windows ";" separated) list
|
2013-01-21 20:17:53 +01:00
|
|
|
of Git object directories which can be used to search for Git
|
2007-12-03 21:55:57 +01:00
|
|
|
objects. New objects will not be written to these directories.
|
alternates: accept double-quoted paths
We read lists of alternates from objects/info/alternates
files (delimited by newline), as well as from the
GIT_ALTERNATE_OBJECT_DIRECTORIES environment variable
(delimited by colon or semi-colon, depending on the
platform).
There's no mechanism for quoting the delimiters, so it's
impossible to specify an alternate path that contains a
colon in the environment, or one that contains a newline in
a file. We've lived with that restriction for ages because
both alternates and filenames with colons are relatively
rare, and it's only a problem when the two meet. But since
722ff7f87 (receive-pack: quarantine objects until
pre-receive accepts, 2016-10-03), which builds on the
alternates system, every push causes the receiver to set
GIT_ALTERNATE_OBJECT_DIRECTORIES internally.
It would be convenient to have some way to quote the
delimiter so that we can represent arbitrary paths.
The simplest thing would be an escape character before a
quoted delimiter (e.g., "\:" as a literal colon). But that
creates a backwards compatibility problem: any path which
uses that escape character is now broken, and we've just
shifted the problem. We could choose an unlikely escape
character (e.g., something from the non-printable ASCII
range), but that's awkward to use.
Instead, let's treat names as unquoted unless they begin
with a double-quote, in which case they are interpreted via
our usual C-stylke quoting rules. This also breaks
backwards-compatibility, but in a smaller way: it only
matters if your file has a double-quote as the very _first_
character in the path (whereas an escape character is a
problem anywhere in the path). It's also consistent with
many other parts of git, which accept either a bare pathname
or a double-quoted one, and the sender can choose to quote
or not as required.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-12-12 20:52:22 +01:00
|
|
|
+
|
|
|
|
Entries that begin with `"` (double-quote) will be interpreted
|
|
|
|
as C-style quoted paths, removing leading and trailing
|
|
|
|
double-quotes and respecting backslash escapes. E.g., the value
|
|
|
|
`"path-with-\"-and-:-in-it":vanilla-path` has two paths:
|
|
|
|
`path-with-"-and-:-in-it` and `vanilla-path`.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_DIR`::
|
|
|
|
If the `GIT_DIR` environment variable is set then it
|
2005-12-08 01:05:21 +01:00
|
|
|
specifies a path to use instead of the default `.git`
|
|
|
|
for the base of the repository.
|
2016-06-28 13:40:11 +02:00
|
|
|
The `--git-dir` command-line option also sets this value.
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_WORK_TREE`::
|
2013-05-31 03:11:41 +02:00
|
|
|
Set the path to the root of the working tree.
|
2016-06-28 13:40:11 +02:00
|
|
|
This can also be controlled by the `--work-tree` command-line
|
2007-06-06 09:10:42 +02:00
|
|
|
option and the core.worktree configuration variable.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_NAMESPACE`::
|
2013-01-21 20:17:53 +01:00
|
|
|
Set the Git namespace; see linkgit:gitnamespaces[7] for details.
|
2016-06-28 13:40:11 +02:00
|
|
|
The `--namespace` command-line option also sets this value.
|
2011-07-09 01:14:10 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_CEILING_DIRECTORIES`::
|
Provide a mechanism to turn off symlink resolution in ceiling paths
Commit 1b77d83cab 'setup_git_directory_gently_1(): resolve symlinks
in ceiling paths' changed the setup code to resolve symlinks in the
entries in GIT_CEILING_DIRECTORIES. Because those entries are
compared textually to the symlink-resolved current directory, an
entry in GIT_CEILING_DIRECTORIES that contained a symlink would have
no effect. It was known that this could cause performance problems
if the symlink resolution *itself* touched slow filesystems, but it
was thought that such use cases would be unlikely. The intention of
the earlier change was to deal with a case when the user has this:
GIT_CEILING_DIRECTORIES=/home/gitster
but in reality, /home/gitster is a symbolic link to somewhere else,
e.g. /net/machine/home4/gitster. A textual comparison between the
specified value /home/gitster and the location getcwd(3) returns
would not help us, but readlink("/home/gitster") would still be
fast.
After this change was released, Anders Kaseorg <andersk@mit.edu>
reported:
> [...] my computer has been acting so slow when I’m not connected to
> the network. I put various network filesystem paths in
> $GIT_CEILING_DIRECTORIES, such as
> /afs/athena.mit.edu/user/a/n/andersk (to avoid hitting its parents
> /afs/athena.mit.edu, /afs/athena.mit.edu/user/a, and
> /afs/athena.mit.edu/user/a/n which all live in different AFS
> volumes). Now when I’m not connected to the network, every
> invocation of Git, including the __git_ps1 in my shell prompt, waits
> for AFS to timeout.
To allow users to work around this problem, give them a mechanism to
turn off symlink resolution in GIT_CEILING_DIRECTORIES entries. All
the entries that follow an empty entry will not be checked for symbolic
links and used literally in comparison. E.g. with these:
GIT_CEILING_DIRECTORIES=:/foo/bar:/xyzzy or
GIT_CEILING_DIRECTORIES=/foo/bar::/xyzzy
we will not readlink("/xyzzy") because it comes after an empty entry.
With the former (but not with the latter), "/foo/bar" comes after an
empty entry, and we will not readlink it, either.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-20 10:09:24 +01:00
|
|
|
This should be a colon-separated list of absolute paths. If
|
2013-02-27 18:47:27 +01:00
|
|
|
set, it is a list of directories that Git should not chdir up
|
Provide a mechanism to turn off symlink resolution in ceiling paths
Commit 1b77d83cab 'setup_git_directory_gently_1(): resolve symlinks
in ceiling paths' changed the setup code to resolve symlinks in the
entries in GIT_CEILING_DIRECTORIES. Because those entries are
compared textually to the symlink-resolved current directory, an
entry in GIT_CEILING_DIRECTORIES that contained a symlink would have
no effect. It was known that this could cause performance problems
if the symlink resolution *itself* touched slow filesystems, but it
was thought that such use cases would be unlikely. The intention of
the earlier change was to deal with a case when the user has this:
GIT_CEILING_DIRECTORIES=/home/gitster
but in reality, /home/gitster is a symbolic link to somewhere else,
e.g. /net/machine/home4/gitster. A textual comparison between the
specified value /home/gitster and the location getcwd(3) returns
would not help us, but readlink("/home/gitster") would still be
fast.
After this change was released, Anders Kaseorg <andersk@mit.edu>
reported:
> [...] my computer has been acting so slow when I’m not connected to
> the network. I put various network filesystem paths in
> $GIT_CEILING_DIRECTORIES, such as
> /afs/athena.mit.edu/user/a/n/andersk (to avoid hitting its parents
> /afs/athena.mit.edu, /afs/athena.mit.edu/user/a, and
> /afs/athena.mit.edu/user/a/n which all live in different AFS
> volumes). Now when I’m not connected to the network, every
> invocation of Git, including the __git_ps1 in my shell prompt, waits
> for AFS to timeout.
To allow users to work around this problem, give them a mechanism to
turn off symlink resolution in GIT_CEILING_DIRECTORIES entries. All
the entries that follow an empty entry will not be checked for symbolic
links and used literally in comparison. E.g. with these:
GIT_CEILING_DIRECTORIES=:/foo/bar:/xyzzy or
GIT_CEILING_DIRECTORIES=/foo/bar::/xyzzy
we will not readlink("/xyzzy") because it comes after an empty entry.
With the former (but not with the latter), "/foo/bar" comes after an
empty entry, and we will not readlink it, either.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-02-20 10:09:24 +01:00
|
|
|
into while looking for a repository directory (useful for
|
|
|
|
excluding slow-loading network directories). It will not
|
|
|
|
exclude the current working directory or a GIT_DIR set on the
|
|
|
|
command line or in the environment. Normally, Git has to read
|
|
|
|
the entries in this list and resolve any symlink that
|
|
|
|
might be present in order to compare them with the current
|
|
|
|
directory. However, if even this access is slow, you
|
|
|
|
can add an empty entry to the list to tell Git that the
|
|
|
|
subsequent entries are not symlinks and needn't be resolved;
|
|
|
|
e.g.,
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.
|
2008-05-20 08:49:26 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_DISCOVERY_ACROSS_FILESYSTEM`::
|
2010-04-04 19:33:53 +02:00
|
|
|
When run in a directory that does not have ".git" repository
|
2013-01-21 20:17:53 +01:00
|
|
|
directory, Git tries to find such a directory in the parent
|
2010-04-04 19:33:53 +02:00
|
|
|
directories to find the top of the working tree, but by default it
|
|
|
|
does not cross filesystem boundaries. This environment variable
|
2013-01-21 20:17:53 +01:00
|
|
|
can be set to true to tell Git not to stop at filesystem
|
2016-06-08 00:35:06 +02:00
|
|
|
boundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect
|
|
|
|
an explicit repository directory set via `GIT_DIR` or on the
|
2010-04-04 23:49:31 +02:00
|
|
|
command line.
|
2010-03-17 20:55:53 +01:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_COMMON_DIR`::
|
$GIT_COMMON_DIR: a new environment variable
This variable is intended to support multiple working directories
attached to a repository. Such a repository may have a main working
directory, created by either "git init" or "git clone" and one or more
linked working directories. These working directories and the main
repository share the same repository directory.
In linked working directories, $GIT_COMMON_DIR must be defined to point
to the real repository directory and $GIT_DIR points to an unused
subdirectory inside $GIT_COMMON_DIR. File locations inside the
repository are reorganized from the linked worktree view point:
- worktree-specific such as HEAD, logs/HEAD, index, other top-level
refs and unrecognized files are from $GIT_DIR.
- the rest like objects, refs, info, hooks, packed-refs, shallow...
are from $GIT_COMMON_DIR (except info/sparse-checkout, but that's
a separate patch)
Scripts are supposed to retrieve paths in $GIT_DIR with "git rev-parse
--git-path", which will take care of "$GIT_DIR vs $GIT_COMMON_DIR"
business.
The redirection is done by git_path(), git_pathdup() and
strbuf_git_path(). The selected list of paths goes to $GIT_COMMON_DIR,
not the other way around in case a developer adds a new
worktree-specific file and it's accidentally promoted to be shared
across repositories (this includes unknown files added by third party
commands)
The list of known files that belong to $GIT_DIR are:
ADD_EDIT.patch BISECT_ANCESTORS_OK BISECT_EXPECTED_REV BISECT_LOG
BISECT_NAMES CHERRY_PICK_HEAD COMMIT_MSG FETCH_HEAD HEAD MERGE_HEAD
MERGE_MODE MERGE_RR NOTES_EDITMSG NOTES_MERGE_WORKTREE ORIG_HEAD
REVERT_HEAD SQUASH_MSG TAG_EDITMSG fast_import_crash_* logs/HEAD
next-index-* rebase-apply rebase-merge rsync-refs-* sequencer/*
shallow_*
Path mapping is NOT done for git_path_submodule(). Multi-checkouts are
not supported as submodules.
Helped-by: Jens Lehmann <Jens.Lehmann@web.de>
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-11-30 09:24:36 +01:00
|
|
|
If this variable is set to a path, non-worktree files that are
|
|
|
|
normally in $GIT_DIR will be taken from this path
|
|
|
|
instead. Worktree-specific files such as HEAD or index are
|
2014-11-30 09:24:47 +01:00
|
|
|
taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
|
2015-07-17 02:17:02 +02:00
|
|
|
linkgit:git-worktree[1] for
|
$GIT_COMMON_DIR: a new environment variable
This variable is intended to support multiple working directories
attached to a repository. Such a repository may have a main working
directory, created by either "git init" or "git clone" and one or more
linked working directories. These working directories and the main
repository share the same repository directory.
In linked working directories, $GIT_COMMON_DIR must be defined to point
to the real repository directory and $GIT_DIR points to an unused
subdirectory inside $GIT_COMMON_DIR. File locations inside the
repository are reorganized from the linked worktree view point:
- worktree-specific such as HEAD, logs/HEAD, index, other top-level
refs and unrecognized files are from $GIT_DIR.
- the rest like objects, refs, info, hooks, packed-refs, shallow...
are from $GIT_COMMON_DIR (except info/sparse-checkout, but that's
a separate patch)
Scripts are supposed to retrieve paths in $GIT_DIR with "git rev-parse
--git-path", which will take care of "$GIT_DIR vs $GIT_COMMON_DIR"
business.
The redirection is done by git_path(), git_pathdup() and
strbuf_git_path(). The selected list of paths goes to $GIT_COMMON_DIR,
not the other way around in case a developer adds a new
worktree-specific file and it's accidentally promoted to be shared
across repositories (this includes unknown files added by third party
commands)
The list of known files that belong to $GIT_DIR are:
ADD_EDIT.patch BISECT_ANCESTORS_OK BISECT_EXPECTED_REV BISECT_LOG
BISECT_NAMES CHERRY_PICK_HEAD COMMIT_MSG FETCH_HEAD HEAD MERGE_HEAD
MERGE_MODE MERGE_RR NOTES_EDITMSG NOTES_MERGE_WORKTREE ORIG_HEAD
REVERT_HEAD SQUASH_MSG TAG_EDITMSG fast_import_crash_* logs/HEAD
next-index-* rebase-apply rebase-merge rsync-refs-* sequencer/*
shallow_*
Path mapping is NOT done for git_path_submodule(). Multi-checkouts are
not supported as submodules.
Helped-by: Jens Lehmann <Jens.Lehmann@web.de>
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-11-30 09:24:36 +01:00
|
|
|
details. This variable has lower precedence than other path
|
|
|
|
variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
Git Commits
|
2005-05-10 23:32:38 +02:00
|
|
|
~~~~~~~~~~~
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_AUTHOR_NAME`::
|
|
|
|
`GIT_AUTHOR_EMAIL`::
|
|
|
|
`GIT_AUTHOR_DATE`::
|
|
|
|
`GIT_COMMITTER_NAME`::
|
|
|
|
`GIT_COMMITTER_EMAIL`::
|
|
|
|
`GIT_COMMITTER_DATE`::
|
2007-04-29 03:40:28 +02:00
|
|
|
'EMAIL'::
|
2007-12-29 07:20:38 +01:00
|
|
|
see linkgit:git-commit-tree[1]
|
2005-05-10 23:32:38 +02:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
Git Diffs
|
2005-05-10 23:32:38 +02:00
|
|
|
~~~~~~~~~
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_DIFF_OPTS`::
|
2006-11-27 20:37:43 +01:00
|
|
|
Only valid setting is "--unified=??" or "-u??" to set the
|
|
|
|
number of context lines shown when a unified diff is created.
|
|
|
|
This takes precedence over any "-U" or "--unified" option
|
2013-01-21 20:17:53 +01:00
|
|
|
value passed on the Git diff command line.
|
2006-11-27 20:37:43 +01:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_EXTERNAL_DIFF`::
|
|
|
|
When the environment variable `GIT_EXTERNAL_DIFF` is set, the
|
2006-11-27 20:37:43 +01:00
|
|
|
program named by it is called, instead of the diff invocation
|
|
|
|
described above. For a path that is added, removed, or modified,
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_EXTERNAL_DIFF` is called with 7 parameters:
|
2006-11-27 20:37:43 +01:00
|
|
|
|
|
|
|
path old-file old-hex old-mode new-file new-hex new-mode
|
|
|
|
+
|
|
|
|
where:
|
|
|
|
|
|
|
|
<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
|
|
|
|
contents of <old|new>,
|
2013-04-15 19:49:04 +02:00
|
|
|
<old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
|
2006-11-27 20:37:43 +01:00
|
|
|
<old|new>-mode:: are the octal representation of the file modes.
|
|
|
|
+
|
|
|
|
The file parameters can point at the user's working file
|
|
|
|
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
|
|
|
|
when a new file is added), or a temporary file (e.g. `old-file` in the
|
2016-06-08 00:35:06 +02:00
|
|
|
index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the
|
|
|
|
temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
|
2006-11-27 20:37:43 +01:00
|
|
|
+
|
2016-06-08 00:35:06 +02:00
|
|
|
For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1
|
2006-11-27 20:37:43 +01:00
|
|
|
parameter, <path>.
|
2013-12-06 00:38:46 +01:00
|
|
|
+
|
2016-06-08 00:35:06 +02:00
|
|
|
For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,
|
|
|
|
`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.
|
2013-12-06 00:38:46 +01:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_DIFF_PATH_COUNTER`::
|
2013-12-06 00:38:46 +01:00
|
|
|
A 1-based counter incremented by one for every path.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_DIFF_PATH_TOTAL`::
|
2013-12-06 00:38:46 +01:00
|
|
|
The total number of paths.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
2006-06-25 15:56:18 +02:00
|
|
|
other
|
|
|
|
~~~~~
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_MERGE_VERBOSITY`::
|
2007-07-13 01:54:06 +02:00
|
|
|
A number controlling the amount of output shown by
|
|
|
|
the recursive merge strategy. Overrides merge.verbosity.
|
2007-12-29 07:20:38 +01:00
|
|
|
See linkgit:git-merge[1]
|
2007-07-13 01:54:06 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_PAGER`::
|
2007-07-19 12:43:51 +02:00
|
|
|
This environment variable overrides `$PAGER`. If it is set
|
2013-01-21 20:17:53 +01:00
|
|
|
to an empty string or to the value "cat", Git will not launch
|
2008-08-24 07:28:32 +02:00
|
|
|
a pager. See also the `core.pager` option in
|
|
|
|
linkgit:git-config[1].
|
2006-07-31 15:27:00 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_EDITOR`::
|
2012-03-23 13:38:42 +01:00
|
|
|
This environment variable overrides `$EDITOR` and `$VISUAL`.
|
2013-01-21 20:17:53 +01:00
|
|
|
It is used by several Git commands when, on interactive mode,
|
2012-03-23 13:38:42 +01:00
|
|
|
an editor is to be launched. See also linkgit:git-var[1]
|
|
|
|
and the `core.editor` option in linkgit:git-config[1].
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_SSH`::
|
|
|
|
`GIT_SSH_COMMAND`::
|
2014-11-09 23:42:32 +01:00
|
|
|
If either of these environment variables is set then 'git fetch'
|
|
|
|
and 'git push' will use the specified command instead of 'ssh'
|
|
|
|
when they need to connect to a remote system.
|
2017-10-16 19:55:31 +02:00
|
|
|
The command-line parameters passed to the configured command are
|
|
|
|
determined by the ssh variant. See `ssh.variant` option in
|
|
|
|
linkgit:git-config[1] for details.
|
|
|
|
|
2007-08-04 08:06:52 +02:00
|
|
|
+
|
2014-11-09 23:42:32 +01:00
|
|
|
`$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
|
|
|
|
by the shell, which allows additional arguments to be included.
|
|
|
|
`$GIT_SSH` on the other hand must be just the path to a program
|
|
|
|
(which can be a wrapper shell script, if additional arguments are
|
|
|
|
needed).
|
2007-08-04 08:06:52 +02:00
|
|
|
+
|
|
|
|
Usually it is easier to configure any desired options through your
|
|
|
|
personal `.ssh/config` file. Please consult your ssh documentation
|
|
|
|
for further details.
|
|
|
|
|
2017-02-01 13:01:16 +01:00
|
|
|
`GIT_SSH_VARIANT`::
|
|
|
|
If this environment variable is set, it overrides Git's autodetection
|
|
|
|
whether `GIT_SSH`/`GIT_SSH_COMMAND`/`core.sshCommand` refer to OpenSSH,
|
|
|
|
plink or tortoiseplink. This variable overrides the config setting
|
|
|
|
`ssh.variant` that serves the same purpose.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_ASKPASS`::
|
2013-01-21 20:17:53 +01:00
|
|
|
If this environment variable is set, then Git commands which need to
|
2010-08-30 15:40:29 +02:00
|
|
|
acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
|
2014-05-21 20:52:26 +02:00
|
|
|
will call this program with a suitable prompt as command-line argument
|
2016-06-08 19:23:16 +02:00
|
|
|
and read the password from its STDOUT. See also the `core.askPass`
|
2010-08-30 15:40:29 +02:00
|
|
|
option in linkgit:git-config[1].
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TERMINAL_PROMPT`::
|
2014-12-04 04:52:29 +01:00
|
|
|
If this environment variable is set to `0`, git will not prompt
|
|
|
|
on the terminal (e.g., when asking for HTTP authentication).
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_CONFIG_NOSYSTEM`::
|
2012-10-14 10:53:59 +02:00
|
|
|
Whether to skip reading settings from the system-wide
|
|
|
|
`$(prefix)/etc/gitconfig` file. This environment variable can
|
|
|
|
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
|
|
|
|
predictable environment for a picky script, or you can set it
|
|
|
|
temporarily to avoid using a buggy `/etc/gitconfig` file while
|
|
|
|
waiting for someone with sufficient permissions to fix it.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_FLUSH`::
|
2007-06-29 19:40:46 +02:00
|
|
|
If this environment variable is set to "1", then commands such
|
2010-01-10 00:33:00 +01:00
|
|
|
as 'git blame' (in incremental mode), 'git rev-list', 'git log',
|
core-tutorial: trim the section on Inspecting Changes
Back when the core tutorial was written, `log` and `whatchanged`
were scripted Porcelains. In the "Inspecting Changes" section that
talks about the plumbing commands in the diff family, it made sense
to use `log` and `whatchanged` as good examples of the use of these
plumbing commands, and because even these scripted Porcelains were
novelty (there wasn't the new end-user tutorial written), it made
some sense to illustrate uses of the `git log` (and `git
whatchanged`) scripted Porcelain commands.
But we no longer have scripted `log` and `whatchanged` to serve as
examples, and this document is not where the end users learn what
`git log` command is about. Stop at briefly mentioning the
possibility of combining rev-list with diff-tree to build your own
log, and leave the end-user documentation of `log` to the new
tutorial and the user manual.
Also resurrect the last version of `git-log`, `git-whatchanged`, and
`git-show` to serve as examples to contrib/examples/ directory.
While at it, remove 'whatchanged' from a list of sample commands
that are affected by GIT_FLUSH environment variable. This is not
meant to be an exhaustive list but as a list of typical ones, and an
old command that is kept primarily for backward compatibility does
not belong to it.
Helped-by: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-08-09 19:28:53 +02:00
|
|
|
'git check-attr' and 'git check-ignore' will
|
2013-04-11 14:05:13 +02:00
|
|
|
force a flush of the output stream after each record have been
|
|
|
|
flushed. If this
|
2007-06-29 19:40:46 +02:00
|
|
|
variable is set to "0", the output of these commands will be done
|
|
|
|
using completely buffered I/O. If this environment variable is
|
2013-01-21 20:17:53 +01:00
|
|
|
not set, Git will choose buffered or record-oriented flushing
|
2007-06-29 19:40:46 +02:00
|
|
|
based on whether stdout appears to be redirected to a file or not.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE`::
|
2014-07-12 02:00:53 +02:00
|
|
|
Enables general trace messages, e.g. alias expansion, built-in
|
|
|
|
command execution and external command execution.
|
|
|
|
+
|
|
|
|
If this variable is set to "1", "2" or "true" (comparison
|
|
|
|
is case insensitive), trace messages will be printed to
|
|
|
|
stderr.
|
|
|
|
+
|
|
|
|
If the variable is set to an integer value greater than 2
|
|
|
|
and lower than 10 (strictly) then Git will interpret this
|
|
|
|
value as an open file descriptor and will try to write the
|
|
|
|
trace messages into this file descriptor.
|
|
|
|
+
|
|
|
|
Alternatively, if the variable is set to an absolute path
|
|
|
|
(starting with a '/' character), Git will interpret this
|
|
|
|
as a file path and will try to write the trace messages
|
|
|
|
into it.
|
|
|
|
+
|
|
|
|
Unsetting the variable, or setting it to empty, "0" or
|
|
|
|
"false" (case insensitive) disables trace messages.
|
2006-06-25 15:56:18 +02:00
|
|
|
|
2017-10-28 01:26:36 +02:00
|
|
|
`GIT_TRACE_FSMONITOR`::
|
|
|
|
Enables trace messages for the filesystem monitor extension.
|
|
|
|
See `GIT_TRACE` for available trace output options.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_PACK_ACCESS`::
|
2014-07-12 02:01:38 +02:00
|
|
|
Enables trace messages for all accesses to any packs. For each
|
2013-06-09 07:22:48 +02:00
|
|
|
access, the pack file name and an offset in the pack is
|
|
|
|
recorded. This may be helpful for troubleshooting some
|
|
|
|
pack-related performance problems.
|
2016-06-08 00:35:06 +02:00
|
|
|
See `GIT_TRACE` for available trace output options.
|
2013-06-09 07:22:48 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_PACKET`::
|
2014-07-12 02:00:53 +02:00
|
|
|
Enables trace messages for all packets coming in or out of a
|
|
|
|
given program. This can help with debugging object negotiation
|
|
|
|
or other protocol issues. Tracing is turned off at a packet
|
2016-06-08 00:35:06 +02:00
|
|
|
starting with "PACK" (but see `GIT_TRACE_PACKFILE` below).
|
|
|
|
See `GIT_TRACE` for available trace output options.
|
2014-07-12 02:00:53 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_PACKFILE`::
|
2015-06-16 19:23:20 +02:00
|
|
|
Enables tracing of packfiles sent or received by a
|
|
|
|
given program. Unlike other trace output, this trace is
|
|
|
|
verbatim: no headers, and no quoting of binary data. You almost
|
|
|
|
certainly want to direct into a file (e.g.,
|
|
|
|
`GIT_TRACE_PACKFILE=/tmp/my.pack`) rather than displaying it on
|
|
|
|
the terminal or mixing it with other trace output.
|
|
|
|
+
|
|
|
|
Note that this is currently only implemented for the client side
|
|
|
|
of clones and fetches.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_PERFORMANCE`::
|
2014-07-12 02:07:01 +02:00
|
|
|
Enables performance related trace messages, e.g. total execution
|
|
|
|
time of each Git command.
|
2016-06-08 00:35:06 +02:00
|
|
|
See `GIT_TRACE` for available trace output options.
|
2014-07-12 02:07:01 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_SETUP`::
|
2014-07-12 02:00:53 +02:00
|
|
|
Enables trace messages printing the .git, working tree and current
|
|
|
|
working directory after Git has completed its setup phase.
|
2016-06-08 00:35:06 +02:00
|
|
|
See `GIT_TRACE` for available trace output options.
|
2014-07-12 02:00:53 +02:00
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_TRACE_SHALLOW`::
|
2014-07-12 02:00:53 +02:00
|
|
|
Enables trace messages that can help debugging fetching /
|
|
|
|
cloning of shallow repositories.
|
2016-06-08 00:35:06 +02:00
|
|
|
See `GIT_TRACE` for available trace output options.
|
2013-06-09 07:22:49 +02:00
|
|
|
|
2016-07-06 22:38:06 +02:00
|
|
|
`GIT_TRACE_CURL`::
|
2016-05-23 15:44:02 +02:00
|
|
|
Enables a curl full trace dump of all incoming and outgoing data,
|
|
|
|
including descriptive information, of the git transport protocol.
|
2016-07-06 22:38:06 +02:00
|
|
|
This is similar to doing curl `--trace-ascii` on the command line.
|
|
|
|
This option overrides setting the `GIT_CURL_VERBOSE` environment
|
2016-05-23 15:44:02 +02:00
|
|
|
variable.
|
2016-07-06 22:38:06 +02:00
|
|
|
See `GIT_TRACE` for available trace output options.
|
2016-05-23 15:44:02 +02:00
|
|
|
|
2018-01-19 01:28:02 +01:00
|
|
|
`GIT_TRACE_CURL_NO_DATA`::
|
|
|
|
When a curl trace is enabled (see `GIT_TRACE_CURL` above), do not dump
|
|
|
|
data (that is, only dump info lines and headers).
|
|
|
|
|
2018-01-19 01:28:01 +01:00
|
|
|
`GIT_REDACT_COOKIES`::
|
|
|
|
This can be set to a comma-separated list of strings. When a curl trace
|
|
|
|
is enabled (see `GIT_TRACE_CURL` above), whenever a "Cookies:" header
|
|
|
|
sent by the client is dumped, values of cookies whose key is in that
|
|
|
|
list (case-sensitive) are redacted.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_LITERAL_PATHSPECS`::
|
2013-01-21 20:17:53 +01:00
|
|
|
Setting this variable to `1` will cause Git to treat all
|
add global --literal-pathspecs option
Git takes pathspec arguments in many places to limit the
scope of an operation. These pathspecs are treated not as
literal paths, but as glob patterns that can be fed to
fnmatch. When a user is giving a specific pattern, this is a
nice feature.
However, when programatically providing pathspecs, it can be
a nuisance. For example, to find the latest revision which
modified "$foo", one can use "git rev-list -- $foo". But if
"$foo" contains glob characters (e.g., "f*"), it will
erroneously match more entries than desired. The caller
needs to quote the characters in $foo, and even then, the
results may not be exactly the same as with a literal
pathspec. For instance, the depth checks in
match_pathspec_depth do not kick in if we match via fnmatch.
This patch introduces a global command-line option (i.e.,
one for "git" itself, not for specific commands) to turn
this behavior off. It also has a matching environment
variable, which can make it easier if you are a script or
porcelain interface that is going to issue many such
commands.
This option cannot turn off globbing for particular
pathspecs. That could eventually be done with a ":(noglob)"
magic pathspec prefix. However, that level of granularity is
more cumbersome to use for many cases, and doing ":(noglob)"
right would mean converting the whole codebase to use
"struct pathspec", as the usual "const char **pathspec"
cannot represent extra per-item flags.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 23:37:30 +01:00
|
|
|
pathspecs literally, rather than as glob patterns. For example,
|
|
|
|
running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
|
|
|
|
for commits that touch the path `*.c`, not any paths that the
|
|
|
|
glob `*.c` matches. You might want this if you are feeding
|
2013-01-21 20:17:53 +01:00
|
|
|
literal paths to Git (e.g., paths previously given to you by
|
add global --literal-pathspecs option
Git takes pathspec arguments in many places to limit the
scope of an operation. These pathspecs are treated not as
literal paths, but as glob patterns that can be fed to
fnmatch. When a user is giving a specific pattern, this is a
nice feature.
However, when programatically providing pathspecs, it can be
a nuisance. For example, to find the latest revision which
modified "$foo", one can use "git rev-list -- $foo". But if
"$foo" contains glob characters (e.g., "f*"), it will
erroneously match more entries than desired. The caller
needs to quote the characters in $foo, and even then, the
results may not be exactly the same as with a literal
pathspec. For instance, the depth checks in
match_pathspec_depth do not kick in if we match via fnmatch.
This patch introduces a global command-line option (i.e.,
one for "git" itself, not for specific commands) to turn
this behavior off. It also has a matching environment
variable, which can make it easier if you are a script or
porcelain interface that is going to issue many such
commands.
This option cannot turn off globbing for particular
pathspecs. That could eventually be done with a ":(noglob)"
magic pathspec prefix. However, that level of granularity is
more cumbersome to use for many cases, and doing ":(noglob)"
right would mean converting the whole codebase to use
"struct pathspec", as the usual "const char **pathspec"
cannot represent extra per-item flags.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 23:37:30 +01:00
|
|
|
`git ls-tree`, `--raw` diff output, etc).
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_GLOB_PATHSPECS`::
|
2013-07-14 10:36:08 +02:00
|
|
|
Setting this variable to `1` will cause Git to treat all
|
|
|
|
pathspecs as glob patterns (aka "glob" magic).
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_NOGLOB_PATHSPECS`::
|
2013-07-14 10:36:08 +02:00
|
|
|
Setting this variable to `1` will cause Git to treat all
|
|
|
|
pathspecs as literal (aka "literal" magic).
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_ICASE_PATHSPECS`::
|
2013-07-14 10:36:09 +02:00
|
|
|
Setting this variable to `1` will cause Git to treat all
|
|
|
|
pathspecs as case-insensitive.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_REFLOG_ACTION`::
|
setup_reflog_action: document the rules for using GIT_REFLOG_ACTION
The set_reflog_action helper (in git-sh-setup) is designed to be
used once at the very top of a program, like this in "git am", for
example:
set_reflog_action am
The helper function sets the given string to GIT_REFLOG_ACTION only
when GIT_REFLOG_ACTION is not yet set. Thanks to this, "git am",
when run as the top-level program, will use "am" in GIT_REFLOG_ACTION
and the reflog entries made by whatever it does will record the
updates of refs done by "am".
Because of the conditional assignment, when "git am" is run as a
subprogram (i.e. an implementation detail) of "git rebase" that
already sets GIT_REFLOG_ACTION to its own name, the call in "git am"
to the helper function at the beginning will *not* have any effect.
So "git rebase" can do this:
set_reflog_action rebase
... do its own preparation, like checking out "onto" commit
... decide to do "format-patch" to "am" pipeline
git format-patch --stdout >mbox
git am mbox
and the reflog entries made inside "git am" invocation will say
"rebase", not "am".
Calls to "git" commands that update refs would use GIT_REFLOG_ACTION
to record who did that update. Most such calls in scripted Porcelains
do not define custom reflog message and rely on GIT_REFLOG_ACTION to
contain its (or its caller's, when it is called as a subprogram) name.
If a scripted Porcelain wants to record a custom reflog message for
a single invocation of "git" command (e.g. when "git rebase" uses
"git checkout" to detach HEAD at the commit a series is to be
replayed on), it needs to set GIT_REFLOG_ACTION to the custom
message and export it while calling the "git" command, but such an
assignment must be restricted to that single "git" invocation and
should not be left behind to affect later codepath.
Document the rules to avoid future confusion.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-06-19 19:54:00 +02:00
|
|
|
When a ref is updated, reflog entries are created to keep
|
|
|
|
track of the reason why the ref was updated (which is
|
|
|
|
typically the name of the high-level command that updated
|
|
|
|
the ref), in addition to the old and new values of the ref.
|
|
|
|
A scripted Porcelain command can use set_reflog_action
|
|
|
|
helper function in `git-sh-setup` to set its name to this
|
|
|
|
variable when it is invoked as the top level command by the
|
|
|
|
end user, to be recorded in the body of the reflog.
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_REF_PARANOIA`::
|
2015-03-20 19:43:06 +01:00
|
|
|
If set to `1`, include broken or badly named refs when iterating
|
|
|
|
over lists of refs. In a normal, non-corrupted repository, this
|
|
|
|
does nothing. However, enabling it may help git to detect and
|
|
|
|
abort some operations in the presence of broken refs. Git sets
|
|
|
|
this variable automatically when performing destructive
|
|
|
|
operations like linkgit:git-prune[1]. You should not need to set
|
|
|
|
it yourself unless you want to be paranoid about making sure
|
|
|
|
an operation has touched every ref (e.g., because you are
|
|
|
|
cloning a repository to make a backup).
|
|
|
|
|
2016-06-08 00:35:06 +02:00
|
|
|
`GIT_ALLOW_PROTOCOL`::
|
2016-12-14 23:39:52 +01:00
|
|
|
If set to a colon-separated list of protocols, behave as if
|
|
|
|
`protocol.allow` is set to `never`, and each of the listed
|
|
|
|
protocols has `protocol.<name>.allow` set to `always`
|
|
|
|
(overriding any existing configuration). In other words, any
|
|
|
|
protocol not mentioned will be disallowed (i.e., this is a
|
|
|
|
whitelist, not a blacklist). See the description of
|
|
|
|
`protocol.allow` in linkgit:git-config[1] for more details.
|
|
|
|
|
|
|
|
`GIT_PROTOCOL_FROM_USER`::
|
|
|
|
Set to 0 to prevent protocols used by fetch/push/clone which are
|
|
|
|
configured to the `user` state. This is useful to restrict recursive
|
|
|
|
submodule initialization from an untrusted repository or for programs
|
|
|
|
which feed potentially-untrusted URLS to git commands. See
|
|
|
|
linkgit:git-config[1] for more details.
|
add global --literal-pathspecs option
Git takes pathspec arguments in many places to limit the
scope of an operation. These pathspecs are treated not as
literal paths, but as glob patterns that can be fed to
fnmatch. When a user is giving a specific pattern, this is a
nice feature.
However, when programatically providing pathspecs, it can be
a nuisance. For example, to find the latest revision which
modified "$foo", one can use "git rev-list -- $foo". But if
"$foo" contains glob characters (e.g., "f*"), it will
erroneously match more entries than desired. The caller
needs to quote the characters in $foo, and even then, the
results may not be exactly the same as with a literal
pathspec. For instance, the depth checks in
match_pathspec_depth do not kick in if we match via fnmatch.
This patch introduces a global command-line option (i.e.,
one for "git" itself, not for specific commands) to turn
this behavior off. It also has a matching environment
variable, which can make it easier if you are a script or
porcelain interface that is going to issue many such
commands.
This option cannot turn off globbing for particular
pathspecs. That could eventually be done with a ":(noglob)"
magic pathspec prefix. However, that level of granularity is
more cumbersome to use for many cases, and doing ":(noglob)"
right would mean converting the whole codebase to use
"struct pathspec", as the usual "const char **pathspec"
cannot represent extra per-item flags.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 23:37:30 +01:00
|
|
|
|
2017-10-16 19:55:24 +02:00
|
|
|
`GIT_PROTOCOL`::
|
|
|
|
For internal use only. Used in handshaking the wire protocol.
|
|
|
|
Contains a colon ':' separated list of keys with optional values
|
|
|
|
'key[=value]'. Presence of unknown keys and values must be
|
|
|
|
ignored.
|
|
|
|
|
git: add --no-optional-locks option
Some tools like IDEs or fancy editors may periodically run
commands like "git status" in the background to keep track
of the state of the repository. Some of these commands may
refresh the index and write out the result in an
opportunistic way: if they can get the index lock, then they
update the on-disk index with any updates they find. And if
not, then their in-core refresh is lost and just has to be
recomputed by the next caller.
But taking the index lock may conflict with other operations
in the repository. Especially ones that the user is doing
themselves, which _aren't_ opportunistic. In other words,
"git status" knows how to back off when somebody else is
holding the lock, but other commands don't know that status
would be happy to drop the lock if somebody else wanted it.
There are a couple possible solutions:
1. Have some kind of "pseudo-lock" that allows other
commands to tell status that they want the lock.
This is likely to be complicated and error-prone to
implement (and maybe even impossible with just
dotlocks to work from, as it requires some
inter-process communication).
2. Avoid background runs of commands like "git status"
that want to do opportunistic updates, preferring
instead plumbing like diff-files, etc.
This is awkward for a couple of reasons. One is that
"status --porcelain" reports a lot more about the
repository state than is available from individual
plumbing commands. And two is that we actually _do_
want to see the refreshed index. We just don't want to
take a lock or write out the result. Whereas commands
like diff-files expect us to refresh the index
separately and write it to disk so that they can depend
on the result. But that write is exactly what we're
trying to avoid.
3. Ask "status" not to lock or write the index.
This is easy to implement. The big downside is that any
work done in refreshing the index for such a call is
lost when the process exits. So a background process
may end up re-hashing a changed file multiple times
until the user runs a command that does an index
refresh themselves.
This patch implements the option 3. The idea (and the test)
is largely stolen from a Git for Windows patch by Johannes
Schindelin, 67e5ce7f63 (status: offer *not* to lock the
index and update it, 2016-08-12). The twist here is that
instead of making this an option to "git status", it becomes
a "git" option and matching environment variable.
The reason there is two-fold:
1. An environment variable is carried through to
sub-processes. And whether an invocation is a
background process or not should apply to the whole
process tree. So you could do "git --no-optional-locks
foo", and if "foo" is a script or alias that calls
"status", you'll still get the effect.
2. There may be other programs that want the same
treatment.
I've punted here on finding more callers to convert,
since "status" is the obvious one to call as a repeated
background job. But "git diff"'s opportunistic refresh
of the index may be a good candidate.
The test is taken from 67e5ce7f63, and it's worth repeating
Johannes's explanation:
Note that the regression test added in this commit does
not *really* verify that no index.lock file was written;
that test is not possible in a portable way. Instead, we
verify that .git/index is rewritten *only* when `git
status` is run without `--no-optional-locks`.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-09-27 08:54:30 +02:00
|
|
|
`GIT_OPTIONAL_LOCKS`::
|
|
|
|
If set to `0`, Git will complete any requested operation without
|
|
|
|
performing any optional sub-operations that require taking a lock.
|
|
|
|
For example, this will prevent `git status` from refreshing the
|
|
|
|
index as a side effect. This is useful for processes running in
|
|
|
|
the background which do not want to cause lock contention with
|
|
|
|
other operations on the repository. Defaults to `1`.
|
|
|
|
|
2017-11-01 18:10:33 +01:00
|
|
|
`GIT_REDIRECT_STDIN`::
|
|
|
|
`GIT_REDIRECT_STDOUT`::
|
|
|
|
`GIT_REDIRECT_STDERR`::
|
|
|
|
Windows-only: allow redirecting the standard input/output/error
|
|
|
|
handles to paths specified by the environment variables. This is
|
|
|
|
particularly useful in multi-threaded applications where the
|
|
|
|
canonical way to pass standard handles via `CreateProcess()` is
|
|
|
|
not an option because it would require the handles to be marked
|
|
|
|
inheritable (and consequently *every* spawned process would
|
|
|
|
inherit them, possibly blocking regular Git operations). The
|
|
|
|
primary intended use case is to use named pipes for communication
|
|
|
|
(e.g. `\\.\pipe\my-git-stdin-123`).
|
|
|
|
+
|
|
|
|
Two special values are supported: `off` will simply close the
|
|
|
|
corresponding standard handle, and if `GIT_REDIRECT_STDERR` is
|
|
|
|
`2>&1`, standard error will be redirected to the same handle as
|
|
|
|
standard output.
|
|
|
|
|
2017-12-03 22:27:39 +01:00
|
|
|
`GIT_PRINT_SHA1_ELLIPSIS` (deprecated)::
|
|
|
|
If set to `yes`, print an ellipsis following an
|
|
|
|
(abbreviated) SHA-1 value. This affects indications of
|
|
|
|
detached HEADs (linkgit:git-checkout[1]) and the raw
|
|
|
|
diff output (linkgit:git-diff[1]). Printing an
|
|
|
|
ellipsis in the cases mentioned is no longer considered
|
|
|
|
adequate and support for it is likely to be removed in the
|
|
|
|
foreseeable future (along with the variable).
|
|
|
|
|
2005-08-30 22:51:01 +02:00
|
|
|
Discussion[[Discussion]]
|
|
|
|
------------------------
|
2007-09-03 06:01:19 +02:00
|
|
|
|
|
|
|
More detail on the following is available from the
|
2013-01-21 20:17:53 +01:00
|
|
|
link:user-manual.html#git-concepts[Git concepts chapter of the
|
2008-07-01 00:01:21 +02:00
|
|
|
user-manual] and linkgit:gitcore-tutorial[7].
|
2007-09-03 06:01:19 +02:00
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
A Git project normally consists of a working directory with a ".git"
|
2007-09-03 06:01:19 +02:00
|
|
|
subdirectory at the top level. The .git directory contains, among other
|
|
|
|
things, a compressed object database representing the complete history
|
|
|
|
of the project, an "index" file which links that history to the current
|
|
|
|
contents of the working tree, and named pointers into that history such
|
|
|
|
as tags and branch heads.
|
|
|
|
|
|
|
|
The object database contains objects of three main types: blobs, which
|
|
|
|
hold file data; trees, which point to blobs and other trees to build up
|
2007-12-18 07:07:36 +01:00
|
|
|
directory hierarchies; and commits, which each reference a single tree
|
2007-09-03 06:01:19 +02:00
|
|
|
and some number of parent commits.
|
|
|
|
|
|
|
|
The commit, equivalent to what other systems call a "changeset" or
|
|
|
|
"version", represents a step in the project's history, and each parent
|
|
|
|
represents an immediately preceding step. Commits with more than one
|
|
|
|
parent represent merges of independent lines of development.
|
|
|
|
|
2013-04-15 19:49:04 +02:00
|
|
|
All objects are named by the SHA-1 hash of their contents, normally
|
2007-09-03 06:01:19 +02:00
|
|
|
written as a string of 40 hex digits. Such names are globally unique.
|
|
|
|
The entire history leading up to a commit can be vouched for by signing
|
|
|
|
just that commit. A fourth object type, the tag, is provided for this
|
|
|
|
purpose.
|
|
|
|
|
|
|
|
When first created, objects are stored in individual files, but for
|
|
|
|
efficiency may later be compressed together into "pack files".
|
|
|
|
|
|
|
|
Named pointers called refs mark interesting points in history. A ref
|
2013-04-15 19:49:04 +02:00
|
|
|
may contain the SHA-1 name of an object or the name of another ref. Refs
|
|
|
|
with names beginning `ref/head/` contain the SHA-1 name of the most
|
|
|
|
recent commit (or "head") of a branch under development. SHA-1 names of
|
2007-09-03 06:01:19 +02:00
|
|
|
tags of interest are stored under `ref/tags/`. A special ref named
|
|
|
|
`HEAD` contains the name of the currently checked-out branch.
|
|
|
|
|
|
|
|
The index file is initialized with a list of all paths and, for each
|
|
|
|
path, a blob object and a set of attributes. The blob object represents
|
|
|
|
the contents of the file as of the head of the current branch. The
|
|
|
|
attributes (last modified time, size, etc.) are taken from the
|
|
|
|
corresponding file in the working tree. Subsequent changes to the
|
|
|
|
working tree can be found by comparing these attributes. The index may
|
|
|
|
be updated with new content, and new commits may be created from the
|
|
|
|
content stored in the index.
|
|
|
|
|
|
|
|
The index is also capable of storing multiple entries (called "stages")
|
|
|
|
for a given pathname. These stages are used to hold the various
|
|
|
|
unmerged version of a file when a merge is in progress.
|
2005-05-22 19:44:16 +02:00
|
|
|
|
2012-08-17 21:48:52 +02:00
|
|
|
FURTHER DOCUMENTATION
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
See the references in the "description" section to get started
|
2013-01-21 20:17:53 +01:00
|
|
|
using Git. The following is probably more detail than necessary
|
2012-08-17 21:48:52 +02:00
|
|
|
for a first-time user.
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
The link:user-manual.html#git-concepts[Git concepts chapter of the
|
2012-08-17 21:48:52 +02:00
|
|
|
user-manual] and linkgit:gitcore-tutorial[7] both provide
|
2013-01-21 20:17:53 +01:00
|
|
|
introductions to the underlying Git architecture.
|
2012-08-17 21:48:52 +02:00
|
|
|
|
|
|
|
See linkgit:gitworkflows[7] for an overview of recommended workflows.
|
|
|
|
|
|
|
|
See also the link:howto-index.html[howto] documents for some useful
|
|
|
|
examples.
|
|
|
|
|
|
|
|
The internals are documented in the
|
2013-01-21 20:16:20 +01:00
|
|
|
link:technical/api-index.html[Git API documentation].
|
2012-08-17 21:48:52 +02:00
|
|
|
|
|
|
|
Users migrating from CVS may also want to
|
|
|
|
read linkgit:gitcvs-migration[7].
|
|
|
|
|
|
|
|
|
2005-11-16 00:31:25 +01:00
|
|
|
Authors
|
|
|
|
-------
|
2011-03-11 06:52:08 +01:00
|
|
|
Git was started by Linus Torvalds, and is currently maintained by Junio
|
2013-01-21 20:17:53 +01:00
|
|
|
C Hamano. Numerous contributions have come from the Git mailing list
|
2014-07-23 14:32:09 +02:00
|
|
|
<git@vger.kernel.org>. http://www.openhub.net/p/git/contributors/summary
|
2012-12-12 19:06:24 +01:00
|
|
|
gives you a more complete list of contributors.
|
|
|
|
|
|
|
|
If you have a clone of git.git itself, the
|
2011-03-13 04:00:38 +01:00
|
|
|
output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
|
|
|
|
the authors for specific parts of the project.
|
2005-05-10 23:32:30 +02:00
|
|
|
|
2010-08-02 18:07:39 +02:00
|
|
|
Reporting Bugs
|
|
|
|
--------------
|
|
|
|
|
|
|
|
Report bugs to the Git mailing list <git@vger.kernel.org> where the
|
|
|
|
development and maintenance is primarily done. You do not have to be
|
|
|
|
subscribed to the list to send a message there.
|
|
|
|
|
2018-03-08 16:08:20 +01:00
|
|
|
Issues which are security relevant should be disclosed privately to
|
|
|
|
the Git Security mailing list <git-security@googlegroups.com>.
|
|
|
|
|
2008-05-29 19:21:46 +02:00
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
|
2014-10-10 23:25:37 +02:00
|
|
|
linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
|
2008-05-29 19:21:46 +02:00
|
|
|
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
|
2009-06-06 15:11:07 +02:00
|
|
|
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
|
|
|
|
linkgit:gitworkflows[7]
|
2008-05-29 19:21:46 +02:00
|
|
|
|
2005-05-10 23:32:30 +02:00
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|