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>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index b50110ab39a2d7dae50f8bb5f722d2668a41140a..56f51ae88327669b6f3661d5c366d03745c0afdd 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -478,9 +478,9 @@ false), while all other repositories are assumed to be bare (bare
 
 core.worktree::
        Set the path to the root of the working tree.
 
 core.worktree::
        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.
        The value can be an absolute path or relative to the path to
        the .git directory, which is either specified by --git-dir
        variable and the '--work-tree' command-line option.
        The value can be an absolute path or relative to the path to
        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
        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
        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`
        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
        command-line argument and write the password on its STDOUT.
 
        prompt. The external program shall be given a suitable prompt as
        command-line argument and write the password on its STDOUT.
 


@@ -1582,7 +1582,7 @@ guitool.<name>.confirm::
 
 guitool.<name>.argPrompt::
        Request a string argument from the user, and pass it to the tool
 
 guitool.<name>.argPrompt::
        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
        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
        argument implies confirmation, the 'confirm' option has no effect
        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


@@ -1590,7 +1590,7 @@ guitool.<name>.argPrompt::
 
 guitool.<name>.revPrompt::
        Request a single valid revision from the user, and set the
 
 guitool.<name>.revPrompt::
        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.
 
 guitool.<name>.revUnmerged::
        is similar to 'argPrompt', and can be used together with it.
 
 guitool.<name>.revUnmerged::


@@ -2856,7 +2856,7 @@ url.<base>.pushInsteadOf::
 user.email::
        Your email address to be recorded in any newly created commits.
        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
 user.email::
        Your email address to be recorded in any newly created commits.
        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::
        Your full name to be recorded in any newly created commits.
 
 user.name::
        Your full name to be recorded in any newly created commits.

diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt
index ccd1fc8122a74be4ac04fd7be905ebf881f7413b..35e8da201005dee34b75c87aebf720a8f7300a9c 100644 (file)
--- a/Documentation/date-formats.txt
+++ b/Documentation/date-formats.txt
@@ -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[]
 and the `--date` option
 endif::git-commit[]
 ifdef::git-commit[]
 and the `--date` option
 endif::git-commit[]

diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
index bcf54da82a8c11367354a86efd8c802f58a6e502..c91afee21cc29000883aeefbde64047245da900d 100644 (file)
--- a/Documentation/diff-generate-patch.txt
+++ b/Documentation/diff-generate-patch.txt
@@ -6,7 +6,7 @@ with a '-p' option, "git diff" without the '--raw' option, or
 "git log" with the "-p" option, they
 do not produce the output described above; instead they produce a
 patch file.  You can customize the creation of such patches via the
 "git log" with the "-p" option, they
 do not produce the output described above; instead they produce a
 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
 diff format:
 
 What the -p option produces is slightly different from the traditional
 diff format:

diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index c06efbd42a6c1010f0a5ec17ba460e0ebcd91d9d..e015f5b3ccc7651def48b63466072ea51eaecaa0 100644 (file)
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -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
 for example "git bisect visualize". It will launch gitk (or "git log"
 
 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"

-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.
 
 Either way, if you have a string of untestable commits, it might
 better bisection point.
 
 Either way, if you have a string of untestable commits, it might

diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 7e79aaedeb58632bca9edb6c1f7715c493139bb6..d9f960b509146f2d7556ddd621b5eec70af49a73 100644 (file)
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -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
 `--stat`.
 
 instead.  You can also give command-line options such as `-p` and
 `--stat`.
 

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 9ec6b3cc17fd776b16f6410cf88c708831d4bca3..3fd7ff1eefccd5fdc27fbfbc41183a513750b3f3 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -449,8 +449,8 @@ include::i18n.txt[]
 ENVIRONMENT AND CONFIGURATION VARIABLES
 ---------------------------------------
 The editor used to edit the commit log message will be chosen from the
 ENVIRONMENT AND CONFIGURATION VARIABLES
 ---------------------------------------
 The editor used to edit the commit log message will be chosen from the

-GIT_EDITOR environment variable, the core.editor configuration variable, the
-VISUAL environment variable, or the EDITOR environment variable (in that
+`GIT_EDITOR` environment variable, the core.editor configuration variable, the
+`VISUAL` environment variable, or the `EDITOR` environment variable (in that

 order).  See linkgit:git-var[1] for details.
 
 HOOKS
 order).  See linkgit:git-var[1] for details.
 
 HOOKS

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 6843114fc034098e23707947f146ce36c518ed1f..a89c30491653128c706e9920fe624dd59d7ba002 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -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
 variables. The '--global' and the '--system' options will limit the file used
 
 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

-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.
 
 

diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index a69b3616ec3bdc9686114f4d0b7a851c0ce93339..dc202758252fb78c4dea88c84158d34c8b8bce1b 100644 (file)
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -188,7 +188,7 @@ Git configuration files in that directory are readable by `<user>`.
        arguments. The external command can decide to decline the
        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
        arguments. The external command can decide to decline the
        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

-       and $REMOTE_PORT environment variables to learn about the
+       and `$REMOTE_PORT` environment variables to learn about the

        requestor when making this decision.
 +
 The external command can optionally write a single line to its
        requestor when making this decision.
 +
 The external command can optionally write a single line to its

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 003731f6a990559fc4f0c785687a639bae218468..bd560d38d9f25c234486c1d6fbed963ab93c7927 100644 (file)
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -61,7 +61,7 @@ Filters
 The filters are applied in the order as listed below.  The <command>
 argument is always evaluated in the shell context using the 'eval' command
 (with the notable exception of the commit filter, for technical reasons).
 The filters are applied in the order as listed below.  The <command>
 argument is always evaluated in the shell context using the 'eval' command
 (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,
 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
 the id of the commit being rewritten.  Also, GIT_AUTHOR_NAME,
 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

diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 3956525218bf45f2968fe2039e4dfb75a6f2222b..679d5397b365269af6975b70562129f13bb6b090 100644 (file)
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -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.
 
 If everything fails, or if no viewer is configured, the viewer specified
 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

-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.
 
 man.<tool>.path
 fails too, the 'man' program will be tried anyway.
 
 man.<tool>.path

diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index 9268fb6b1ea2de2b29fb077a1a675c727526abeb..bb0db195cebd6b8c3824fde4cc3ccdcec4d96543 100644 (file)
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -21,7 +21,7 @@ pushing using the smart HTTP protocol.
 It verifies that the directory has the magic file
 "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
 It verifies that the directory has the magic file
 "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

-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
 'git fetch-pack' and 'git ls-remote' clients, which are invoked from
 
 By default, only the `upload-pack` service is enabled, which serves
 '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:
 
 * PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
 by the invoking web server, including:
 
 * PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)


@@ -251,7 +251,7 @@ by the invoking web server, including:
 * QUERY_STRING
 * REQUEST_METHOD
 
 * QUERY_STRING
 * 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"
 file in each repository before allowing export of that repository.
 
 'git-http-backend' to bypass the check for the "git-daemon-export-ok"
 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
 identifying information of the remote user who performed the push.
 
 ensuring that any reflogs created by 'git-receive-pack' contain some
 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'.
 
 GIT
 invoked by the 'git-receive-pack'.
 
 GIT

diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 8174d27efdc13b3f611b4aedda70086f39867d73..341a164b91c83b3993055432a2e61bbd36574f90 100644 (file)
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -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.
 
 --template=<template_directory>::
 current working directory.
 
 --template=<template_directory>::

diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index c349276eea56acfd4b6b7177cbbb8b7fb6e5a620..454bdb33f2d87982bc53a5aef45b03e3690cbebf 100644 (file)
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -134,7 +134,7 @@ Submit
 ~~~~~~
 Submitting changes from a Git repository back to the p4 repository
 requires a separate p4 client workspace.  This should be specified
 ~~~~~~
 Submitting changes from a Git repository back to the p4 repository
 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
 will be created and populated if it does not already exist.
 
 variable 'git-p4.client'.  The p4 client must exist, but the client root
 will be created and populated if it does not already exist.
 

diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index ff633b0db7d54d8db12c4af248fc2bd3939b6f9c..8cf952b4de669ea3e7275c5d10087005548574eb 100644 (file)
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -46,14 +46,14 @@ OPTIONS
        The directory to find the quilt patches.
 +
 The default for the patch directory is patches
        The directory to find the quilt 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.
 
 --series <file>::
        The quilt series file.
 +
 The default for the series file is <patches>/series
 variable.
 
 --series <file>::
        The quilt series file.
 +
 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.
 
 GIT
 variable.
 
 GIT

diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index 4f67c4cde679cf03e8cc43ac0630a45b5e68aa2d..8632612c31d07818659ff4f68ee567c789e5cd48 100644 (file)
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -41,7 +41,7 @@ usage::
        die with the usage message.
 
 set_reflog_action::
        die with the usage message.
 
 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 script runs a `git` command that updates refs, a reflog
        entry is created using the value of this string to leave the
        the name of the program) unless it is already set.  Whenever
        the script runs a `git` command that updates refs, a reflog
        entry is created using the value of this string to leave the

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 0fd9ff89523280232edb4dad948828af394fb44a..cd213a7e3b36c6245668cb7a3ba0a458336e9fb0 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -572,7 +572,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string.
 
 --git-dir=<path>::
        Set the path to the repository. This can also be controlled by
 
 --git-dir=<path>::
        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.
 
 --work-tree=<path>::
        path or relative path to current working directory.
 
 --work-tree=<path>::

diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 8a42270074e3875c2919346f6c059e428aefa1ce..a79e35024623904145c7ac2031f8416bac6e6e23 100644 (file)
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -376,7 +376,7 @@ $site_name::
        Name of your site or organization, to appear in page titles.  Set it
        to something descriptive for clearer bookmarks etc.  If this variable
        is not set or is, then gitweb uses the value of the `SERVER_NAME`
        Name of your site or organization, to appear in page titles.  Set it
        to something descriptive for clearer bookmarks etc.  If this variable
        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
        as standalone script).
 +
        or "Untitled Git" if this variable is not set (e.g. if running gitweb
        as standalone script).
 +