@matheusbsbs / matheus-bagliano / commits / 47d81b5c7a

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>

Tom Russello committed Jun 8, 2016 at 00:35 UTC 47d81b5c7a3e7737d26b877a5cfebb772d75fa12

17 files changed +27 -27

Documentation/config.txt

+6 -6

@@ -478,9 +478,9 @@ false), while all other repositories are assumed to be bare (bare

478

479 core.worktree::

480 Set the path to the root of the working tree.

481 - If GIT_COMMON_DIR environment variable is set, core.worktree

481 + If `GIT_COMMON_DIR` environment variable is set, core.worktree

482 is ignored and not used for determining the root of working tree.

483 - This can be overridden by the GIT_WORK_TREE environment

483 + This can be overridden by the `GIT_WORK_TREE` environment

484 variable and the '--work-tree' command-line option.

485 The value can be an absolute path or relative to the path to

486 the .git directory, which is either specified by --git-dir

@@ -621,7 +621,7 @@ core.askPass::

621 ask for a password can be told to use an external program given

622 via the value of this variable. Can be overridden by the `GIT_ASKPASS`

623 environment variable. If not set, fall back to the value of the

624 - 'SSH_ASKPASS' environment variable or, failing that, a simple password

624 + `SSH_ASKPASS` environment variable or, failing that, a simple password

625 prompt. The external program shall be given a suitable prompt as

626 command-line argument and write the password on its STDOUT.

627

@@ -1582,7 +1582,7 @@ guitool.<name>.confirm::

1582

1583 guitool.<name>.argPrompt::

1584 Request a string argument from the user, and pass it to the tool

1585 - through the 'ARGS' environment variable. Since requesting an

1585 + through the `ARGS` environment variable. Since requesting an

1586 argument implies confirmation, the 'confirm' option has no effect

1587 if this is enabled. If the option is set to 'true', 'yes', or '1',

1588 the dialog uses a built-in generic prompt; otherwise the exact

@@ -1590,7 +1590,7 @@ guitool.<name>.argPrompt::

1590

1591 guitool.<name>.revPrompt::

1592 Request a single valid revision from the user, and set the

1593 - 'REVISION' environment variable. In other aspects this option

1593 + `REVISION` environment variable. In other aspects this option

1594 is similar to 'argPrompt', and can be used together with it.

1595

1596 guitool.<name>.revUnmerged::

@@ -2856,7 +2856,7 @@ url.<base>.pushInsteadOf::

2856 user.email::

2857 Your email address to be recorded in any newly created commits.

2858 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and

2859 - 'EMAIL' environment variables. See linkgit:git-commit-tree[1].

2859 + `EMAIL` environment variables. See linkgit:git-commit-tree[1].

2860

2861 user.name::

2862 Your full name to be recorded in any newly created commits.

Documentation/date-formats.txt

+1 -1

@@ -1,7 +1,7 @@

1 DATE FORMATS

2 ------------

4 -The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables

4 +The `GIT_AUTHOR_DATE`, `GIT_COMMITTER_DATE` environment variables

5 ifdef::git-commit[]

6 and the `--date` option

7 endif::git-commit[]

Documentation/diff-generate-patch.txt

+1 -1

@@ -6,7 +6,7 @@ with a '-p' option, "git diff" without the '--raw' option, or

6 "git log" with the "-p" option, they

7 do not produce the output described above; instead they produce a

8 patch file. You can customize the creation of such patches via the

9 -GIT_EXTERNAL_DIFF and the GIT_DIFF_OPTS environment variables.

9 +`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables.

11 What the -p option produces is slightly different from the traditional

12 diff format:

Documentation/git-bisect-lk2009.txt

+1 -1

@@ -366,7 +366,7 @@ skip" to do the same thing. (In fact the special exit code 125 makes

366

367 Or if you want more control, you can inspect the current state using

368 for example "git bisect visualize". It will launch gitk (or "git log"

369 -if the DISPLAY environment variable is not set) to help you find a

369 +if the `DISPLAY` environment variable is not set) to help you find a

370 better bisection point.

371

372 Either way, if you have a string of untestable commits, it might

Documentation/git-bisect.txt

+1 -1

@@ -205,7 +205,7 @@ $ git bisect visualize

205

206 `view` may also be used as a synonym for `visualize`.

207

208 -If the 'DISPLAY' environment variable is not set, 'git log' is used

208 +If the `DISPLAY` environment variable is not set, 'git log' is used

209 instead. You can also give command-line options such as `-p` and

210 `--stat`.

211

Documentation/git-commit.txt

+2 -2

@@ -449,8 +449,8 @@ include::i18n.txt[]

449 ENVIRONMENT AND CONFIGURATION VARIABLES

450 ---------------------------------------

451 The editor used to edit the commit log message will be chosen from the

452 -GIT_EDITOR environment variable, the core.editor configuration variable, the

453 -VISUAL environment variable, or the EDITOR environment variable (in that

452 +`GIT_EDITOR` environment variable, the core.editor configuration variable, the

453 +`VISUAL` environment variable, or the `EDITOR` environment variable (in that

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

455

456 HOOKS

Documentation/git-config.txt

+1 -1

@@ -269,7 +269,7 @@ and '--unset'. *'git config' will only ever change one file at a time*.

269

270 You can override these rules either by command-line options or by environment

271 variables. The '--global' and the '--system' options will limit the file used

272 -to the global or system-wide file respectively. The GIT_CONFIG environment

272 +to the global or system-wide file respectively. The `GIT_CONFIG` environment

273 variable has a similar effect, but you can specify any filename you want.

274

275

Documentation/git-daemon.txt

+1 -1

@@ -188,7 +188,7 @@ Git configuration files in that directory are readable by `<user>`.

188 arguments. The external command can decide to decline the

189 service by exiting with a non-zero status (or to allow it by

190 exiting with a zero status). It can also look at the $REMOTE_ADDR

191 - and $REMOTE_PORT environment variables to learn about the

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

192 requestor when making this decision.

193 +

194 The external command can optionally write a single line to its

Documentation/git-filter-branch.txt

+1 -1

@@ -61,7 +61,7 @@ Filters

61 The filters are applied in the order as listed below. The <command>

62 argument is always evaluated in the shell context using the 'eval' command

63 (with the notable exception of the commit filter, for technical reasons).

64 -Prior to that, the $GIT_COMMIT environment variable will be set to contain

64 +Prior to that, the `$GIT_COMMIT` environment variable will be set to contain

65 the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,

66 GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,

67 and GIT_COMMITTER_DATE are taken from the current commit and exported to

Documentation/git-help.txt

+1 -1

@@ -128,7 +128,7 @@ will try to use konqueror first. But this may fail (for example, if

128 DISPLAY is not set) and in that case emacs' woman mode will be tried.

129

130 If everything fails, or if no viewer is configured, the viewer specified

131 -in the GIT_MAN_VIEWER environment variable will be tried. If that

131 +in the `GIT_MAN_VIEWER` environment variable will be tried. If that

132 fails too, the 'man' program will be tried anyway.

133

134 man.<tool>.path

Documentation/git-http-backend.txt

+4 -4

@@ -21,7 +21,7 @@ pushing using the smart HTTP protocol.

21 It verifies that the directory has the magic file

22 "git-daemon-export-ok", and it will refuse to export any Git directory

23 that hasn't explicitly been marked for export this way (unless the

24 -GIT_HTTP_EXPORT_ALL environmental variable is set).

24 +`GIT_HTTP_EXPORT_ALL` environmental variable is set).

26 By default, only the `upload-pack` service is enabled, which serves

27 'git fetch-pack' and 'git ls-remote' clients, which are invoked from

@@ -241,7 +241,7 @@ $HTTP["url"] =~ "^/git/private" {

241

242 ENVIRONMENT

243 -----------

244 -'git http-backend' relies upon the CGI environment variables set

244 +'git http-backend' relies upon the `CGI` environment variables set

245 by the invoking web server, including:

246

247 * PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)

@@ -251,7 +251,7 @@ by the invoking web server, including:

251 * QUERY_STRING

252 * REQUEST_METHOD

253

254 -The GIT_HTTP_EXPORT_ALL environmental variable may be passed to

254 +The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to

255 'git-http-backend' to bypass the check for the "git-daemon-export-ok"

256 file in each repository before allowing export of that repository.

257

@@ -269,7 +269,7 @@ GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',

269 ensuring that any reflogs created by 'git-receive-pack' contain some

270 identifying information of the remote user who performed the push.

271

272 -All CGI environment variables are available to each of the hooks

272 +All `CGI` environment variables are available to each of the hooks

273 invoked by the 'git-receive-pack'.

274

275 GIT

Documentation/git-init.txt

+1 -1

@@ -47,7 +47,7 @@ Only print error and warning messages; all other output will be suppressed.

48 --bare::

50 -Create a bare repository. If GIT_DIR environment is not set, it is set to the

50 +Create a bare repository. If `GIT_DIR` environment is not set, it is set to the

51 current working directory.

53 --template=<template_directory>::

Documentation/git-p4.txt

+1 -1

@@ -134,7 +134,7 @@ Submit

134 ~~~~~~

135 Submitting changes from a Git repository back to the p4 repository

136 requires a separate p4 client workspace. This should be specified

137 -using the 'P4CLIENT' environment variable or the Git configuration

137 +using the `P4CLIENT` environment variable or the Git configuration

138 variable 'git-p4.client'. The p4 client must exist, but the client root

139 will be created and populated if it does not already exist.

140

Documentation/git-quiltimport.txt

+2 -2

@@ -46,14 +46,14 @@ OPTIONS

46 The directory to find the quilt patches.

47 +

48 The default for the patch directory is patches

49 -or the value of the $QUILT_PATCHES environment

49 +or the value of the `$QUILT_PATCHES` environment

50 variable.

52 --series <file>::

53 The quilt series file.

54 +

55 The default for the series file is <patches>/series

56 -or the value of the $QUILT_SERIES environment

56 +or the value of the `$QUILT_SERIES` environment

57 variable.

59 GIT

Documentation/git-sh-setup.txt

+1 -1

@@ -41,7 +41,7 @@ usage::

41 die with the usage message.

43 set_reflog_action::

44 - Set GIT_REFLOG_ACTION environment to a given string (typically

44 + Set `GIT_REFLOG_ACTION` environment to a given string (typically

45 the name of the program) unless it is already set. Whenever

46 the script runs a `git` command that updates refs, a reflog

47 entry is created using the value of this string to leave the

Documentation/git.txt

+1 -1

@@ -572,7 +572,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string.

572

573 --git-dir=<path>::

574 Set the path to the repository. This can also be controlled by

575 - setting the GIT_DIR environment variable. It can be an absolute

575 + setting the `GIT_DIR` environment variable. It can be an absolute

576 path or relative path to current working directory.

577

578 --work-tree=<path>::

Documentation/gitweb.conf.txt

+1 -1

@@ -376,7 +376,7 @@ $site_name::

376 Name of your site or organization, to appear in page titles. Set it

377 to something descriptive for clearer bookmarks etc. If this variable

378 is not set or is, then gitweb uses the value of the `SERVER_NAME`

379 - CGI environment variable, setting site name to "$SERVER_NAME Git",

379 + `CGI` environment variable, setting site name to "$SERVER_NAME Git",

380 or "Untitled Git" if this variable is not set (e.g. if running gitweb

381 as standalone script).

382 +