doc: more consistency in environment variables format
Wrap with backticks (monospaced font) unwrapped or single-quotes wrapped (italic type) environment variables which are followed by the word "environment". It was obtained with: perl -pi -e "s/\'?(\\\$?[0-9A-Z\_]+)\'?(?= environment ?)/\`\1\`/g" *.txt One of the main purposes is to stick to the CodingGuidelines as possible so that people writting new documentation by mimicking the existing are more likely to have it right (even if they didn't read the CodingGuidelines). Signed-off-by: Tom Russello <tom.russello@grenoble-inp.org> Signed-off-by: Erwan Mathoniere <erwan.mathoniere@grenoble-inp.org> Signed-off-by: Samuel Groot <samuel.groot@grenoble-inp.org> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr> Reviewed-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
eee7f4a233
commit
47d81b5c7a
@ -478,9 +478,9 @@ false), while all other repositories are assumed to be bare (bare
|
|||||||
|
|
||||||
core.worktree::
|
core.worktree::
|
||||||
Set the path to the root of the working tree.
|
Set the path to the root of the working tree.
|
||||||
If GIT_COMMON_DIR environment variable is set, core.worktree
|
If `GIT_COMMON_DIR` environment variable is set, core.worktree
|
||||||
is ignored and not used for determining the root of working tree.
|
is ignored and not used for determining the root of working tree.
|
||||||
This can be overridden by the GIT_WORK_TREE environment
|
This can be overridden by the `GIT_WORK_TREE` environment
|
||||||
variable and the '--work-tree' command-line option.
|
variable and the '--work-tree' command-line option.
|
||||||
The value can be an absolute path or relative to the path to
|
The value can be an absolute path or relative to the path to
|
||||||
the .git directory, which is either specified by --git-dir
|
the .git directory, which is either specified by --git-dir
|
||||||
@ -621,7 +621,7 @@ core.askPass::
|
|||||||
ask for a password can be told to use an external program given
|
ask for a password can be told to use an external program given
|
||||||
via the value of this variable. Can be overridden by the `GIT_ASKPASS`
|
via the value of this variable. Can be overridden by the `GIT_ASKPASS`
|
||||||
environment variable. If not set, fall back to the value of the
|
environment variable. If not set, fall back to the value of the
|
||||||
'SSH_ASKPASS' environment variable or, failing that, a simple password
|
`SSH_ASKPASS` environment variable or, failing that, a simple password
|
||||||
prompt. The external program shall be given a suitable prompt as
|
prompt. The external program shall be given a suitable prompt as
|
||||||
command-line argument and write the password on its STDOUT.
|
command-line argument and write the password on its STDOUT.
|
||||||
|
|
||||||
@ -1582,7 +1582,7 @@ guitool.<name>.confirm::
|
|||||||
|
|
||||||
guitool.<name>.argPrompt::
|
guitool.<name>.argPrompt::
|
||||||
Request a string argument from the user, and pass it to the tool
|
Request a string argument from the user, and pass it to the tool
|
||||||
through the 'ARGS' environment variable. Since requesting an
|
through the `ARGS` environment variable. Since requesting an
|
||||||
argument implies confirmation, the 'confirm' option has no effect
|
argument implies confirmation, the 'confirm' option has no effect
|
||||||
if this is enabled. If the option is set to 'true', 'yes', or '1',
|
if this is enabled. If the option is set to 'true', 'yes', or '1',
|
||||||
the dialog uses a built-in generic prompt; otherwise the exact
|
the dialog uses a built-in generic prompt; otherwise the exact
|
||||||
@ -1590,7 +1590,7 @@ guitool.<name>.argPrompt::
|
|||||||
|
|
||||||
guitool.<name>.revPrompt::
|
guitool.<name>.revPrompt::
|
||||||
Request a single valid revision from the user, and set the
|
Request a single valid revision from the user, and set the
|
||||||
'REVISION' environment variable. In other aspects this option
|
`REVISION` environment variable. In other aspects this option
|
||||||
is similar to 'argPrompt', and can be used together with it.
|
is similar to 'argPrompt', and can be used together with it.
|
||||||
|
|
||||||
guitool.<name>.revUnmerged::
|
guitool.<name>.revUnmerged::
|
||||||
@ -2856,7 +2856,7 @@ url.<base>.pushInsteadOf::
|
|||||||
user.email::
|
user.email::
|
||||||
Your email address to be recorded in any newly created commits.
|
Your email address to be recorded in any newly created commits.
|
||||||
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
|
Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
|
||||||
'EMAIL' environment variables. See linkgit:git-commit-tree[1].
|
`EMAIL` environment variables. See linkgit:git-commit-tree[1].
|
||||||
|
|
||||||
user.name::
|
user.name::
|
||||||
Your full name to be recorded in any newly created commits.
|
Your full name to be recorded in any newly created commits.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
DATE FORMATS
|
DATE FORMATS
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
|
The `GIT_AUTHOR_DATE`, `GIT_COMMITTER_DATE` environment variables
|
||||||
ifdef::git-commit[]
|
ifdef::git-commit[]
|
||||||
and the `--date` option
|
and the `--date` option
|
||||||
endif::git-commit[]
|
endif::git-commit[]
|
||||||
|
@ -6,7 +6,7 @@ with a '-p' option, "git diff" without the '--raw' option, or
|
|||||||
"git log" with the "-p" option, they
|
"git log" with the "-p" option, they
|
||||||
do not produce the output described above; instead they produce a
|
do not produce the output described above; instead they produce a
|
||||||
patch file. You can customize the creation of such patches via the
|
patch file. You can customize the creation of such patches via the
|
||||||
GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.
|
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.
|
||||||
|
|
||||||
What the -p option produces is slightly different from the traditional
|
What the -p option produces is slightly different from the traditional
|
||||||
diff format:
|
diff format:
|
||||||
|
@ -366,7 +366,7 @@ skip" to do the same thing. (In fact the special exit code 125 makes
|
|||||||
|
|
||||||
Or if you want more control, you can inspect the current state using
|
Or if you want more control, you can inspect the current state using
|
||||||
for example "git bisect visualize". It will launch gitk (or "git log"
|
for example "git bisect visualize". It will launch gitk (or "git log"
|
||||||
if the DISPLAY environment variable is not set) to help you find a
|
if the `DISPLAY` environment variable is not set) to help you find a
|
||||||
better bisection point.
|
better bisection point.
|
||||||
|
|
||||||
Either way, if you have a string of untestable commits, it might
|
Either way, if you have a string of untestable commits, it might
|
||||||
|
@ -205,7 +205,7 @@ $ git bisect visualize
|
|||||||
|
|
||||||
`view` may also be used as a synonym for `visualize`.
|
`view` may also be used as a synonym for `visualize`.
|
||||||
|
|
||||||
If the 'DISPLAY' environment variable is not set, 'git log' is used
|
If the `DISPLAY` environment variable is not set, 'git log' is used
|
||||||
instead. You can also give command-line options such as `-p` and
|
instead. You can also give command-line options such as `-p` and
|
||||||
`--stat`.
|
`--stat`.
|
||||||
|
|
||||||
|
@ -449,8 +449,8 @@ include::i18n.txt[]
|
|||||||
ENVIRONMENT AND CONFIGURATION VARIABLES
|
ENVIRONMENT AND CONFIGURATION VARIABLES
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
The editor used to edit the commit log message will be chosen from the
|
The editor used to edit the commit log message will be chosen from the
|
||||||
GIT_EDITOR environment variable, the core.editor configuration variable, the
|
`GIT_EDITOR` environment variable, the core.editor configuration variable, the
|
||||||
VISUAL environment variable, or the EDITOR environment variable (in that
|
`VISUAL` environment variable, or the `EDITOR` environment variable (in that
|
||||||
order). See linkgit:git-var[1] for details.
|
order). See linkgit:git-var[1] for details.
|
||||||
|
|
||||||
HOOKS
|
HOOKS
|
||||||
|
@ -269,7 +269,7 @@ and '--unset'. *'git config' will only ever change one file at a time*.
|
|||||||
|
|
||||||
You can override these rules either by command-line options or by environment
|
You can override these rules either by command-line options or by environment
|
||||||
variables. The '--global' and the '--system' options will limit the file used
|
variables. The '--global' and the '--system' options will limit the file used
|
||||||
to the global or system-wide file respectively. The GIT_CONFIG environment
|
to the global or system-wide file respectively. The `GIT_CONFIG` environment
|
||||||
variable has a similar effect, but you can specify any filename you want.
|
variable has a similar effect, but you can specify any filename you want.
|
||||||
|
|
||||||
|
|
||||||
|
@ -188,7 +188,7 @@ Git configuration files in that directory are readable by `<user>`.
|
|||||||
arguments. The external command can decide to decline the
|
arguments. The external command can decide to decline the
|
||||||
service by exiting with a non-zero status (or to allow it by
|
service by exiting with a non-zero status (or to allow it by
|
||||||
exiting with a zero status). It can also look at the $REMOTE_ADDR
|
exiting with a zero status). It can also look at the $REMOTE_ADDR
|
||||||
and $REMOTE_PORT environment variables to learn about the
|
and `$REMOTE_PORT` environment variables to learn about the
|
||||||
requestor when making this decision.
|
requestor when making this decision.
|
||||||
+
|
+
|
||||||
The external command can optionally write a single line to its
|
The external command can optionally write a single line to its
|
||||||
|
@ -61,7 +61,7 @@ Filters
|
|||||||
The filters are applied in the order as listed below. The <command>
|
The filters are applied in the order as listed below. The <command>
|
||||||
argument is always evaluated in the shell context using the 'eval' command
|
argument is always evaluated in the shell context using the 'eval' command
|
||||||
(with the notable exception of the commit filter, for technical reasons).
|
(with the notable exception of the commit filter, for technical reasons).
|
||||||
Prior to that, the $GIT_COMMIT environment variable will be set to contain
|
Prior to that, the `$GIT_COMMIT` environment variable will be set to contain
|
||||||
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
|
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
|
||||||
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
|
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
|
||||||
and GIT_COMMITTER_DATE are taken from the current commit and exported to
|
and GIT_COMMITTER_DATE are taken from the current commit and exported to
|
||||||
|
@ -128,7 +128,7 @@ will try to use konqueror first. But this may fail (for example, if
|
|||||||
DISPLAY is not set) and in that case emacs' woman mode will be tried.
|
DISPLAY is not set) and in that case emacs' woman mode will be tried.
|
||||||
|
|
||||||
If everything fails, or if no viewer is configured, the viewer specified
|
If everything fails, or if no viewer is configured, the viewer specified
|
||||||
in the GIT_MAN_VIEWER environment variable will be tried. If that
|
in the `GIT_MAN_VIEWER` environment variable will be tried. If that
|
||||||
fails too, the 'man' program will be tried anyway.
|
fails too, the 'man' program will be tried anyway.
|
||||||
|
|
||||||
man.<tool>.path
|
man.<tool>.path
|
||||||
|
@ -21,7 +21,7 @@ pushing using the smart HTTP protocol.
|
|||||||
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` environmental 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
|
||||||
@ -241,7 +241,7 @@ $HTTP["url"] =~ "^/git/private" {
|
|||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
-----------
|
-----------
|
||||||
'git http-backend' relies upon the CGI environment variables set
|
'git http-backend' relies upon the `CGI` environment variables set
|
||||||
by the invoking web server, including:
|
by the invoking web server, including:
|
||||||
|
|
||||||
* PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
|
* PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
|
||||||
@ -251,7 +251,7 @@ 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` environmental 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.
|
||||||
|
|
||||||
@ -269,7 +269,7 @@ GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
|
|||||||
ensuring that any reflogs created by 'git-receive-pack' contain some
|
ensuring that any reflogs created by 'git-receive-pack' contain some
|
||||||
identifying information of the remote user who performed the push.
|
identifying information of the remote user who performed the push.
|
||||||
|
|
||||||
All CGI environment variables are available to each of the hooks
|
All `CGI` environment variables are available to each of the hooks
|
||||||
invoked by the 'git-receive-pack'.
|
invoked by the 'git-receive-pack'.
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
|
@ -47,7 +47,7 @@ Only print error and warning messages; all other output will be suppressed.
|
|||||||
|
|
||||||
--bare::
|
--bare::
|
||||||
|
|
||||||
Create a bare repository. If GIT_DIR environment is not set, it is set to the
|
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
|
||||||
current working directory.
|
current working directory.
|
||||||
|
|
||||||
--template=<template_directory>::
|
--template=<template_directory>::
|
||||||
|
@ -134,7 +134,7 @@ Submit
|
|||||||
~~~~~~
|
~~~~~~
|
||||||
Submitting changes from a Git repository back to the p4 repository
|
Submitting changes from a Git repository back to the p4 repository
|
||||||
requires a separate p4 client workspace. This should be specified
|
requires a separate p4 client workspace. This should be specified
|
||||||
using the 'P4CLIENT' environment variable or the Git configuration
|
using the `P4CLIENT` environment variable or the Git configuration
|
||||||
variable 'git-p4.client'. The p4 client must exist, but the client root
|
variable 'git-p4.client'. The p4 client must exist, but the client root
|
||||||
will be created and populated if it does not already exist.
|
will be created and populated if it does not already exist.
|
||||||
|
|
||||||
|
@ -46,14 +46,14 @@ OPTIONS
|
|||||||
The directory to find the quilt patches.
|
The directory to find the quilt patches.
|
||||||
+
|
+
|
||||||
The default for the patch directory is patches
|
The default for the patch directory is patches
|
||||||
or the value of the $QUILT_PATCHES environment
|
or the value of the `$QUILT_PATCHES` environment
|
||||||
variable.
|
variable.
|
||||||
|
|
||||||
--series <file>::
|
--series <file>::
|
||||||
The quilt series file.
|
The quilt series file.
|
||||||
+
|
+
|
||||||
The default for the series file is <patches>/series
|
The default for the series file is <patches>/series
|
||||||
or the value of the $QUILT_SERIES environment
|
or the value of the `$QUILT_SERIES` environment
|
||||||
variable.
|
variable.
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
|
@ -41,7 +41,7 @@ usage::
|
|||||||
die with the usage message.
|
die with the usage message.
|
||||||
|
|
||||||
set_reflog_action::
|
set_reflog_action::
|
||||||
Set GIT_REFLOG_ACTION environment to a given string (typically
|
Set `GIT_REFLOG_ACTION` environment to a given string (typically
|
||||||
the name of the program) unless it is already set. Whenever
|
the name of the program) unless it is already set. Whenever
|
||||||
the script runs a `git` command that updates refs, a reflog
|
the script runs a `git` command that updates refs, a reflog
|
||||||
entry is created using the value of this string to leave the
|
entry is created using the value of this string to leave the
|
||||||
|
@ -572,7 +572,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string.
|
|||||||
|
|
||||||
--git-dir=<path>::
|
--git-dir=<path>::
|
||||||
Set the path to the repository. This can also be controlled by
|
Set the path to the repository. This can also be controlled by
|
||||||
setting the GIT_DIR environment variable. It can be an absolute
|
setting the `GIT_DIR` environment variable. It can be an absolute
|
||||||
path or relative path to current working directory.
|
path or relative path to current working directory.
|
||||||
|
|
||||||
--work-tree=<path>::
|
--work-tree=<path>::
|
||||||
|
@ -376,7 +376,7 @@ $site_name::
|
|||||||
Name of your site or organization, to appear in page titles. Set it
|
Name of your site or organization, to appear in page titles. Set it
|
||||||
to something descriptive for clearer bookmarks etc. If this variable
|
to something descriptive for clearer bookmarks etc. If this variable
|
||||||
is not set or is, then gitweb uses the value of the `SERVER_NAME`
|
is not set or is, then gitweb uses the value of the `SERVER_NAME`
|
||||||
CGI environment variable, setting site name to "$SERVER_NAME Git",
|
`CGI` environment variable, setting site name to "$SERVER_NAME Git",
|
||||||
or "Untitled Git" if this variable is not set (e.g. if running gitweb
|
or "Untitled Git" if this variable is not set (e.g. if running gitweb
|
||||||
as standalone script).
|
as standalone script).
|
||||||
+
|
+
|
||||||
|
Loading…
Reference in New Issue
Block a user