{"thread":{"id":"42370","subject":"[RFC/PATCH] Formatting variables in the documentation","startedAt":"2016-05-18T15:58:29Z","lastAt":"2016-06-08T17:27:09Z","messageCount":34,"participants":["Tom Russello","Jeff King","Samuel GROOT","Matthieu Moy","Junio C Hamano","Erwan Mathoniere","Johannes Sixt"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"286890","messageId":"1463587109-22476-1-git-send-email-tom.russello@grenoble-inp.org","threadId":"42370","inReplyTo":null,"subject":"[RFC/PATCH] Formatting variables in the documentation","fromName":"Tom Russello","fromEmail":"tom.russello@grenoble-inp.org","sentAt":"2016-05-18T15:58:29Z","receivedAt":"2016-05-18T15:58:29Z","isPatch":true,"sender":{"key":"tom.russello@grenoble-inp.org","avatar":null},"body":"Put each environment variable in the same format for more consistency.\nCurrently, in Documentation/git-config.txt GIT_CONFIG (l.138) has no\nparticular style whereas in Documentation/config.txt GIT_PROXY_COMMAND\nhas italic style ('GIT_PROXY_COMMAND' - l.437) and GIT_EDITOR is\nmonospaced (`GIT_EDITOR` - l.657)\n\nAs a first step, this patch changes GIT_* variables that where in\nitalic style to monospace font. It was obtained with\n\n\tperl -pi -e \"s/\\'(GIT_.*?)\\'/\\`\\1\\`/g\" *.txt\n\nSigned-off-by: Tom Russello \nSigned-off-by: Matthieu Moy \n---\nHello,\n\nThere is no agreement on this topic (the CodingGuidelines does not\nmention it), it would be better if everyone follows the same rule: put\neach environment variable in monospace style and write this rule in\nthe guide.\n\nIt is a good thing to have a consistent documentation however it\nwill be painful to change with a simple regex all occurences\n(especially environment variables without any format) because some of\nthem are in paths or code section.\n\nWhat do you think ?\n\n Documentation/config.txt | 46 +++++++-------\n Documentation/git-log.txt | 4 +-\n Documentation/git-notes.txt | 20 +++---\n Documentation/git-p4.txt | 2 +-\n Documentation/git-replace.txt | 2 +-\n Documentation/git.txt | 120 ++++++++++++++++++------------------\n Documentation/gitremote-helpers.txt | 2 +-\n Documentation/gitweb.txt | 4 +-\n Documentation/merge-config.txt | 2 +-\n 9 files changed, 101 insertions(+), 101 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex ece0acd..7e34fad 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -418,7 +418,7 @@ core.gitProxy::\n \tmay be set multiple times and is matched in the given order;\n \tthe first match wins.\n +\n-Can be overridden by the 'GIT_PROXY_COMMAND' environment variable\n+Can be overridden by the `GIT_PROXY_COMMAND` environment variable\n (which always applies universally, without the special \"for\"\n handling).\n +\n@@ -604,7 +604,7 @@ core.excludesFile::\n core.askPass::\n \tSome commands (e.g. svn and http interfaces) that interactively\n \task for a password can be told to use an external program given\n-\tvia the value of this variable. Can be overridden by the 'GIT_ASKPASS'\n+\tvia the value of this variable. Can be overridden by the `GIT_ASKPASS`\n \tenvironment variable. If not set, fall back to the value of the\n \t'SSH_ASKPASS' environment variable or, failing that, a simple password\n \tprompt. The external program shall be given a suitable prompt as\n@@ -732,7 +732,7 @@ core.notesRef::\n \tnotes should be printed.\n +\n This setting defaults to \"refs/notes/commits\", and it can be overridden by\n-the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].\n+the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n \n core.sparseCheckout::\n \tEnable \"sparse checkout\" feature. See section \"Sparse checkout\" in\n@@ -768,7 +768,7 @@ it will be treated as a shell command. For example, defining\n \"gitk --all --not ORIG_HEAD\". Note that shell commands will be\n executed from the top-level directory of a repository, which may\n not necessarily be the current directory.\n-'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'\n+`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'\n from the original current directory. See linkgit:git-rev-parse[1].\n \n am.keepcr::\n@@ -1548,7 +1548,7 @@ guitool..cmd::\n \tof the linkgit:git-gui[1] `Tools` menu is invoked. This option is\n \tmandatory for every tool. The command is executed from the root of\n \tthe working directory, and in the environment it receives the name of\n-\tthe tool as 'GIT_GUITOOL', the name of the currently selected file as\n+\tthe tool as `GIT_GUITOOL`, the name of the currently selected file as\n \t'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if\n \tthe head is detached, 'CUR_BRANCH' is empty).\n \n@@ -1633,7 +1633,7 @@ http.proxyAuthMethod::\n \tonly takes effect if the configured proxy string contains a user name part\n \t(i.e. is of the form 'user@host' or 'user@host:port'). This can be\n \toverridden on a per-remote basis; see `remote..proxyAuthMethod`.\n-\tBoth can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment\n+\tBoth can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment\n \tvariable. Possible values are:\n +\n --\n@@ -1691,9 +1691,9 @@ http.sslVersion::\n \t- tlsv1.2\n \n +\n-Can be overridden by the 'GIT_SSL_VERSION' environment variable.\n+Can be overridden by the `GIT_SSL_VERSION` environment variable.\n To force git to use libcurl's default ssl version and ignore any\n-explicit http.sslversion option, set 'GIT_SSL_VERSION' to the\n+explicit http.sslversion option, set `GIT_SSL_VERSION` to the\n empty string.\n \n http.sslCipherList::\n@@ -1704,41 +1704,41 @@ http.sslCipherList::\n option; see the libcurl documentation for more details on the format\n of this list.\n +\n-Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.\n+Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.\n To force git to use libcurl's default cipher list and ignore any\n-explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the\n+explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the\n empty string.\n \n http.sslVerify::\n \tWhether to verify the SSL certificate when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment\n \tvariable.\n \n http.sslCert::\n \tFile containing the SSL certificate when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_CERT` environment\n \tvariable.\n \n http.sslKey::\n \tFile containing the SSL private key when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_KEY` environment\n \tvariable.\n \n http.sslCertPasswordProtected::\n \tEnable Git's password prompt for the SSL certificate. Otherwise\n \tOpenSSL will prompt the user, possibly many times, if the\n \tcertificate or private key is encrypted. Can be overridden by the\n-\t'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.\n+\t`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.\n \n http.sslCAInfo::\n \tFile containing the certificates to verify the peer with when\n \tfetching or pushing over HTTPS. Can be overridden by the\n-\t'GIT_SSL_CAINFO' environment variable.\n+\t`GIT_SSL_CAINFO` environment variable.\n \n http.sslCAPath::\n \tPath containing files with the CA certificates to verify the peer\n \twith when fetching or pushing over HTTPS. Can be overridden\n-\tby the 'GIT_SSL_CAPATH' environment variable.\n+\tby the `GIT_SSL_CAPATH` environment variable.\n \n http.pinnedpubkey::\n \tPublic key of the https service. It may either be the filename of\n@@ -1758,7 +1758,7 @@ http.sslTry::\n \n http.maxRequests::\n \tHow many HTTP requests to launch in parallel. Can be overridden\n-\tby the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.\n+\tby the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.\n \n http.minSessions::\n \tThe number of curl sessions (counted across slots) to be kept across\n@@ -1777,13 +1777,13 @@ http.postBuffer::\n http.lowSpeedLimit, http.lowSpeedTime::\n \tIf the HTTP transfer speed is less than 'http.lowSpeedLimit'\n \tfor longer than 'http.lowSpeedTime' seconds, the transfer is aborted.\n-\tCan be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and\n-\t'GIT_HTTP_LOW_SPEED_TIME' environment variables.\n+\tCan be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and\n+\t`GIT_HTTP_LOW_SPEED_TIME` environment variables.\n \n http.noEPSV::\n \tA boolean which disables using of EPSV ftp command by curl.\n \tThis can helpful with some \"poor\" ftp servers which don't\n-\tsupport EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'\n+\tsupport EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`\n \tenvironment variable. Default is false (curl will use EPSV).\n \n http.userAgent::\n@@ -1793,7 +1793,7 @@ http.userAgent::\n \tsuch as Mozilla/4.0. This may be necessary, for instance, if\n \tconnecting through a firewall that restricts HTTP connections to a set\n \tof common USER_AGENT strings (but not including those like git/1.7.1).\n-\tCan be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.\n+\tCan be overridden by the `GIT_HTTP_USER_AGENT` environment variable.\n \n http..*::\n \tAny of the http.* options above can be applied selectively to some URLs.\n@@ -2866,12 +2866,12 @@ url..pushInsteadOf::\n \n user.email::\n \tYour email address to be recorded in any newly created commits.\n-\tCan be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and\n+\tCan be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and\n \t'EMAIL' environment variables. See linkgit:git-commit-tree[1].\n \n user.name::\n \tYour full name to be recorded in any newly created commits.\n-\tCan be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'\n+\tCan be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`\n \tenvironment variables. See linkgit:git-commit-tree[1].\n \n user.useConfigOnly::\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex 03f9580..e8dc9ca 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -201,7 +201,7 @@ mailmap.*::\n \n notes.displayRef::\n \tWhich refs, in addition to the default set by `core.notesRef`\n-\tor 'GIT_NOTES_REF', to read notes from when showing commit\n+\tor `GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages with the `log` family of commands. See\n \tlinkgit:git-notes[1].\n +\n@@ -210,7 +210,7 @@ multiple times. A warning will be issued for refs that do not exist,\n but a glob that does not match any refs is silently ignored.\n +\n This setting can be disabled by the `--no-notes` option,\n-overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,\n+overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,\n and overridden by the `--notes=` option.\n \n GIT\ndiff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt\nindex 8de3499..9c4b7f5 100644\n--- a/Documentation/git-notes.txt\n+++ b/Documentation/git-notes.txt\n@@ -161,7 +161,7 @@ OPTIONS\n \n --ref ::\n \tManipulate the notes tree in . This overrides\n-\t'GIT_NOTES_REF' and the \"core.notesRef\" configuration. The ref\n+\t`GIT_NOTES_REF` and the \"core.notesRef\" configuration. The ref\n \tspecifies the full refname when it begins with `refs/notes/`; when it\n \tbegins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed\n \tto form a full name of the ref.\n@@ -333,10 +333,10 @@ notes..mergeStrategy::\n notes.displayRef::\n \tWhich ref (or refs, if a glob or specified more than once), in\n \taddition to the default set by `core.notesRef` or\n-\t'GIT_NOTES_REF', to read notes from when showing commit\n+\t`GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages with the 'git log' family of commands.\n \tThis setting can be overridden on the command line or by the\n-\t'GIT_NOTES_DISPLAY_REF' environment variable.\n+\t`GIT_NOTES_DISPLAY_REF` environment variable.\n \tSee linkgit:git-log[1].\n \n notes.rewrite.::\n@@ -345,7 +345,7 @@ notes.rewrite.::\n \tnotes from the original to the rewritten commit. Defaults to\n \t`true`. See also \"`notes.rewriteRef`\" below.\n +\n-This setting can be overridden by the 'GIT_NOTES_REWRITE_REF'\n+This setting can be overridden by the `GIT_NOTES_REWRITE_REF`\n environment variable.\n \n notes.rewriteMode::\n@@ -366,33 +366,33 @@ notes.rewriteRef::\n Does not have a default value; you must configure this variable to\n enable note rewriting.\n +\n-Can be overridden with the 'GIT_NOTES_REWRITE_REF' environment variable.\n+Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.\n \n \n ENVIRONMENT\n -----------\n \n-'GIT_NOTES_REF'::\n+`GIT_NOTES_REF`::\n \tWhich ref to manipulate notes from, instead of `refs/notes/commits`.\n \tThis overrides the `core.notesRef` setting.\n \n-'GIT_NOTES_DISPLAY_REF'::\n+`GIT_NOTES_DISPLAY_REF`::\n \tColon-delimited list of refs or globs indicating which refs,\n \tin addition to the default from `core.notesRef` or\n-\t'GIT_NOTES_REF', to read notes from when showing commit\n+\t`GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages.\n \tThis overrides the `notes.displayRef` setting.\n +\n A warning will be issued for refs that do not exist, but a glob that\n does not match any refs is silently ignored.\n \n-'GIT_NOTES_REWRITE_MODE'::\n+`GIT_NOTES_REWRITE_MODE`::\n \tWhen copying notes during a rewrite, what to do if the target\n \tcommit already has a note.\n \tMust be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.\n \tThis overrides the `core.rewriteMode` setting.\n \n-'GIT_NOTES_REWRITE_REF'::\n+`GIT_NOTES_REWRITE_REF`::\n \tWhen rewriting commits, which notes to copy from the original\n \tto the rewritten commit. Must be a colon-delimited list of\n \trefs or globs.\ndiff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt\nindex 88ba42b..3385409 100644\n--- a/Documentation/git-p4.txt\n+++ b/Documentation/git-p4.txt\n@@ -166,7 +166,7 @@ General options\n All commands except clone accept these options.\n \n --git-dir ::\n-\tSet the 'GIT_DIR' environment variable. See linkgit:git[1].\n+\tSet the `GIT_DIR` environment variable. See linkgit:git[1].\n \n -v::\n --verbose::\ndiff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt\nindex 8fff598..e5c57ae 100644\n--- a/Documentation/git-replace.txt\n+++ b/Documentation/git-replace.txt\n@@ -51,7 +51,7 @@ $ git cat-file commit foo\n \n shows information about commit 'bar'.\n \n-The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to\n+The `GIT_NO_REPLACE_OBJECTS` environment variable can be set to\n achieve the same effect as the `--no-replace-objects` option.\n \n OPTIONS\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 34ff007..8c3d048 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -820,46 +820,46 @@ These environment variables apply to 'all' core Git commands. Nb: it\n is worth noting that they may be used/overridden by SCMS sitting above\n Git so take care if using a foreign front-end.\n \n-'GIT_INDEX_FILE'::\n+`GIT_INDEX_FILE`::\n \tThis environment allows the specification of an alternate\n \tindex file. If not specified, the default of `$GIT_DIR/index`\n \tis used.\n \n-'GIT_INDEX_VERSION'::\n+`GIT_INDEX_VERSION`::\n \tThis environment variable allows the specification of an index\n \tversion for new repositories. It won't affect existing index\n \tfiles. By default index file version 2 or 3 is used. See\n \tlinkgit:git-update-index[1] for more information.\n \n-'GIT_OBJECT_DIRECTORY'::\n+`GIT_OBJECT_DIRECTORY`::\n \tIf the object storage directory is specified via this\n \tenvironment variable then the sha1 directories are created\n \tunderneath - otherwise the default `$GIT_DIR/objects`\n \tdirectory is used.\n \n-'GIT_ALTERNATE_OBJECT_DIRECTORIES'::\n+`GIT_ALTERNATE_OBJECT_DIRECTORIES`::\n \tDue to the immutable nature of Git objects, old objects can be\n \tarchived into shared, read-only directories. This variable\n \tspecifies a \":\" separated (on Windows \";\" separated) list\n \tof Git object directories which can be used to search for Git\n \tobjects. New objects will not be written to these directories.\n \n-'GIT_DIR'::\n-\tIf the 'GIT_DIR' environment variable is set then it\n+`GIT_DIR`::\n+\tIf the `GIT_DIR` environment variable is set then it\n \tspecifies a path to use instead of the default `.git`\n \tfor the base of the repository.\n \tThe '--git-dir' command-line option also sets this value.\n \n-'GIT_WORK_TREE'::\n+`GIT_WORK_TREE`::\n \tSet the path to the root of the working tree.\n \tThis can also be controlled by the '--work-tree' command-line\n \toption and the core.worktree configuration variable.\n \n-'GIT_NAMESPACE'::\n+`GIT_NAMESPACE`::\n \tSet the Git namespace; see linkgit:gitnamespaces[7] for details.\n \tThe '--namespace' command-line option also sets this value.\n \n-'GIT_CEILING_DIRECTORIES'::\n+`GIT_CEILING_DIRECTORIES`::\n \tThis should be a colon-separated list of absolute paths. If\n \tset, it is a list of directories that Git should not chdir up\n \tinto while looking for a repository directory (useful for\n@@ -872,19 +872,19 @@ Git so take care if using a foreign front-end.\n \tcan add an empty entry to the list to tell Git that the\n \tsubsequent entries are not symlinks and needn't be resolved;\n \te.g.,\n-\t'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.\n+\t`GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.\n \n-'GIT_DISCOVERY_ACROSS_FILESYSTEM'::\n+`GIT_DISCOVERY_ACROSS_FILESYSTEM`::\n \tWhen run in a directory that does not have \".git\" repository\n \tdirectory, Git tries to find such a directory in the parent\n \tdirectories to find the top of the working tree, but by default it\n \tdoes not cross filesystem boundaries. This environment variable\n \tcan be set to true to tell Git not to stop at filesystem\n-\tboundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect\n-\tan explicit repository directory set via 'GIT_DIR' or on the\n+\tboundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect\n+\tan explicit repository directory set via `GIT_DIR` or on the\n \tcommand line.\n \n-'GIT_COMMON_DIR'::\n+`GIT_COMMON_DIR`::\n \tIf this variable is set to a path, non-worktree files that are\n \tnormally in $GIT_DIR will be taken from this path\n \tinstead. Worktree-specific files such as HEAD or index are\n@@ -895,28 +895,28 @@ Git so take care if using a foreign front-end.\n \n Git Commits\n ~~~~~~~~~~~\n-'GIT_AUTHOR_NAME'::\n-'GIT_AUTHOR_EMAIL'::\n-'GIT_AUTHOR_DATE'::\n-'GIT_COMMITTER_NAME'::\n-'GIT_COMMITTER_EMAIL'::\n-'GIT_COMMITTER_DATE'::\n+`GIT_AUTHOR_NAME`::\n+`GIT_AUTHOR_EMAIL`::\n+`GIT_AUTHOR_DATE`::\n+`GIT_COMMITTER_NAME`::\n+`GIT_COMMITTER_EMAIL`::\n+`GIT_COMMITTER_DATE`::\n 'EMAIL'::\n \tsee linkgit:git-commit-tree[1]\n \n Git Diffs\n ~~~~~~~~~\n-'GIT_DIFF_OPTS'::\n+`GIT_DIFF_OPTS`::\n \tOnly valid setting is \"--unified=??\" or \"-u??\" to set the\n \tnumber of context lines shown when a unified diff is created.\n \tThis takes precedence over any \"-U\" or \"--unified\" option\n \tvalue passed on the Git diff command line.\n \n-'GIT_EXTERNAL_DIFF'::\n-\tWhen the environment variable 'GIT_EXTERNAL_DIFF' is set, the\n+`GIT_EXTERNAL_DIFF`::\n+\tWhen the environment variable `GIT_EXTERNAL_DIFF` is set, the\n \tprogram named by it is called, instead of the diff invocation\n \tdescribed above. For a path that is added, removed, or modified,\n- 'GIT_EXTERNAL_DIFF' is called with 7 parameters:\n+ `GIT_EXTERNAL_DIFF` is called with 7 parameters:\n \n \tpath old-file old-hex old-mode new-file new-hex new-mode\n +\n@@ -930,42 +930,42 @@ where:\n The file parameters can point at the user's working file\n (e.g. `new-file` in \"git-diff-files\"), `/dev/null` (e.g. `old-file`\n when a new file is added), or a temporary file (e.g. `old-file` in the\n-index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the\n-temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.\n+index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the\n+temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.\n +\n-For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1\n+For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1\n parameter, .\n +\n-For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,\n-'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.\n+For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,\n+`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.\n \n-'GIT_DIFF_PATH_COUNTER'::\n+`GIT_DIFF_PATH_COUNTER`::\n \tA 1-based counter incremented by one for every path.\n \n-'GIT_DIFF_PATH_TOTAL'::\n+`GIT_DIFF_PATH_TOTAL`::\n \tThe total number of paths.\n \n other\n ~~~~~\n-'GIT_MERGE_VERBOSITY'::\n+`GIT_MERGE_VERBOSITY`::\n \tA number controlling the amount of output shown by\n \tthe recursive merge strategy. Overrides merge.verbosity.\n \tSee linkgit:git-merge[1]\n \n-'GIT_PAGER'::\n+`GIT_PAGER`::\n \tThis environment variable overrides `$PAGER`. If it is set\n \tto an empty string or to the value \"cat\", Git will not launch\n \ta pager. See also the `core.pager` option in\n \tlinkgit:git-config[1].\n \n-'GIT_EDITOR'::\n+`GIT_EDITOR`::\n \tThis environment variable overrides `$EDITOR` and `$VISUAL`.\n \tIt is used by several Git commands when, on interactive mode,\n \tan editor is to be launched. See also linkgit:git-var[1]\n \tand the `core.editor` option in linkgit:git-config[1].\n \n-'GIT_SSH'::\n-'GIT_SSH_COMMAND'::\n+`GIT_SSH`::\n+`GIT_SSH_COMMAND`::\n \tIf either of these environment variables is set then 'git fetch'\n \tand 'git push' will use the specified command instead of 'ssh'\n \twhen they need to connect to a remote system.\n@@ -985,18 +985,18 @@ Usually it is easier to configure any desired options through your\n personal `.ssh/config` file. Please consult your ssh documentation\n for further details.\n \n-'GIT_ASKPASS'::\n+`GIT_ASKPASS`::\n \tIf this environment variable is set, then Git commands which need to\n \tacquire passwords or passphrases (e.g. for HTTP or IMAP authentication)\n \twill call this program with a suitable prompt as command-line argument\n \tand read the password from its STDOUT. See also the 'core.askPass'\n \toption in linkgit:git-config[1].\n \n-'GIT_TERMINAL_PROMPT'::\n+`GIT_TERMINAL_PROMPT`::\n \tIf this environment variable is set to `0`, git will not prompt\n \ton the terminal (e.g., when asking for HTTP authentication).\n \n-'GIT_CONFIG_NOSYSTEM'::\n+`GIT_CONFIG_NOSYSTEM`::\n \tWhether to skip reading settings from the system-wide\n \t`$(prefix)/etc/gitconfig` file. This environment variable can\n \tbe used along with `$HOME` and `$XDG_CONFIG_HOME` to create a\n@@ -1004,7 +1004,7 @@ for further details.\n \ttemporarily to avoid using a buggy `/etc/gitconfig` file while\n \twaiting for someone with sufficient permissions to fix it.\n \n-'GIT_FLUSH'::\n+`GIT_FLUSH`::\n \tIf this environment variable is set to \"1\", then commands such\n \tas 'git blame' (in incremental mode), 'git rev-list', 'git log',\n \t'git check-attr' and 'git check-ignore' will\n@@ -1015,7 +1015,7 @@ for further details.\n \tnot set, Git will choose buffered or record-oriented flushing\n \tbased on whether stdout appears to be redirected to a file or not.\n \n-'GIT_TRACE'::\n+`GIT_TRACE`::\n \tEnables general trace messages, e.g. alias expansion, built-in\n \tcommand execution and external command execution.\n +\n@@ -1036,21 +1036,21 @@ into it.\n Unsetting the variable, or setting it to empty, \"0\" or\n \"false\" (case insensitive) disables trace messages.\n \n-'GIT_TRACE_PACK_ACCESS'::\n+`GIT_TRACE_PACK_ACCESS`::\n \tEnables trace messages for all accesses to any packs. For each\n \taccess, the pack file name and an offset in the pack is\n \trecorded. This may be helpful for troubleshooting some\n \tpack-related performance problems.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_PACKET'::\n+`GIT_TRACE_PACKET`::\n \tEnables trace messages for all packets coming in or out of a\n \tgiven program. This can help with debugging object negotiation\n \tor other protocol issues. Tracing is turned off at a packet\n-\tstarting with \"PACK\" (but see 'GIT_TRACE_PACKFILE' below).\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tstarting with \"PACK\" (but see `GIT_TRACE_PACKFILE` below).\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_PACKFILE'::\n+`GIT_TRACE_PACKFILE`::\n \tEnables tracing of packfiles sent or received by a\n \tgiven program. Unlike other trace output, this trace is\n \tverbatim: no headers, and no quoting of binary data. You almost\n@@ -1061,22 +1061,22 @@ Unsetting the variable, or setting it to empty, \"0\" or\n Note that this is currently only implemented for the client side\n of clones and fetches.\n \n-'GIT_TRACE_PERFORMANCE'::\n+`GIT_TRACE_PERFORMANCE`::\n \tEnables performance related trace messages, e.g. total execution\n \ttime of each Git command.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_SETUP'::\n+`GIT_TRACE_SETUP`::\n \tEnables trace messages printing the .git, working tree and current\n \tworking directory after Git has completed its setup phase.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_SHALLOW'::\n+`GIT_TRACE_SHALLOW`::\n \tEnables trace messages that can help debugging fetching /\n \tcloning of shallow repositories.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_LITERAL_PATHSPECS'::\n+`GIT_LITERAL_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs literally, rather than as glob patterns. For example,\n \trunning `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search\n@@ -1085,19 +1085,19 @@ of clones and fetches.\n \tliteral paths to Git (e.g., paths previously given to you by\n \t`git ls-tree`, `--raw` diff output, etc).\n \n-'GIT_GLOB_PATHSPECS'::\n+`GIT_GLOB_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as glob patterns (aka \"glob\" magic).\n \n-'GIT_NOGLOB_PATHSPECS'::\n+`GIT_NOGLOB_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as literal (aka \"literal\" magic).\n \n-'GIT_ICASE_PATHSPECS'::\n+`GIT_ICASE_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as case-insensitive.\n \n-'GIT_REFLOG_ACTION'::\n+`GIT_REFLOG_ACTION`::\n \tWhen a ref is updated, reflog entries are created to keep\n \ttrack of the reason why the ref was updated (which is\n \ttypically the name of the high-level command that updated\n@@ -1107,7 +1107,7 @@ of clones and fetches.\n \tvariable when it is invoked as the top level command by the\n \tend user, to be recorded in the body of the reflog.\n \n-'GIT_REF_PARANOIA'::\n+`GIT_REF_PARANOIA`::\n \tIf set to `1`, include broken or badly named refs when iterating\n \tover lists of refs. In a normal, non-corrupted repository, this\n \tdoes nothing. However, enabling it may help git to detect and\n@@ -1118,7 +1118,7 @@ of clones and fetches.\n \tan operation has touched every ref (e.g., because you are\n \tcloning a repository to make a backup).\n \n-'GIT_ALLOW_PROTOCOL'::\n+`GIT_ALLOW_PROTOCOL`::\n \tIf set, provide a colon-separated list of protocols which are\n \tallowed to be used with fetch/push/clone. This is useful to\n \trestrict recursive submodule initialization from an untrusted\ndiff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\nindex 78e0b27..e279327 100644\n--- a/Documentation/gitremote-helpers.txt\n+++ b/Documentation/gitremote-helpers.txt\n@@ -43,7 +43,7 @@ arguments. The first argument specifies a remote repository as in Git;\n it is either the name of a configured remote or a URL. The second\n argument specifies a URL; it is usually of the form\n '://
', but any arbitrary string is possible.\n-The 'GIT_DIR' environment variable is set up for the remote helper\n+The `GIT_DIR` environment variable is set up for the remote helper\n and can be used to determine where to store additional data or from\n which directory to invoke auxiliary Git commands.\n \ndiff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt\nindex cd9c895..96156e5 100644\n--- a/Documentation/gitweb.txt\n+++ b/Documentation/gitweb.txt\n@@ -206,8 +206,8 @@ $export_auth_hook = sub {\n Per-repository gitweb configuration\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n You can configure individual repositories shown in gitweb by creating file\n-in the 'GIT_DIR' of Git repository, or by setting some repo configuration\n-variable (in 'GIT_DIR/config', see linkgit:git-config[1]).\n+in the `GIT_DIR` of Git repository, or by setting some repo configuration\n+variable (in `GIT_DIR/config`, see linkgit:git-config[1]).\n \n You can use the following files in repository:\n \ndiff --git a/Documentation/merge-config.txt b/Documentation/merge-config.txt\nindex 002ca58..df3ea37 100644\n--- a/Documentation/merge-config.txt\n+++ b/Documentation/merge-config.txt\n@@ -61,7 +61,7 @@ merge.verbosity::\n \tmessage if conflicts were detected. Level 1 outputs only\n \tconflicts, 2 outputs conflicts and file changes. Level 5 and\n \tabove outputs debugging information. The default is level 2.\n-\tCan be overridden by the 'GIT_MERGE_VERBOSITY' environment variable.\n+\tCan be overridden by the `GIT_MERGE_VERBOSITY` environment variable.\n \n merge..name::\n \tDefines a human-readable name for a custom low-level\n-- \n2.8.2\n"},{"id":"286907","messageId":"20160518181500.GD5796@sigill.intra.peff.net","threadId":"42370","inReplyTo":"1463587109-22476-1-git-send-email-tom.russello@grenoble-inp.org","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-05-18T18:15:00Z","receivedAt":"2016-05-18T18:15:00Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, May 18, 2016 at 05:58:29PM +0200, Tom Russello wrote:\n\n> There is no agreement on this topic (the CodingGuidelines does not\n> mention it), it would be better if everyone follows the same rule: put\n> each environment variable in monospace style and write this rule in\n> the guide.\n> \n> It is a good thing to have a consistent documentation however it\n> will be painful to change with a simple regex all occurences\n> (especially environment variables without any format) because some of\n> them are in paths or code section.\n> \n> What do you think ?\n\nPersonally, I like the \"literal\" backticks versus the \"emphasis\"\nsingle-quotes. But you should keep in mind how they are rendered in the\nmanpages, which is as \"nothing\" and \"underline\", respectively (by\ndefault, anyway). So I think some people are negative on using backticks\nfor that reason.\n\nI also turn on the MAN_BOLD_LITERAL knob, which turns that \"nothing\"\ninto \"bold\", and the result looks quite nice. But there is some\ncompatibility question of whether that can be used everywhere.\n\nHere's the most recent discussion I could find:\n\n http://thread.gmane.org/gmane.comp.version-control.git/281170\n\nwhich talks about the issue and references an earlier discussion (which\nI didn't re-read). But you probably need to address the concerns there\nbefore moving forward with a patch like this.\n\n-Peff\n"},{"id":"287256","messageId":"b06231ac-b100-2565-3bf7-99f268014788@ensimag.grenoble-inp.fr","threadId":"42370","inReplyTo":"20160518181500.GD5796@sigill.intra.peff.net","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Samuel GROOT","fromEmail":"samuel.groot@ensimag.grenoble-inp.fr","sentAt":"2016-05-23T16:00:26Z","receivedAt":"2016-05-23T16:00:26Z","isPatch":true,"sender":{"key":"samuel.groot@ensimag.grenoble-inp.fr","avatar":null},"body":"Some people have suggested to standardize documentation's formatting to \nmake it more consistent.\n\n[1] 2015-04-29 20:13:53 GMT, Junio C Hamano wrote:\n> Interesting. What I happen to use when populating the git-manpages\n> repository would have wider impact to the users, as I hear that some\n> (or many) distros just package whatever I have there. I do not mind\n> enabling it on my end if that gives us more readable rendition.\n\n[2] On 2015-04-29 20:32:47, Jeff King wrote:\n> I think it's probably fine and a positive change, but one never knows. I\n> guess distros don't package what you ship until you actually tag a\n> release, so it would be OK to start doing so during a cycle to shake out\n> any problems (and in fact preferable, as anybody who follows \"master\"\n> using \"make install-man-quick\" would get it early and be able to make a\n> report).\n>\n> If we are doing that, it would make sense to flip MAN_BOLD_LITERAL on by\n> default during that same cycle, so we could get reports from people who\n> build the manpages from source.\n\n[3] On 2015-11-13 05:45:05, Jeff King wrote:\n> If we want to move to backticks, we probably want to also turn on\n> MAN_BOLD_LITERAL by default, or it's a step backwards for some folks.\n\nThe question is about flipping MAN_BOLD_LITERAL by default or not.\n\nSince 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by \ndefault for this cycle to shake out problems as Jeff King suggested [2].\n\n\nAnother option could be testing if the system does support bold literal \nand flipping it on or off accordingly, but I don't know exactly where \nthat could be done.\n"},{"id":"287262","messageId":"vpq8tz0hd2g.fsf@anie.imag.fr","threadId":"42370","inReplyTo":"b06231ac-b100-2565-3bf7-99f268014788@ensimag.grenoble-inp.fr","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@grenoble-inp.fr","sentAt":"2016-05-23T17:57:43Z","receivedAt":"2016-05-23T17:57:43Z","isPatch":true,"sender":{"key":"matthieu.moy@grenoble-inp.fr","avatar":"https://gravatar.com/avatar/72c8a2705971a25dfaff23cece15130d405685845d911aedd5667ace277f3fc5?d=mp&s=160"},"body":"Samuel GROOT writes:\n\n> Since 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by\n> default for this cycle to shake out problems as Jeff King suggested\n> [2].\n\n2.8.3 was a bufix release, and flipping a controversial flag should\nclearly not be done on a bugfix release. So, in this context, \"beginning\nof a cycle\" means after a x.y.0 release.\n\nAnyway, a patch enabling MAN_BOLD_LITERAL by default would need to cook\nin pu and next as any other patches, so the time when the patch is sent\ndoes not really matter.\n\n-- \nMatthieu Moy\nhttp://www-verimag.imag.fr/~moy/\n"},{"id":"287550","messageId":"20160526043607.GB6756@sigill.intra.peff.net","threadId":"42370","inReplyTo":"vpq8tz0hd2g.fsf@anie.imag.fr","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-05-26T04:36:07Z","receivedAt":"2016-05-26T04:36:07Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Mon, May 23, 2016 at 07:57:43PM +0200, Matthieu Moy wrote:\n\n> Samuel GROOT writes:\n> \n> > Since 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by\n> > default for this cycle to shake out problems as Jeff King suggested\n> > [2].\n> \n> 2.8.3 was a bufix release, and flipping a controversial flag should\n> clearly not be done on a bugfix release. So, in this context, \"beginning\n> of a cycle\" means after a x.y.0 release.\n> \n> Anyway, a patch enabling MAN_BOLD_LITERAL by default would need to cook\n> in pu and next as any other patches, so the time when the patch is sent\n> does not really matter.\n\nYeah, I think a reasonable plan is:\n\n 1. Somebody produces a patch flipping the default. The patch is\n trivial, but the commit message should tell why, and try to dig up\n any possible problems we might see (e.g., why wasn't this the\n default? Particular versions of tools? Some platforms?)\n\n 2. Assuming no problems, Junio merges the patch to \"next\". We get\n any reports of issues from people using \"next\" day-to-day.\n\n 3. Assuming no problems, Junio merges to \"master\". We hit more people\n (who build from master). And also it would be part of the\n pre-generated pages that Junio ships, so we might get reports\n there.\n\n 4. Eventually it's released. We hope to get no problem reports there,\n though it _does_ hit a wider audience at that point.\n\nSteps 1 and 2 can happen now. As we are in the -rc cycle right now,\nprobably step 3 would happen post-v2.9. But there's no reason not to\nstart the clock ticking now.\n\n-Peff\n"},{"id":"287582","messageId":"xmqqmvncyera.fsf@gitster.mtv.corp.google.com","threadId":"42370","inReplyTo":"20160526043607.GB6756@sigill.intra.peff.net","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-05-26T16:18:17Z","receivedAt":"2016-05-26T16:18:17Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jeff King writes:\n\n> On Mon, May 23, 2016 at 07:57:43PM +0200, Matthieu Moy wrote:\n>\n>> Samuel GROOT writes:\n>> \n>> > Since 2.8.3 was out recently, we could flip MAN_BOLD_LITERAL on by\n>> > default for this cycle to shake out problems as Jeff King suggested\n>> > [2].\n>> \n>> 2.8.3 was a bufix release, and flipping a controversial flag should\n>> clearly not be done on a bugfix release. So, in this context, \"beginning\n>> of a cycle\" means after a x.y.0 release.\n>> \n>> Anyway, a patch enabling MAN_BOLD_LITERAL by default would need to cook\n>> in pu and next as any other patches, so the time when the patch is sent\n>> does not really matter.\n>\n> Yeah, I think a reasonable plan is:\n>\n> 1. Somebody produces a patch flipping the default. The patch is\n> trivial, but the commit message should tell why, and try to dig up\n> any possible problems we might see (e.g., why wasn't this the\n> default? Particular versions of tools? Some platforms?)\n\n\"git log -SBOLD_LITERAL Documentation/\" tells me that it's not like\nwe had this on by default sometime in the past and then we flipped\nthe default back in response to some problems (which I forgot\nabout).\n\nI just re-read the two iterations that introduced BOLD_LITERAL:\n\n * http://news.gmane.org/find-root.php?message_id=<1237881866-5497-1-git-send-email-chris_johnsen@pobox.com>\n\n * http://news.gmane.org/find-root.php?message_id=<1238136245-22853-1-git-send-email-chris_johnsen@pobox.com>\n\nThere was no particular \"caveat\" raised there to recommend against\nusing this on particular versions of tools or platforms. It was\ninertia that has kept the new optional feature \"optional\".\n\n> 2. Assuming no problems, Junio merges the patch to \"next\". We get\n> any reports of issues from people using \"next\" day-to-day.\n\nSo I can do these steps myself up to this point. After waiting for\na few days to see if somebody else with better memory tells me what\nI forgot, perhaps.\n\n> 3. Assuming no problems, Junio merges to \"master\". We hit more people\n> (who build from master). And also it would be part of the\n> pre-generated pages that Junio ships, so we might get reports\n> there.\n>\n> 4. Eventually it's released. We hope to get no problem reports there,\n> though it _does_ hit a wider audience at that point.\n>\n> Steps 1 and 2 can happen now. As we are in the -rc cycle right now,\n> probably step 3 would happen post-v2.9. But there's no reason not to\n> start the clock ticking now.\n>\n> -Peff\n"},{"id":"287583","messageId":"20160526162348.GA18210@sigill.intra.peff.net","threadId":"42370","inReplyTo":"xmqqmvncyera.fsf@gitster.mtv.corp.google.com","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-05-26T16:23:48Z","receivedAt":"2016-05-26T16:23:48Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, May 26, 2016 at 09:18:17AM -0700, Junio C Hamano wrote:\n\n> > 1. Somebody produces a patch flipping the default. The patch is\n> > trivial, but the commit message should tell why, and try to dig up\n> > any possible problems we might see (e.g., why wasn't this the\n> > default? Particular versions of tools? Some platforms?)\n> [...]\n> There was no particular \"caveat\" raised there to recommend against\n> using this on particular versions of tools or platforms. It was\n> inertia that has kept the new optional feature \"optional\".\n\nThanks for digging. That matches my recollection and the limited\nresearch I did more recently.\n\n> > 2. Assuming no problems, Junio merges the patch to \"next\". We get\n> > any reports of issues from people using \"next\" day-to-day.\n> \n> So I can do these steps myself up to this point. After waiting for\n> a few days to see if somebody else with better memory tells me what\n> I forgot, perhaps.\n\nOK. I was trying to see if (1) could be low-hanging fruit for any of the\nnewcomers, but at this point it probably makes sense for you to just\nwrite the patch.\n\n-Peff\n"},{"id":"287586","messageId":"xmqqbn3sydvk.fsf@gitster.mtv.corp.google.com","threadId":"42370","inReplyTo":"20160526162348.GA18210@sigill.intra.peff.net","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-05-26T16:37:19Z","receivedAt":"2016-05-26T16:37:19Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jeff King writes:\n\n> On Thu, May 26, 2016 at 09:18:17AM -0700, Junio C Hamano wrote:\n>\n>> > 1. Somebody produces a patch flipping the default. The patch is\n>> > trivial, but the commit message should tell why, and try to dig up\n>> > any possible problems we might see (e.g., why wasn't this the\n>> > default? Particular versions of tools? Some platforms?)\n>> [...]\n>> There was no particular \"caveat\" raised there to recommend against\n>> using this on particular versions of tools or platforms. It was\n>> inertia that has kept the new optional feature \"optional\".\n>\n> Thanks for digging. That matches my recollection and the limited\n> research I did more recently.\n\nFor completeness's sake I should point out that the discussion on\nthe first thread did point out some version-dependent issues. But\nwith 79c461d5 (docs: default to more modern toolset, 2010-11-19), we\ndeclared the problematic versions obsolete; I suspect that it is\nsafe to assume that those who would be hurt by flipping the default\nwould already be extinct after 6 years since then.\n\n>> > 2. Assuming no problems, Junio merges the patch to \"next\". We get\n>> > any reports of issues from people using \"next\" day-to-day.\n>> \n>> So I can do these steps myself up to this point. After waiting for\n>> a few days to see if somebody else with better memory tells me what\n>> I forgot, perhaps.\n>\n> OK. I was trying to see if (1) could be low-hanging fruit for any of the\n> newcomers, but at this point it probably makes sense for you to just\n> write the patch.\n\nLeaving it as low-hanging fruit is actually a good idea.\n\nI was thinking about flipping it in Meta/dodoc.sh, which would\nupdate the git-manpages.git repository whose mirrors are found at\n\n git://git.kernel.org/pub/scm/git/git-manpages.git/\n git://repo.or.cz/git-manpages.git/\n git://github.com/gitster/git-manpages.git/\n"},{"id":"287587","messageId":"20160526163910.GA18597@sigill.intra.peff.net","threadId":"42370","inReplyTo":"xmqqbn3sydvk.fsf@gitster.mtv.corp.google.com","subject":"Re: [RFC/PATCH] Formatting variables in the documentation","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2016-05-26T16:39:10Z","receivedAt":"2016-05-26T16:39:10Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, May 26, 2016 at 09:37:19AM -0700, Junio C Hamano wrote:\n\n> >> There was no particular \"caveat\" raised there to recommend against\n> >> using this on particular versions of tools or platforms. It was\n> >> inertia that has kept the new optional feature \"optional\".\n> >\n> > Thanks for digging. That matches my recollection and the limited\n> > research I did more recently.\n> \n> For completeness's sake I should point out that the discussion on\n> the first thread did point out some version-dependent issues. But\n> with 79c461d5 (docs: default to more modern toolset, 2010-11-19), we\n> declared the problematic versions obsolete; I suspect that it is\n> safe to assume that those who would be hurt by flipping the default\n> would already be extinct after 6 years since then.\n\nYeah, I'd agree, though that may be worth mentioning in the commit\nmessage.\n\n> > OK. I was trying to see if (1) could be low-hanging fruit for any of the\n> > newcomers, but at this point it probably makes sense for you to just\n> > write the patch.\n> \n> Leaving it as low-hanging fruit is actually a good idea.\n> \n> I was thinking about flipping it in Meta/dodoc.sh, which would\n> update the git-manpages.git repository whose mirrors are found at\n\nAh, right. I was thinking that the patch would go to \"master\" first, but\nthere is no reason it could not be flipped independently for your build\nprocess.\n\n-Peff\n"},{"id":"287915","messageId":"20160531162033.7137-1-erwan.mathoniere@grenoble-inp.org","threadId":"42370","inReplyTo":"xmqqbn3sydvk.fsf@gitster.mtv.corp.google.com","subject":"[PATCH] Documentation: bold literals in man","fromName":"Erwan Mathoniere","fromEmail":"erwan.mathoniere@grenoble-inp.org","sentAt":"2016-05-31T16:20:33Z","receivedAt":"2016-05-31T16:20:33Z","isPatch":true,"sender":{"key":"erwan.mathoniere@grenoble-inp.org","avatar":"https://avatars.githubusercontent.com/u/12645778?v=4"},"body":"Backticks are emphasized through monospaced styling in the HTML\nversion of Git documentation. But were left unstyled in the man version.\n\nTo make the man version reading more comfortable, `MAN_BOLD_LITERAL`\nwas added by:\n5121a6d (Documentation: option to render literal text as bold for\nmanpages, 2009-03-27)\nIt allowed the user to build the documentation manpages with literals\nin bold style.\n\nFor precaution it was not set by default.\nSince 79c461d (docs: default to more modern toolset, 2010-11-19),\nit is assumed ASCIIDOC 8 and at least docbook-xsl 1.73 are used,\nso no compatibility issue may occur.\n\nRemove `MAN_BOLD_LITERAL`. Set by default literals as bold.\nImplement `NO_MAN_BOLD_LITERAL`, a new Makefile option, disabling\nthis feature when defined.\n\nSigned-off-by: Erwan MATHONIERE \nSigned-off-by: Samuel GROOT \nSigned-off-by: Tom RUSSELLO \nSigned-off-by: Matthieu MOY \n---\n Documentation/Makefile | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/Makefile b/Documentation/Makefile\nindex f6e288b..35c1385 100644\n--- a/Documentation/Makefile\n+++ b/Documentation/Makefile\n@@ -146,7 +146,7 @@ else\n \tASCIIDOC_EXTRA += -a git-asciidoc-no-roff\n \tendif\n endif\n-ifdef MAN_BOLD_LITERAL\n+ifndef NO_MAN_BOLD_LITERAL\n XMLTO_EXTRA += -m manpage-bold-literal.xsl\n endif\n ifdef DOCBOOK_SUPPRESS_SP\n-- \n2.8.2.662.gc18eb58\n"},{"id":"288339","messageId":"20160603220837.9842-1-tom.russello@grenoble-inp.org","threadId":"42370","inReplyTo":"1463587109-22476-1-git-send-email-tom.russello@grenoble-inp.org","subject":"[PATCH v2] Documentation more consistent","fromName":"Tom Russello","fromEmail":"tom.russello@grenoble-inp.org","sentAt":"2016-06-03T22:08:34Z","receivedAt":"2016-06-03T22:08:34Z","isPatch":true,"sender":{"key":"tom.russello@grenoble-inp.org","avatar":null},"body":"Hello,\nas `MAN_BOLD_LITERAL` knob is now turned on by default, it is the right time to\nmake our documentation more consistent.\n"},{"id":"288338","messageId":"20160603220837.9842-2-tom.russello@grenoble-inp.org","threadId":"42370","inReplyTo":"20160603220837.9842-1-tom.russello@grenoble-inp.org","subject":"[PATCH v2 1/3] Clearer rule about formatting literals","fromName":"Tom Russello","fromEmail":"tom.russello@grenoble-inp.org","sentAt":"2016-06-03T22:08:35Z","receivedAt":"2016-06-03T22:08:35Z","isPatch":true,"sender":{"key":"tom.russello@grenoble-inp.org","avatar":null},"body":"Make the guideline text that we want for our documentation clearer.\n\nSigned-off-by: Tom Russello \nSigned-off-by: Erwan Mathoniere \nSigned-off-by: Samuel Groot \nSigned-off-by: Matthieu Moy \n---\nIMHO, the previous \"rule\" was not so clear on what we have to do and didn't give\na guideline to whether an environment variable has to be wrapped with backticks,\nsingle-quotes or something else.\n\n Documentation/CodingGuidelines | 7 ++++---\n 1 file changed, 4 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 0ddd368..c6f8188 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -526,12 +526,13 @@ Writing Documentation:\n modifying paragraphs or option/command explanations that contain options\n or commands:\n \n- Literal examples (e.g. use of command-line options, command names, and\n- configuration variables) are typeset in monospace, and if you can use\n- `backticks around word phrases`, do so.\n+ Literal examples (e.g. use of command-line options, command names,\n+ configuration and environment variables) must be typeset in monospace (i.e.\n+ wrapped with backticks):\n `--pretty=oneline`\n `git rev-list`\n `remote.pushDefault`\n+ `GIT_DIR`\n \n Word phrases enclosed in `backtick characters` are rendered literally\n and will not be further expanded. The use of `backticks` to achieve the\n-- \n2.8.3\n"},{"id":"288336","messageId":"20160603220837.9842-3-tom.russello@grenoble-inp.org","threadId":"42370","inReplyTo":"20160603220837.9842-1-tom.russello@grenoble-inp.org","subject":"[PATCH v2 2/3] Change environment variables format","fromName":"Tom Russello","fromEmail":"tom.russello@grenoble-inp.org","sentAt":"2016-06-03T22:08:36Z","receivedAt":"2016-06-03T22:08:36Z","isPatch":true,"sender":{"key":"tom.russello@grenoble-inp.org","avatar":null},"body":"As a first step, this change GIT_* variables that where in\nitalic style to monospace font according to the guideline. It was obtained\nwith\n\n\tperl -pi -e \"s/\\'(GIT_.*?)\\'/\\`\\1\\`/g\" *.txt\n\nSigned-off-by: Tom Russello \nSigned-off-by: Erwan Mathoniere \nSigned-off-by: Samuel Groot \nSigned-off-by: Matthieu Moy \n---\nCurrently, in Documentation/git-config.txt GIT_CONFIG (l.138) has no\nparticular style whereas in Documentation/config.txt GIT_PROXY_COMMAND\nhas italic style ('GIT_PROXY_COMMAND' - l.437) and GIT_EDITOR is\nmonospaced (`GIT_EDITOR` - l.657).\n\n Documentation/config.txt | 46 +++++++-------\n Documentation/git-log.txt | 4 +-\n Documentation/git-notes.txt | 20 +++---\n Documentation/git-p4.txt | 2 +-\n Documentation/git-replace.txt | 2 +-\n Documentation/git.txt | 120 ++++++++++++++++++------------------\n Documentation/gitremote-helpers.txt | 2 +-\n Documentation/gitweb.txt | 4 +-\n Documentation/merge-config.txt | 2 +-\n 9 files changed, 101 insertions(+), 101 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 2e1b2e4..3897906 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -434,7 +434,7 @@ core.gitProxy::\n \tmay be set multiple times and is matched in the given order;\n \tthe first match wins.\n +\n-Can be overridden by the 'GIT_PROXY_COMMAND' environment variable\n+Can be overridden by the `GIT_PROXY_COMMAND` environment variable\n (which always applies universally, without the special \"for\"\n handling).\n +\n@@ -619,7 +619,7 @@ core.excludesFile::\n core.askPass::\n \tSome commands (e.g. svn and http interfaces) that interactively\n \task for a password can be told to use an external program given\n-\tvia the value of this variable. Can be overridden by the 'GIT_ASKPASS'\n+\tvia the value of this variable. Can be overridden by the `GIT_ASKPASS`\n \tenvironment variable. If not set, fall back to the value of the\n \t'SSH_ASKPASS' environment variable or, failing that, a simple password\n \tprompt. The external program shall be given a suitable prompt as\n@@ -764,7 +764,7 @@ core.notesRef::\n \tnotes should be printed.\n +\n This setting defaults to \"refs/notes/commits\", and it can be overridden by\n-the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].\n+the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].\n \n core.sparseCheckout::\n \tEnable \"sparse checkout\" feature. See section \"Sparse checkout\" in\n@@ -800,7 +800,7 @@ it will be treated as a shell command. For example, defining\n \"gitk --all --not ORIG_HEAD\". Note that shell commands will be\n executed from the top-level directory of a repository, which may\n not necessarily be the current directory.\n-'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'\n+`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'\n from the original current directory. See linkgit:git-rev-parse[1].\n \n am.keepcr::\n@@ -1587,7 +1587,7 @@ guitool..cmd::\n \tof the linkgit:git-gui[1] `Tools` menu is invoked. This option is\n \tmandatory for every tool. The command is executed from the root of\n \tthe working directory, and in the environment it receives the name of\n-\tthe tool as 'GIT_GUITOOL', the name of the currently selected file as\n+\tthe tool as `GIT_GUITOOL`, the name of the currently selected file as\n \t'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if\n \tthe head is detached, 'CUR_BRANCH' is empty).\n \n@@ -1672,7 +1672,7 @@ http.proxyAuthMethod::\n \tonly takes effect if the configured proxy string contains a user name part\n \t(i.e. is of the form 'user@host' or 'user@host:port'). This can be\n \toverridden on a per-remote basis; see `remote..proxyAuthMethod`.\n-\tBoth can be overridden by the 'GIT_HTTP_PROXY_AUTHMETHOD' environment\n+\tBoth can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment\n \tvariable. Possible values are:\n +\n --\n@@ -1731,9 +1731,9 @@ http.sslVersion::\n \t- tlsv1.2\n \n +\n-Can be overridden by the 'GIT_SSL_VERSION' environment variable.\n+Can be overridden by the `GIT_SSL_VERSION` environment variable.\n To force git to use libcurl's default ssl version and ignore any\n-explicit http.sslversion option, set 'GIT_SSL_VERSION' to the\n+explicit http.sslversion option, set `GIT_SSL_VERSION` to the\n empty string.\n \n http.sslCipherList::\n@@ -1744,41 +1744,41 @@ http.sslCipherList::\n option; see the libcurl documentation for more details on the format\n of this list.\n +\n-Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.\n+Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.\n To force git to use libcurl's default cipher list and ignore any\n-explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the\n+explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the\n empty string.\n \n http.sslVerify::\n \tWhether to verify the SSL certificate when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment\n \tvariable.\n \n http.sslCert::\n \tFile containing the SSL certificate when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_CERT` environment\n \tvariable.\n \n http.sslKey::\n \tFile containing the SSL private key when fetching or pushing\n-\tover HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment\n+\tover HTTPS. Can be overridden by the `GIT_SSL_KEY` environment\n \tvariable.\n \n http.sslCertPasswordProtected::\n \tEnable Git's password prompt for the SSL certificate. Otherwise\n \tOpenSSL will prompt the user, possibly many times, if the\n \tcertificate or private key is encrypted. Can be overridden by the\n-\t'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.\n+\t`GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.\n \n http.sslCAInfo::\n \tFile containing the certificates to verify the peer with when\n \tfetching or pushing over HTTPS. Can be overridden by the\n-\t'GIT_SSL_CAINFO' environment variable.\n+\t`GIT_SSL_CAINFO` environment variable.\n \n http.sslCAPath::\n \tPath containing files with the CA certificates to verify the peer\n \twith when fetching or pushing over HTTPS. Can be overridden\n-\tby the 'GIT_SSL_CAPATH' environment variable.\n+\tby the `GIT_SSL_CAPATH` environment variable.\n \n http.pinnedpubkey::\n \tPublic key of the https service. It may either be the filename of\n@@ -1798,7 +1798,7 @@ http.sslTry::\n \n http.maxRequests::\n \tHow many HTTP requests to launch in parallel. Can be overridden\n-\tby the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.\n+\tby the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.\n \n http.minSessions::\n \tThe number of curl sessions (counted across slots) to be kept across\n@@ -1817,13 +1817,13 @@ http.postBuffer::\n http.lowSpeedLimit, http.lowSpeedTime::\n \tIf the HTTP transfer speed is less than 'http.lowSpeedLimit'\n \tfor longer than 'http.lowSpeedTime' seconds, the transfer is aborted.\n-\tCan be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and\n-\t'GIT_HTTP_LOW_SPEED_TIME' environment variables.\n+\tCan be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and\n+\t`GIT_HTTP_LOW_SPEED_TIME` environment variables.\n \n http.noEPSV::\n \tA boolean which disables using of EPSV ftp command by curl.\n \tThis can helpful with some \"poor\" ftp servers which don't\n-\tsupport EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'\n+\tsupport EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`\n \tenvironment variable. Default is false (curl will use EPSV).\n \n http.userAgent::\n@@ -1833,7 +1833,7 @@ http.userAgent::\n \tsuch as Mozilla/4.0. This may be necessary, for instance, if\n \tconnecting through a firewall that restricts HTTP connections to a set\n \tof common USER_AGENT strings (but not including those like git/1.7.1).\n-\tCan be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.\n+\tCan be overridden by the `GIT_HTTP_USER_AGENT` environment variable.\n \n http..*::\n \tAny of the http.* options above can be applied selectively to some URLs.\n@@ -2909,12 +2909,12 @@ url..pushInsteadOf::\n \n user.email::\n \tYour email address to be recorded in any newly created commits.\n-\tCan be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and\n+\tCan be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and\n \t'EMAIL' environment variables. See linkgit:git-commit-tree[1].\n \n user.name::\n \tYour full name to be recorded in any newly created commits.\n-\tCan be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'\n+\tCan be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`\n \tenvironment variables. See linkgit:git-commit-tree[1].\n \n user.useConfigOnly::\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex dec379b..4a6c47f 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -203,7 +203,7 @@ mailmap.*::\n \n notes.displayRef::\n \tWhich refs, in addition to the default set by `core.notesRef`\n-\tor 'GIT_NOTES_REF', to read notes from when showing commit\n+\tor `GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages with the `log` family of commands. See\n \tlinkgit:git-notes[1].\n +\n@@ -212,7 +212,7 @@ multiple times. A warning will be issued for refs that do not exist,\n but a glob that does not match any refs is silently ignored.\n +\n This setting can be disabled by the `--no-notes` option,\n-overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,\n+overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,\n and overridden by the `--notes=` option.\n \n GIT\ndiff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt\nindex 9c4fd68..02a10bc 100644\n--- a/Documentation/git-notes.txt\n+++ b/Documentation/git-notes.txt\n@@ -161,7 +161,7 @@ OPTIONS\n \n --ref ::\n \tManipulate the notes tree in . This overrides\n-\t'GIT_NOTES_REF' and the \"core.notesRef\" configuration. The ref\n+\t`GIT_NOTES_REF` and the \"core.notesRef\" configuration. The ref\n \tspecifies the full refname when it begins with `refs/notes/`; when it\n \tbegins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed\n \tto form a full name of the ref.\n@@ -333,10 +333,10 @@ notes..mergeStrategy::\n notes.displayRef::\n \tWhich ref (or refs, if a glob or specified more than once), in\n \taddition to the default set by `core.notesRef` or\n-\t'GIT_NOTES_REF', to read notes from when showing commit\n+\t`GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages with the 'git log' family of commands.\n \tThis setting can be overridden on the command line or by the\n-\t'GIT_NOTES_DISPLAY_REF' environment variable.\n+\t`GIT_NOTES_DISPLAY_REF` environment variable.\n \tSee linkgit:git-log[1].\n \n notes.rewrite.::\n@@ -345,7 +345,7 @@ notes.rewrite.::\n \tnotes from the original to the rewritten commit. Defaults to\n \t`true`. See also \"`notes.rewriteRef`\" below.\n +\n-This setting can be overridden by the 'GIT_NOTES_REWRITE_REF'\n+This setting can be overridden by the `GIT_NOTES_REWRITE_REF`\n environment variable.\n \n notes.rewriteMode::\n@@ -366,33 +366,33 @@ notes.rewriteRef::\n Does not have a default value; you must configure this variable to\n enable note rewriting.\n +\n-Can be overridden with the 'GIT_NOTES_REWRITE_REF' environment variable.\n+Can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable.\n \n \n ENVIRONMENT\n -----------\n \n-'GIT_NOTES_REF'::\n+`GIT_NOTES_REF`::\n \tWhich ref to manipulate notes from, instead of `refs/notes/commits`.\n \tThis overrides the `core.notesRef` setting.\n \n-'GIT_NOTES_DISPLAY_REF'::\n+`GIT_NOTES_DISPLAY_REF`::\n \tColon-delimited list of refs or globs indicating which refs,\n \tin addition to the default from `core.notesRef` or\n-\t'GIT_NOTES_REF', to read notes from when showing commit\n+\t`GIT_NOTES_REF`, to read notes from when showing commit\n \tmessages.\n \tThis overrides the `notes.displayRef` setting.\n +\n A warning will be issued for refs that do not exist, but a glob that\n does not match any refs is silently ignored.\n \n-'GIT_NOTES_REWRITE_MODE'::\n+`GIT_NOTES_REWRITE_MODE`::\n \tWhen copying notes during a rewrite, what to do if the target\n \tcommit already has a note.\n \tMust be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.\n \tThis overrides the `core.rewriteMode` setting.\n \n-'GIT_NOTES_REWRITE_REF'::\n+`GIT_NOTES_REWRITE_REF`::\n \tWhen rewriting commits, which notes to copy from the original\n \tto the rewritten commit. Must be a colon-delimited list of\n \trefs or globs.\ndiff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt\nindex 88ba42b..3385409 100644\n--- a/Documentation/git-p4.txt\n+++ b/Documentation/git-p4.txt\n@@ -166,7 +166,7 @@ General options\n All commands except clone accept these options.\n \n --git-dir ::\n-\tSet the 'GIT_DIR' environment variable. See linkgit:git[1].\n+\tSet the `GIT_DIR` environment variable. See linkgit:git[1].\n \n -v::\n --verbose::\ndiff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt\nindex 8fff598..e5c57ae 100644\n--- a/Documentation/git-replace.txt\n+++ b/Documentation/git-replace.txt\n@@ -51,7 +51,7 @@ $ git cat-file commit foo\n \n shows information about commit 'bar'.\n \n-The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to\n+The `GIT_NO_REPLACE_OBJECTS` environment variable can be set to\n achieve the same effect as the `--no-replace-objects` option.\n \n OPTIONS\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex dd6dbf7..48f5bf7 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -821,46 +821,46 @@ These environment variables apply to 'all' core Git commands. Nb: it\n is worth noting that they may be used/overridden by SCMS sitting above\n Git so take care if using a foreign front-end.\n \n-'GIT_INDEX_FILE'::\n+`GIT_INDEX_FILE`::\n \tThis environment allows the specification of an alternate\n \tindex file. If not specified, the default of `$GIT_DIR/index`\n \tis used.\n \n-'GIT_INDEX_VERSION'::\n+`GIT_INDEX_VERSION`::\n \tThis environment variable allows the specification of an index\n \tversion for new repositories. It won't affect existing index\n \tfiles. By default index file version 2 or 3 is used. See\n \tlinkgit:git-update-index[1] for more information.\n \n-'GIT_OBJECT_DIRECTORY'::\n+`GIT_OBJECT_DIRECTORY`::\n \tIf the object storage directory is specified via this\n \tenvironment variable then the sha1 directories are created\n \tunderneath - otherwise the default `$GIT_DIR/objects`\n \tdirectory is used.\n \n-'GIT_ALTERNATE_OBJECT_DIRECTORIES'::\n+`GIT_ALTERNATE_OBJECT_DIRECTORIES`::\n \tDue to the immutable nature of Git objects, old objects can be\n \tarchived into shared, read-only directories. This variable\n \tspecifies a \":\" separated (on Windows \";\" separated) list\n \tof Git object directories which can be used to search for Git\n \tobjects. New objects will not be written to these directories.\n \n-'GIT_DIR'::\n-\tIf the 'GIT_DIR' environment variable is set then it\n+`GIT_DIR`::\n+\tIf the `GIT_DIR` environment variable is set then it\n \tspecifies a path to use instead of the default `.git`\n \tfor the base of the repository.\n \tThe '--git-dir' command-line option also sets this value.\n \n-'GIT_WORK_TREE'::\n+`GIT_WORK_TREE`::\n \tSet the path to the root of the working tree.\n \tThis can also be controlled by the '--work-tree' command-line\n \toption and the core.worktree configuration variable.\n \n-'GIT_NAMESPACE'::\n+`GIT_NAMESPACE`::\n \tSet the Git namespace; see linkgit:gitnamespaces[7] for details.\n \tThe '--namespace' command-line option also sets this value.\n \n-'GIT_CEILING_DIRECTORIES'::\n+`GIT_CEILING_DIRECTORIES`::\n \tThis should be a colon-separated list of absolute paths. If\n \tset, it is a list of directories that Git should not chdir up\n \tinto while looking for a repository directory (useful for\n@@ -873,19 +873,19 @@ Git so take care if using a foreign front-end.\n \tcan add an empty entry to the list to tell Git that the\n \tsubsequent entries are not symlinks and needn't be resolved;\n \te.g.,\n-\t'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.\n+\t`GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink`.\n \n-'GIT_DISCOVERY_ACROSS_FILESYSTEM'::\n+`GIT_DISCOVERY_ACROSS_FILESYSTEM`::\n \tWhen run in a directory that does not have \".git\" repository\n \tdirectory, Git tries to find such a directory in the parent\n \tdirectories to find the top of the working tree, but by default it\n \tdoes not cross filesystem boundaries. This environment variable\n \tcan be set to true to tell Git not to stop at filesystem\n-\tboundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect\n-\tan explicit repository directory set via 'GIT_DIR' or on the\n+\tboundaries. Like `GIT_CEILING_DIRECTORIES`, this will not affect\n+\tan explicit repository directory set via `GIT_DIR` or on the\n \tcommand line.\n \n-'GIT_COMMON_DIR'::\n+`GIT_COMMON_DIR`::\n \tIf this variable is set to a path, non-worktree files that are\n \tnormally in $GIT_DIR will be taken from this path\n \tinstead. Worktree-specific files such as HEAD or index are\n@@ -896,28 +896,28 @@ Git so take care if using a foreign front-end.\n \n Git Commits\n ~~~~~~~~~~~\n-'GIT_AUTHOR_NAME'::\n-'GIT_AUTHOR_EMAIL'::\n-'GIT_AUTHOR_DATE'::\n-'GIT_COMMITTER_NAME'::\n-'GIT_COMMITTER_EMAIL'::\n-'GIT_COMMITTER_DATE'::\n+`GIT_AUTHOR_NAME`::\n+`GIT_AUTHOR_EMAIL`::\n+`GIT_AUTHOR_DATE`::\n+`GIT_COMMITTER_NAME`::\n+`GIT_COMMITTER_EMAIL`::\n+`GIT_COMMITTER_DATE`::\n 'EMAIL'::\n \tsee linkgit:git-commit-tree[1]\n \n Git Diffs\n ~~~~~~~~~\n-'GIT_DIFF_OPTS'::\n+`GIT_DIFF_OPTS`::\n \tOnly valid setting is \"--unified=??\" or \"-u??\" to set the\n \tnumber of context lines shown when a unified diff is created.\n \tThis takes precedence over any \"-U\" or \"--unified\" option\n \tvalue passed on the Git diff command line.\n \n-'GIT_EXTERNAL_DIFF'::\n-\tWhen the environment variable 'GIT_EXTERNAL_DIFF' is set, the\n+`GIT_EXTERNAL_DIFF`::\n+\tWhen the environment variable `GIT_EXTERNAL_DIFF` is set, the\n \tprogram named by it is called, instead of the diff invocation\n \tdescribed above. For a path that is added, removed, or modified,\n- 'GIT_EXTERNAL_DIFF' is called with 7 parameters:\n+ `GIT_EXTERNAL_DIFF` is called with 7 parameters:\n \n \tpath old-file old-hex old-mode new-file new-hex new-mode\n +\n@@ -931,42 +931,42 @@ where:\n The file parameters can point at the user's working file\n (e.g. `new-file` in \"git-diff-files\"), `/dev/null` (e.g. `old-file`\n when a new file is added), or a temporary file (e.g. `old-file` in the\n-index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the\n-temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.\n+index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the\n+temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.\n +\n-For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1\n+For a path that is unmerged, `GIT_EXTERNAL_DIFF` is called with 1\n parameter, .\n +\n-For each path 'GIT_EXTERNAL_DIFF' is called, two environment variables,\n-'GIT_DIFF_PATH_COUNTER' and 'GIT_DIFF_PATH_TOTAL' are set.\n+For each path `GIT_EXTERNAL_DIFF` is called, two environment variables,\n+`GIT_DIFF_PATH_COUNTER` and `GIT_DIFF_PATH_TOTAL` are set.\n \n-'GIT_DIFF_PATH_COUNTER'::\n+`GIT_DIFF_PATH_COUNTER`::\n \tA 1-based counter incremented by one for every path.\n \n-'GIT_DIFF_PATH_TOTAL'::\n+`GIT_DIFF_PATH_TOTAL`::\n \tThe total number of paths.\n \n other\n ~~~~~\n-'GIT_MERGE_VERBOSITY'::\n+`GIT_MERGE_VERBOSITY`::\n \tA number controlling the amount of output shown by\n \tthe recursive merge strategy. Overrides merge.verbosity.\n \tSee linkgit:git-merge[1]\n \n-'GIT_PAGER'::\n+`GIT_PAGER`::\n \tThis environment variable overrides `$PAGER`. If it is set\n \tto an empty string or to the value \"cat\", Git will not launch\n \ta pager. See also the `core.pager` option in\n \tlinkgit:git-config[1].\n \n-'GIT_EDITOR'::\n+`GIT_EDITOR`::\n \tThis environment variable overrides `$EDITOR` and `$VISUAL`.\n \tIt is used by several Git commands when, on interactive mode,\n \tan editor is to be launched. See also linkgit:git-var[1]\n \tand the `core.editor` option in linkgit:git-config[1].\n \n-'GIT_SSH'::\n-'GIT_SSH_COMMAND'::\n+`GIT_SSH`::\n+`GIT_SSH_COMMAND`::\n \tIf either of these environment variables is set then 'git fetch'\n \tand 'git push' will use the specified command instead of 'ssh'\n \twhen they need to connect to a remote system.\n@@ -986,18 +986,18 @@ Usually it is easier to configure any desired options through your\n personal `.ssh/config` file. Please consult your ssh documentation\n for further details.\n \n-'GIT_ASKPASS'::\n+`GIT_ASKPASS`::\n \tIf this environment variable is set, then Git commands which need to\n \tacquire passwords or passphrases (e.g. for HTTP or IMAP authentication)\n \twill call this program with a suitable prompt as command-line argument\n \tand read the password from its STDOUT. See also the 'core.askPass'\n \toption in linkgit:git-config[1].\n \n-'GIT_TERMINAL_PROMPT'::\n+`GIT_TERMINAL_PROMPT`::\n \tIf this environment variable is set to `0`, git will not prompt\n \ton the terminal (e.g., when asking for HTTP authentication).\n \n-'GIT_CONFIG_NOSYSTEM'::\n+`GIT_CONFIG_NOSYSTEM`::\n \tWhether to skip reading settings from the system-wide\n \t`$(prefix)/etc/gitconfig` file. This environment variable can\n \tbe used along with `$HOME` and `$XDG_CONFIG_HOME` to create a\n@@ -1005,7 +1005,7 @@ for further details.\n \ttemporarily to avoid using a buggy `/etc/gitconfig` file while\n \twaiting for someone with sufficient permissions to fix it.\n \n-'GIT_FLUSH'::\n+`GIT_FLUSH`::\n \tIf this environment variable is set to \"1\", then commands such\n \tas 'git blame' (in incremental mode), 'git rev-list', 'git log',\n \t'git check-attr' and 'git check-ignore' will\n@@ -1016,7 +1016,7 @@ for further details.\n \tnot set, Git will choose buffered or record-oriented flushing\n \tbased on whether stdout appears to be redirected to a file or not.\n \n-'GIT_TRACE'::\n+`GIT_TRACE`::\n \tEnables general trace messages, e.g. alias expansion, built-in\n \tcommand execution and external command execution.\n +\n@@ -1037,21 +1037,21 @@ into it.\n Unsetting the variable, or setting it to empty, \"0\" or\n \"false\" (case insensitive) disables trace messages.\n \n-'GIT_TRACE_PACK_ACCESS'::\n+`GIT_TRACE_PACK_ACCESS`::\n \tEnables trace messages for all accesses to any packs. For each\n \taccess, the pack file name and an offset in the pack is\n \trecorded. This may be helpful for troubleshooting some\n \tpack-related performance problems.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_PACKET'::\n+`GIT_TRACE_PACKET`::\n \tEnables trace messages for all packets coming in or out of a\n \tgiven program. This can help with debugging object negotiation\n \tor other protocol issues. Tracing is turned off at a packet\n-\tstarting with \"PACK\" (but see 'GIT_TRACE_PACKFILE' below).\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tstarting with \"PACK\" (but see `GIT_TRACE_PACKFILE` below).\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_PACKFILE'::\n+`GIT_TRACE_PACKFILE`::\n \tEnables tracing of packfiles sent or received by a\n \tgiven program. Unlike other trace output, this trace is\n \tverbatim: no headers, and no quoting of binary data. You almost\n@@ -1062,22 +1062,22 @@ Unsetting the variable, or setting it to empty, \"0\" or\n Note that this is currently only implemented for the client side\n of clones and fetches.\n \n-'GIT_TRACE_PERFORMANCE'::\n+`GIT_TRACE_PERFORMANCE`::\n \tEnables performance related trace messages, e.g. total execution\n \ttime of each Git command.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_SETUP'::\n+`GIT_TRACE_SETUP`::\n \tEnables trace messages printing the .git, working tree and current\n \tworking directory after Git has completed its setup phase.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_TRACE_SHALLOW'::\n+`GIT_TRACE_SHALLOW`::\n \tEnables trace messages that can help debugging fetching /\n \tcloning of shallow repositories.\n-\tSee 'GIT_TRACE' for available trace output options.\n+\tSee `GIT_TRACE` for available trace output options.\n \n-'GIT_LITERAL_PATHSPECS'::\n+`GIT_LITERAL_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs literally, rather than as glob patterns. For example,\n \trunning `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search\n@@ -1086,19 +1086,19 @@ of clones and fetches.\n \tliteral paths to Git (e.g., paths previously given to you by\n \t`git ls-tree`, `--raw` diff output, etc).\n \n-'GIT_GLOB_PATHSPECS'::\n+`GIT_GLOB_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as glob patterns (aka \"glob\" magic).\n \n-'GIT_NOGLOB_PATHSPECS'::\n+`GIT_NOGLOB_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as literal (aka \"literal\" magic).\n \n-'GIT_ICASE_PATHSPECS'::\n+`GIT_ICASE_PATHSPECS`::\n \tSetting this variable to `1` will cause Git to treat all\n \tpathspecs as case-insensitive.\n \n-'GIT_REFLOG_ACTION'::\n+`GIT_REFLOG_ACTION`::\n \tWhen a ref is updated, reflog entries are created to keep\n \ttrack of the reason why the ref was updated (which is\n \ttypically the name of the high-level command that updated\n@@ -1108,7 +1108,7 @@ of clones and fetches.\n \tvariable when it is invoked as the top level command by the\n \tend user, to be recorded in the body of the reflog.\n \n-'GIT_REF_PARANOIA'::\n+`GIT_REF_PARANOIA`::\n \tIf set to `1`, include broken or badly named refs when iterating\n \tover lists of refs. In a normal, non-corrupted repository, this\n \tdoes nothing. However, enabling it may help git to detect and\n@@ -1119,7 +1119,7 @@ of clones and fetches.\n \tan operation has touched every ref (e.g., because you are\n \tcloning a repository to make a backup).\n \n-'GIT_ALLOW_PROTOCOL'::\n+`GIT_ALLOW_PROTOCOL`::\n \tIf set, provide a colon-separated list of protocols which are\n \tallowed to be used with fetch/push/clone. This is useful to\n \trestrict recursive submodule initialization from an untrusted\ndiff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt\nindex 78e0b27..e279327 100644\n--- a/Documentation/gitremote-helpers.txt\n+++ b/Documentation/gitremote-helpers.txt\n@@ -43,7 +43,7 @@ arguments. The first argument specifies a remote repository as in Git;\n it is either the name of a configured remote or a URL. The second\n argument specifies a URL; it is usually of the form\n '://
', but any arbitrary string is possible.\n-The 'GIT_DIR' environment variable is set up for the remote helper\n+The `GIT_DIR` environment variable is set up for the remote helper\n and can be used to determine where to store additional data or from\n which directory to invoke auxiliary Git commands.\n \ndiff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt\nindex cd9c895..96156e5 100644\n--- a/Documentation/gitweb.txt\n+++ b/Documentation/gitweb.txt\n@@ -206,8 +206,8 @@ $export_auth_hook = sub {\n Per-repository gitweb configuration\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n You can configure individual repositories shown in gitweb by creating file\n-in the 'GIT_DIR' of Git repository, or by setting some repo configuration\n-variable (in 'GIT_DIR/config', see linkgit:git-config[1]).\n+in the `GIT_DIR` of Git repository, or by setting some repo configuration\n+variable (in `GIT_DIR/config`, see linkgit:git-config[1]).\n \n You can use the following files in repository:\n \ndiff --git a/Documentation/merge-config.txt b/Documentation/merge-config.txt\nindex 002ca58..df3ea37 100644\n--- a/Documentation/merge-config.txt\n+++ b/Documentation/merge-config.txt\n@@ -61,7 +61,7 @@ merge.verbosity::\n \tmessage if conflicts were detected. Level 1 outputs only\n \tconflicts, 2 outputs conflicts and file changes. Level 5 and\n \tabove outputs debugging information. The default is level 2.\n-\tCan be overridden by the 'GIT_MERGE_VERBOSITY' environment variable.\n+\tCan be overridden by the `GIT_MERGE_VERBOSITY` environment variable.\n \n merge..name::\n \tDefines a human-readable name for a custom low-level\n-- \n2.8.3\n"},{"id":"288337","messageId":"20160603220837.9842-4-tom.russello@grenoble-inp.org","threadId":"42370","inReplyTo":"20160603220837.9842-1-tom.russello@grenoble-inp.org","subject":"[PATCH v2 3/3] Change configuration variables format","fromName":"Tom Russello","fromEmail":"tom.russello@grenoble-inp.org","sentAt":"2016-06-03T22:08:37Z","receivedAt":"2016-06-03T22:08:37Z","isPatch":true,"sender":{"key":"tom.russello@grenoble-inp.org","avatar":null},"body":"As a first step, this change configuration variables that where in italic style\nto monospace font according to the guideline. It was obtained with\n\n\tgrep '[[:alpha:]]*\\.[[:alpha:]]*::$' config.txt | \\\n\tsed -e 's/::$//' -e 's/\\./\\\\\\\\./' | \\\n\txargs -iP perl -pi -e \"s/\\'P\\'/\\`P\\`/g\" ./*.txt\n\nSigned-off-by: Tom Russello \nSigned-off-by: Erwan Mathoniere \nSigned-off-by: Samuel Groot \nSigned-off-by: Matthieu Moy \n---\nCurrently, in Documentation/git-status.txt, status.relativePaths (l.120) has no\nparticular style whereas in Documentation/git-send-email.txt, sendemail.annotate\nis wrapped with single-quotes ('sendemail.annotate' - l.50) and\nsendemail.xmailer is wrapped with backticks (`sendemail.xmailer` - l.149).\n\n Documentation/config.txt | 26 ++++++++--------\n Documentation/diff-config.txt | 2 +-\n Documentation/git-commit.txt | 2 +-\n Documentation/git-format-patch.txt | 6 ++--\n Documentation/git-gc.txt | 16 +++++-----\n Documentation/git-grep.txt | 2 +-\n Documentation/git-help.txt | 24 +++++++-------\n Documentation/git-instaweb.txt | 4 +--\n Documentation/git-push.txt | 6 ++--\n Documentation/git-send-email.txt | 62 ++++++++++++++++++-------------------\n Documentation/git-svn.txt | 2 +-\n Documentation/git-tag.txt | 2 +-\n Documentation/git-web--browse.txt | 6 ++--\n Documentation/git.txt | 2 +-\n Documentation/gitignore.txt | 2 +-\n Documentation/gitremote-helpers.txt | 4 +--\n Documentation/pretty-options.txt | 4 +--\n 17 files changed, 86 insertions(+), 86 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 3897906..c645d1f 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -545,7 +545,7 @@ core.compression::\n \t-1 is the zlib default. 0 means no compression,\n \tand 1..9 are various speed/size tradeoffs, 9 being slowest.\n \tIf set, this provides a default to other compression variables,\n-\tsuch as 'core.looseCompression' and 'pack.compression'.\n+\tsuch as `core.looseCompression` and `pack.compression`.\n \n core.looseCompression::\n \tAn integer -1..9, indicating the compression level for objects that\n@@ -1426,18 +1426,18 @@ gitcvs.usecrlfattr::\n \ttreat it as text. If they suppress text conversion, the file\n \twill be set with '-kb' mode, which suppresses any newline munging\n \tthe client might otherwise do. If the attributes do not allow\n-\tthe file type to be determined, then 'gitcvs.allBinary' is\n+\tthe file type to be determined, then `gitcvs.allBinary` is\n \tused. See linkgit:gitattributes[5].\n \n gitcvs.allBinary::\n-\tThis is used if 'gitcvs.usecrlfattr' does not resolve\n+\tThis is used if `gitcvs.usecrlfattr` does not resolve\n \tthe correct '-kb' mode to use. If true, all\n \tunresolved files are sent to the client in\n \tmode '-kb'. This causes the client to treat them\n \tas binary files, which suppresses any newline munging it\n \totherwise might do. Alternatively, if it is set to \"guess\",\n \tthen the contents of the file are examined to decide if\n-\tit is binary, similar to 'core.autocrlf'.\n+\tit is binary, similar to `core.autocrlf`.\n \n gitcvs.dbName::\n \tDatabase used by git-cvsserver to cache revision information\n@@ -1456,7 +1456,7 @@ gitcvs.dbDriver::\n \tSee linkgit:git-cvsserver[1].\n \n gitcvs.dbUser, gitcvs.dbPass::\n-\tDatabase user and password. Only useful if setting 'gitcvs.dbDriver',\n+\tDatabase user and password. Only useful if setting `gitcvs.dbDriver`,\n \tsince SQLite has no concept of database users and/or passwords.\n \t'gitcvs.dbUser' supports variable substitution (see\n \tlinkgit:git-cvsserver[1] for details).\n@@ -1468,8 +1468,8 @@ gitcvs.dbTableNamePrefix::\n \tlinkgit:git-cvsserver[1] for details). Any non-alphabetic\n \tcharacters will be replaced with underscores.\n \n-All gitcvs variables except for 'gitcvs.usecrlfattr' and\n-'gitcvs.allBinary' can also be specified as\n+All gitcvs variables except for `gitcvs.usecrlfattr` and\n+`gitcvs.allBinary` can also be specified as\n 'gitcvs..' (where 'access_method'\n is one of \"ext\" and \"pserver\") to make them apply only for the given\n access method.\n@@ -1502,7 +1502,7 @@ grep.patternType::\n \n grep.extendedRegexp::\n \tIf set to true, enable '--extended-regexp' option by default. This\n-\toption is ignored when the 'grep.patternType' option is set to a value\n+\toption is ignored when the `grep.patternType` option is set to a value\n \tother than 'default'.\n \n grep.threads::\n@@ -2630,7 +2630,7 @@ sendemail.identity::\n \tA configuration identity. When given, causes values in the\n \t'sendemail.' subsection to take precedence over\n \tvalues in the 'sendemail' section. The default identity is\n-\tthe value of 'sendemail.identity'.\n+\tthe value of `sendemail.identity`.\n \n sendemail.smtpEncryption::\n \tSee linkgit:git-send-email[1] for description. Note that this\n@@ -2647,7 +2647,7 @@ sendemail..*::\n \tIdentity-specific versions of the 'sendemail.*' parameters\n \tfound below, taking precedence over those when the this\n \tidentity is selected, through command-line or\n-\t'sendemail.identity'.\n+\t`sendemail.identity`.\n \n sendemail.aliasesFile::\n sendemail.aliasFileType::\n@@ -2677,7 +2677,7 @@ sendemail.xmailer::\n \tSee linkgit:git-send-email[1] for description.\n \n sendemail.signedoffcc (deprecated)::\n-\tDeprecated alias for 'sendemail.signedoffbycc'.\n+\tDeprecated alias for `sendemail.signedoffbycc`.\n \n showbranch.default::\n \tThe default set of branches for linkgit:git-show-branch[1].\n@@ -2918,8 +2918,8 @@ user.name::\n \tenvironment variables. See linkgit:git-commit-tree[1].\n \n user.useConfigOnly::\n-\tInstruct Git to avoid trying to guess defaults for 'user.email'\n-\tand 'user.name', and instead retrieve the values only from the\n+\tInstruct Git to avoid trying to guess defaults for `user.email`\n+\tand `user.name`, and instead retrieve the values only from the\n \tconfiguration. For example, if you have multiple email addresses\n \tand would like to use a different one for each repository, then\n \twith this configuration option set to `true` in the global config\ndiff --git a/Documentation/diff-config.txt b/Documentation/diff-config.txt\nindex edba565..f8a5059 100644\n--- a/Documentation/diff-config.txt\n+++ b/Documentation/diff-config.txt\n@@ -75,7 +75,7 @@ diff.ignoreSubmodules::\n \tcommands such as 'git diff-files'. 'git checkout' also honors\n \tthis setting when reporting uncommitted changes. Setting it to\n \t'all' disables the submodule summary normally shown by 'git commit'\n-\tand 'git status' when 'status.submoduleSummary' is set unless it is\n+\tand 'git status' when `status.submoduleSummary` is set unless it is\n \toverridden by using the --ignore-submodules command-line option.\n \tThe 'git submodule' commands are not affected by this setting.\n \ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex d474226..9121773 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -201,7 +201,7 @@ default::\n \tOtherwise `whitespace`.\n --\n +\n-The default can be changed by the 'commit.cleanup' configuration\n+The default can be changed by the `commit.cleanup` configuration\n variable (see linkgit:git-config[1]).\n \n -e::\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex bdeecd5..9624c84 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -58,7 +58,7 @@ output, unless the `--stdout` option is specified.\n \n If `-o` is specified, output files are created in . Otherwise\n they are created in the current working directory. The default path\n-can be set with the 'format.outputDirectory' configuration option.\n+can be set with the `format.outputDirectory` configuration option.\n The `-o` option takes precedence over `format.outputDirectory`.\n To store patches in the current working directory even when\n `format.outputDirectory` points elsewhere, use `-o .`.\n@@ -146,9 +146,9 @@ series, where the head is chosen from the cover letter, the\n `--in-reply-to`, and the first patch mail, in this order. 'deep'\n threading makes every mail a reply to the previous one.\n +\n-The default is `--no-thread`, unless the 'format.thread' configuration\n+The default is `--no-thread`, unless the `format.thread` configuration\n is set. If `--thread` is specified without a style, it defaults to the\n-style specified by 'format.thread' if any, or else `shallow`.\n+style specified by `format.thread` if any, or else `shallow`.\n +\n Beware that the default for 'git send-email' is to thread emails\n itself. If you want `git format-patch` to take care of threading, you\ndiff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt\nindex fa15104..bed60f4 100644\n--- a/Documentation/git-gc.txt\n+++ b/Documentation/git-gc.txt\n@@ -82,13 +82,13 @@ automatic consolidation of packs.\n Configuration\n -------------\n \n-The optional configuration variable 'gc.reflogExpire' can be\n+The optional configuration variable `gc.reflogExpire` can be\n set to indicate how long historical entries within each branch's\n reflog should remain available in this repository. The setting is\n expressed as a length of time, for example '90 days' or '3 months'.\n It defaults to '90 days'.\n \n-The optional configuration variable 'gc.reflogExpireUnreachable'\n+The optional configuration variable `gc.reflogExpireUnreachable`\n can be set to indicate how long historical reflog entries which\n are not part of the current branch should remain available in\n this repository. These types of entries are generally created as\n@@ -107,30 +107,30 @@ branches:\n \treflogExpireUnreachable = 3 days\n ------------\n \n-The optional configuration variable 'gc.rerereResolved' indicates\n+The optional configuration variable `gc.rerereResolved` indicates\n how long records of conflicted merge you resolved earlier are\n kept. This defaults to 60 days.\n \n-The optional configuration variable 'gc.rerereUnresolved' indicates\n+The optional configuration variable `gc.rerereUnresolved` indicates\n how long records of conflicted merge you have not resolved are\n kept. This defaults to 15 days.\n \n-The optional configuration variable 'gc.packRefs' determines if\n+The optional configuration variable `gc.packRefs` determines if\n 'git gc' runs 'git pack-refs'. This can be set to \"notbare\" to enable\n it within all non-bare repos or it can be set to a boolean value.\n This defaults to true.\n \n-The optional configuration variable 'gc.aggressiveWindow' controls how\n+The optional configuration variable `gc.aggressiveWindow` controls how\n much time is spent optimizing the delta compression of the objects in\n the repository when the --aggressive option is specified. The larger\n the value, the more time is spent optimizing the delta compression. See\n the documentation for the --window' option in linkgit:git-repack[1] for\n more details. This defaults to 250.\n \n-Similarly, the optional configuration variable 'gc.aggressiveDepth'\n+Similarly, the optional configuration variable `gc.aggressiveDepth`\n controls --depth option in linkgit:git-repack[1]. This defaults to 250.\n \n-The optional configuration variable 'gc.pruneExpire' controls how old\n+The optional configuration variable `gc.pruneExpire` controls how old\n the unreferenced loose objects have to be before they are pruned. The\n default is \"2 weeks ago\".\n \ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex cb0f6cf..40cfe37 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -51,7 +51,7 @@ grep.patternType::\n \n grep.extendedRegexp::\n \tIf set to true, enable '--extended-regexp' option by default. This\n-\toption is ignored when the 'grep.patternType' option is set to a value\n+\toption is ignored when the `grep.patternType` option is set to a value\n \tother than 'default'.\n \n grep.threads::\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex 3956525..22500e0 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -57,10 +57,10 @@ OPTIONS\n --man::\n \tDisplay manual page for the command in the 'man' format. This\n \toption may be used to override a value set in the\n-\t'help.format' configuration variable.\n+\t`help.format` configuration variable.\n +\n By default the 'man' program will be used to display the manual page,\n-but the 'man.viewer' configuration variable may be used to choose\n+but the `man.viewer` configuration variable may be used to choose\n other display programs (see below).\n \n -w::\n@@ -69,7 +69,7 @@ other display programs (see below).\n \tformat. A web browser will be used for that purpose.\n +\n The web browser can be specified using the configuration variable\n-'help.browser', or 'web.browser' if the former is not set. If none of\n+`help.browser`, or `web.browser` if the former is not set. If none of\n these config variables is set, the 'git web{litdd}browse' helper script\n (called by 'git help') will pick a suitable default. See\n linkgit:git-web{litdd}browse[1] for more information about this.\n@@ -80,7 +80,7 @@ CONFIGURATION VARIABLES\n help.format\n ~~~~~~~~~~~\n \n-If no command-line option is passed, the 'help.format' configuration\n+If no command-line option is passed, the `help.format` configuration\n variable will be checked. The following values are supported for this\n variable; they make 'git help' behave as their corresponding command-\n line option:\n@@ -92,7 +92,7 @@ line option:\n help.browser, web.browser and browser..path\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \n-The 'help.browser', 'web.browser' and 'browser..path' will also\n+The `help.browser`, `web.browser` and `browser..path` will also\n be checked if the 'web' format is chosen (either by command-line\n option or configuration variable). See '-w|--web' in the OPTIONS\n section above and linkgit:git-web{litdd}browse[1].\n@@ -100,7 +100,7 @@ section above and linkgit:git-web{litdd}browse[1].\n man.viewer\n ~~~~~~~~~~\n \n-The 'man.viewer' configuration variable will be checked if the 'man'\n+The `man.viewer` configuration variable will be checked if the 'man'\n format is chosen. The following values are currently supported:\n \n * \"man\": use the 'man' program as usual,\n@@ -110,9 +110,9 @@ format is chosen. The following values are currently supported:\n tab (see 'Note about konqueror' below).\n \n Values for other tools can be used if there is a corresponding\n-'man..cmd' configuration entry (see below).\n+`man..cmd` configuration entry (see below).\n \n-Multiple values may be given to the 'man.viewer' configuration\n+Multiple values may be given to the `man.viewer` configuration\n variable. Their corresponding programs will be tried in the order\n listed in the configuration file.\n \n@@ -135,7 +135,7 @@ man..path\n ~~~~~~~~~~~~~~~\n \n You can explicitly provide a full path to your preferred man viewer by\n-setting the configuration variable 'man..path'. For example, you\n+setting the configuration variable `man..path`. For example, you\n can configure the absolute path to konqueror by setting\n 'man.konqueror.path'. Otherwise, 'git help' assumes the tool is\n available in PATH.\n@@ -143,9 +143,9 @@ available in PATH.\n man..cmd\n ~~~~~~~~~~~~~~\n \n-When the man viewer, specified by the 'man.viewer' configuration\n+When the man viewer, specified by the `man.viewer` configuration\n variables, is not among the supported ones, then the corresponding\n-'man..cmd' configuration variable will be looked up. If this\n+`man..cmd` configuration variable will be looked up. If this\n variable exists then the specified tool will be treated as a custom\n command and a shell eval will be used to run the command with the man\n page passed as arguments.\n@@ -153,7 +153,7 @@ page passed as arguments.\n Note about konqueror\n ~~~~~~~~~~~~~~~~~~~~\n \n-When 'konqueror' is specified in the 'man.viewer' configuration\n+When 'konqueror' is specified in the `man.viewer` configuration\n variable, we launch 'kfmclient' to try to open the man page on an\n already opened konqueror in a new tab if possible.\n \ndiff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt\nindex cc75b25..e8ecdbf 100644\n--- a/Documentation/git-instaweb.txt\n+++ b/Documentation/git-instaweb.txt\n@@ -80,8 +80,8 @@ You may specify configuration in your .git/config\n \n -----------------------------------------------------------------------\n \n-If the configuration variable 'instaweb.browser' is not set,\n-'web.browser' will be used instead if it is defined. See\n+If the configuration variable `instaweb.browser` is not set,\n+`web.browser` will be used instead if it is defined. See\n linkgit:git-web{litdd}browse[1] for more information about this.\n \n SEE ALSO\ndiff --git a/Documentation/git-push.txt b/Documentation/git-push.txt\nindex cf6ee4a..19f46b6 100644\n--- a/Documentation/git-push.txt\n+++ b/Documentation/git-push.txt\n@@ -137,8 +137,8 @@ already exists on the remote side.\n \tand also push annotated tags in `refs/tags` that are missing\n \tfrom the remote but are pointing at commit-ish that are\n \treachable from the refs being pushed. This can also be specified\n-\twith configuration variable 'push.followTags'. For more\n-\tinformation, see 'push.followTags' in linkgit:git-config[1].\n+\twith configuration variable `push.followTags`. For more\n+\tinformation, see `push.followTags` in linkgit:git-config[1].\n \n --[no-]signed::\n --sign=(true|false|if-asked)::\n@@ -240,7 +240,7 @@ origin +master` to force a push to the `master` branch). See the\n \tFor every branch that is up to date or successfully pushed, add\n \tupstream (tracking) reference, used by argument-less\n \tlinkgit:git-pull[1] and other commands. For more information,\n-\tsee 'branch..merge' in linkgit:git-config[1].\n+\tsee `branch..merge` in linkgit:git-config[1].\n \n --[no-]thin::\n \tThese options are passed to linkgit:git-send-pack[1]. A thin transfer\ndiff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\nindex edbba3a..f9ff9c1 100644\n--- a/Documentation/git-send-email.txt\n+++ b/Documentation/git-send-email.txt\n@@ -47,18 +47,18 @@ Composing\n \n --annotate::\n \tReview and edit each patch you're about to send. Default is the value\n-\tof 'sendemail.annotate'. See the CONFIGURATION section for\n-\t'sendemail.multiEdit'.\n+\tof `sendemail.annotate`. See the CONFIGURATION section for\n+\t`sendemail.multiEdit`.\n \n --bcc=
,...::\n \tSpecify a \"Bcc:\" value for each email. Default is the value of\n-\t'sendemail.bcc'.\n+\t`sendemail.bcc`.\n +\n This option may be specified multiple times.\n \n --cc=
,...::\n \tSpecify a starting \"Cc:\" value for each email.\n-\tDefault is the value of 'sendemail.cc'.\n+\tDefault is the value of `sendemail.cc`.\n +\n This option may be specified multiple times.\n \n@@ -74,12 +74,12 @@ and In-Reply-To headers will be used unless they are removed.\n +\n Missing From or In-Reply-To headers will be prompted for.\n +\n-See the CONFIGURATION section for 'sendemail.multiEdit'.\n+See the CONFIGURATION section for `sendemail.multiEdit`.\n \n --from=
::\n \tSpecify the sender of the emails. If not specified on the command line,\n-\tthe value of the 'sendemail.from' configuration option is used. If\n-\tneither the command-line option nor 'sendemail.from' are set, then the\n+\tthe value of the `sendemail.from` configuration option is used. If\n+\tneither the command-line option nor `sendemail.from` are set, then the\n \tuser will be prompted for the value. The default for the prompt will be\n \tthe value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not\n \tset, as returned by \"git var -l\".\n@@ -114,7 +114,7 @@ is not set, this will be prompted for.\n --to=
,...::\n \tSpecify the primary recipient of the emails generated. Generally, this\n \twill be the upstream maintainer of the project involved. Default is the\n-\tvalue of the 'sendemail.to' configuration value; if that is unspecified,\n+\tvalue of the `sendemail.to` configuration value; if that is unspecified,\n \tand --to-cmd is not specified, this will be prompted for.\n +\n This option may be specified multiple times.\n@@ -138,7 +138,7 @@ Note that no attempts whatsoever are made to validate the encoding.\n \tcan be useful when the repository contains files that contain carriage\n \treturns, but makes the raw patch email file (as saved from a MUA) much\n \tharder to inspect manually. base64 is even more fool proof, but also\n-\teven more opaque. Default is the value of the 'sendemail.transferEncoding'\n+\teven more opaque. Default is the value of the `sendemail.transferEncoding`\n \tconfiguration value; if that is unspecified, git will use 8bit and not\n \tadd a Content-Transfer-Encoding header.\n \n@@ -157,20 +157,20 @@ Sending\n \tsubscribed to a list. In order to use the 'From' address, set the\n \tvalue to \"auto\". If you use the sendmail binary, you must have\n \tsuitable privileges for the -f parameter. Default is the value of the\n-\t'sendemail.envelopeSender' configuration variable; if that is\n+\t`sendemail.envelopeSender` configuration variable; if that is\n \tunspecified, choosing the envelope sender is left to your MTA.\n \n --smtp-encryption=::\n \tSpecify the encryption to use, either 'ssl' or 'tls'. Any other\n \tvalue reverts to plain SMTP. Default is the value of\n-\t'sendemail.smtpEncryption'.\n+\t`sendemail.smtpEncryption`.\n \n --smtp-domain=::\n \tSpecifies the Fully Qualified Domain Name (FQDN) used in the\n \tHELO/EHLO command to the SMTP server. Some servers require the\n \tFQDN to match your IP address. If not set, git send-email attempts\n \tto determine your FQDN automatically. Default is the value of\n-\t'sendemail.smtpDomain'.\n+\t`sendemail.smtpDomain`.\n \n --smtp-auth=::\n \tWhitespace-separated list of allowed SMTP-AUTH mechanisms. This setting\n@@ -188,13 +188,13 @@ is specified, all mechanisms supported by the SASL library can be used.\n --smtp-pass[=]::\n \tPassword for SMTP-AUTH. The argument is optional: If no\n \targument is specified, then the empty string is used as\n-\tthe password. Default is the value of 'sendemail.smtpPass',\n+\tthe password. Default is the value of `sendemail.smtpPass`,\n \thowever '--smtp-pass' always overrides this value.\n +\n Furthermore, passwords need not be specified in configuration files\n or on the command line. If a username has been specified (with\n-'--smtp-user' or a 'sendemail.smtpUser'), but no password has been\n-specified (with '--smtp-pass' or 'sendemail.smtpPass'), then\n+'--smtp-user' or a `sendemail.smtpUser`), but no password has been\n+specified (with '--smtp-pass' or `sendemail.smtpPass`), then\n a password is obtained using 'git-credential'.\n \n --smtp-server=::\n@@ -202,7 +202,7 @@ a password is obtained using 'git-credential'.\n \t`smtp.example.com` or a raw IP address). Alternatively it can\n \tspecify a full pathname of a sendmail-like program instead;\n \tthe program must support the `-i` option. Default value can\n-\tbe specified by the 'sendemail.smtpServer' configuration\n+\tbe specified by the `sendemail.smtpServer` configuration\n \toption; the built-in default is `/usr/sbin/sendmail` or\n \t`/usr/lib/sendmail` if such program is available, or\n \t`localhost` otherwise.\n@@ -213,11 +213,11 @@ a password is obtained using 'git-credential'.\n \tsubmission port 587, or the common SSL smtp port 465);\n \tsymbolic port names (e.g. \"submission\" instead of 587)\n \tare also accepted. The port can also be set with the\n-\t'sendemail.smtpServerPort' configuration variable.\n+\t`sendemail.smtpServerPort` configuration variable.\n \n --smtp-server-option=