{"thread":{"id":"50507","subject":"[PATCH] doc: format pathnames and URLs as monospace","startedAt":"2019-02-14T16:32:08Z","lastAt":"2019-02-21T09:54:34Z","messageCount":4,"participants":["Corentin BOMPARD","Eric Sunshine","Junio C Hamano","BOMPARD CORENTIN p1603631"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"369316","messageId":"20190214163043.7103-1-corentin.bompard@etu.univ-lyon1.fr","threadId":"50507","inReplyTo":null,"subject":"[PATCH] doc: format pathnames and URLs as monospace","fromName":"Corentin BOMPARD","fromEmail":"corentin.bompard@etu.univ-lyon1.fr","sentAt":"2019-02-14T16:30:43Z","receivedAt":"2019-02-14T16:32:08Z","isPatch":true,"sender":{"key":"corentin.bompard@etu.univ-lyon1.fr","avatar":"https://avatars.githubusercontent.com/u/23448477?v=4"},"body":"Signed-off-by: Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr>\n---\n Documentation/SubmittingPatches                    |  6 ++--\n Documentation/config/checkout.txt                  |  2 +-\n Documentation/config/core.txt                      | 14 ++++----\n Documentation/config/log.txt                       |  4 +--\n Documentation/git-cvsserver.txt                    |  4 +--\n Documentation/git-daemon.txt                       |  2 +-\n Documentation/git-fast-export.txt                  |  2 +-\n Documentation/git-filter-branch.txt                |  8 ++---\n Documentation/git-help.txt                         |  4 +--\n Documentation/git-log.txt                          |  4 +--\n Documentation/git-ls-tree.txt                      |  4 +--\n Documentation/git-p4.txt                           | 26 +++++++-------\n Documentation/git-remote-ext.txt                   |  2 +-\n Documentation/git-remote.txt                       |  4 +--\n Documentation/git-show-ref.txt                     |  6 ++--\n Documentation/git-submodule.txt                    |  2 +-\n Documentation/git-web--browse.txt                  |  4 +--\n Documentation/gitk.txt                             |  8 ++---\n Documentation/gitmodules.txt                       |  2 +-\n Documentation/gitrepository-layout.txt             |  2 +-\n Documentation/gittutorial.txt                      |  2 +-\n Documentation/gitweb.conf.txt                      | 30 ++++++++--------\n Documentation/gitweb.txt                           | 40 +++++++++++-----------\n Documentation/glossary-content.txt                 |  4 +--\n Documentation/howto/maintain-git.txt               |  2 +-\n Documentation/howto/setup-git-server-over-http.txt |  4 +--\n Documentation/merge-options.txt                    |  2 +-\n Documentation/revisions.txt                        | 26 +++++++-------\n Documentation/sequencer.txt                        |  2 +-\n Documentation/technical/pack-protocol.txt          |  2 +-\n 30 files changed, 112 insertions(+), 112 deletions(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex ec8b20514..6d589e118 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -372,15 +372,15 @@ such as \"Thanks-to:\", \"Based-on-patch-by:\", or \"Mentored-by:\".\n Some parts of the system have dedicated maintainers with their own\n repositories.\n \n-- 'git-gui/' comes from git-gui project, maintained by Pat Thoyts:\n+- `git-gui/` comes from git-gui project, maintained by Pat Thoyts:\n \n \tgit://repo.or.cz/git-gui.git\n \n-- 'gitk-git/' comes from Paul Mackerras's gitk project:\n+- `gitk-git/` comes from Paul Mackerras's gitk project:\n \n \tgit://ozlabs.org/~paulus/gitk\n \n-- 'po/' comes from the localization coordinator, Jiang Xin:\n+- `po/` comes from the localization coordinator, Jiang Xin:\n \n \thttps://github.com/git-l10n/git-po/\n \ndiff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt\nindex c4118fa19..8ba92f274 100644\n--- a/Documentation/config/checkout.txt\n+++ b/Documentation/config/checkout.txt\n@@ -1,7 +1,7 @@\n checkout.defaultRemote::\n \tWhen you run 'git checkout <something>' and only have one\n \tremote, it may implicitly fall back on checking out and\n-\ttracking e.g. 'origin/<something>'. This stops working as soon\n+\ttracking e.g. `origin/<something>`. This stops working as soon\n \tas you have more than one remote with a '<something>'\n \treference. This setting allows for setting the name of a\n \tpreferred remote that should always win when it comes to\ndiff --git a/Documentation/config/core.txt b/Documentation/config/core.txt\nindex 7e9b6c8f4..75538d27e 100644\n--- a/Documentation/config/core.txt\n+++ b/Documentation/config/core.txt\n@@ -414,7 +414,7 @@ Common unit suffixes of 'k', 'm', or 'g' are supported.\n core.excludesFile::\n \tSpecifies the pathname to the file that contains patterns to\n \tdescribe paths that are not meant to be tracked, in addition\n-\tto '.gitignore' (per-directory) and '.git/info/exclude'.\n+\tto `.gitignore` (per-directory) and `.git/info/exclude`.\n \tDefaults to `$XDG_CONFIG_HOME/git/ignore`.\n \tIf `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`\n \tis used instead. See linkgit:gitignore[5].\n@@ -429,8 +429,8 @@ core.askPass::\n \tcommand-line argument and write the password on its STDOUT.\n \n core.attributesFile::\n-\tIn addition to '.gitattributes' (per-directory) and\n-\t'.git/info/attributes', Git looks into this file for attributes\n+\tIn addition to `.gitattributes` (per-directory) and\n+\t`.git/info/attributes`, Git looks into this file for attributes\n \t(see linkgit:gitattributes[5]). Path expansions are made the same\n \tway as for `core.excludesFile`. Its default value is\n \t`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not\n@@ -438,10 +438,10 @@ core.attributesFile::\n \n core.hooksPath::\n \tBy default Git will look for your hooks in the\n-\t'$GIT_DIR/hooks' directory. Set this to different path,\n-\te.g. '/etc/git/hooks', and Git will try to find your hooks in\n-\tthat directory, e.g. '/etc/git/hooks/pre-receive' instead of\n-\tin '$GIT_DIR/hooks/pre-receive'.\n+\t`$GIT_DIR/hooks` directory. Set this to different path,\n+\te.g. `/etc/git/hooks`, and Git will try to find your hooks in\n+\tthat directory, e.g. `/etc/git/hooks/pre-receive` instead of\n+\tin `$GIT_DIR/hooks/pre-receive`.\n +\n The path can be either absolute or relative. A relative path is\n taken as relative to the directory where the hooks are run (see\ndiff --git a/Documentation/config/log.txt b/Documentation/config/log.txt\nindex 78d9e4453..59b816afb 100644\n--- a/Documentation/config/log.txt\n+++ b/Documentation/config/log.txt\n@@ -10,8 +10,8 @@ log.date::\n \n log.decorate::\n \tPrint out the ref names of any commits that are shown by the log\n-\tcommand. If 'short' is specified, the ref name prefixes 'refs/heads/',\n-\t'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is\n+\tcommand. If 'short' is specified, the ref name prefixes `refs/heads/`,\n+\t`refs/tags/` and `refs/remotes/` will not be printed. If 'full' is\n \tspecified, the full ref name (including prefix) will be printed.\n \tIf 'auto' is specified, then if the output is going to a terminal,\n \tthe ref names are shown as if 'short' were given, otherwise no ref\ndiff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt\nindex f98b7c6ed..6643bc39f 100644\n--- a/Documentation/git-cvsserver.txt\n+++ b/Documentation/git-cvsserver.txt\n@@ -140,7 +140,7 @@ CVS_SERVER directly in CVSROOT like\n ------\n cvs -d \":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git\" co <HEAD_name>\n ------\n-This has the advantage that it will be saved in your 'CVS/Root' files and\n+This has the advantage that it will be saved in your `CVS/Root` files and\n you don't need to worry about always setting the correct environment\n variable.  SSH users restricted to 'git-shell' don't need to override the default\n with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean\n@@ -179,7 +179,7 @@ allowing access over SSH.\n ------\n --\n 3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,\n-   automatically saving it in your 'CVS/Root' files, then you need to set them\n+   automatically saving it in your `CVS/Root` files, then you need to set them\n    explicitly in your environment.  CVSROOT should be set as per normal, but the\n    directory should point at the appropriate Git repo.  As above, for SSH clients\n    _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.\ndiff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt\nindex 56d54a489..fdc28c041 100644\n--- a/Documentation/git-daemon.txt\n+++ b/Documentation/git-daemon.txt\n@@ -57,7 +57,7 @@ OPTIONS\n \tThis is sort of \"Git root\" - if you run 'git daemon' with\n \t'--base-path=/srv/git' on example.com, then if you later try to pull\n \t'git://example.com/hello.git', 'git daemon' will interpret the path\n-\tas '/srv/git/hello.git'.\n+\tas `/srv/git/hello.git`.\n \n --base-path-relaxed::\n \tIf --base-path is enabled and repo lookup fails, with this option\ndiff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt\nindex 64c01ba91..a734f45ab 100644\n--- a/Documentation/git-fast-export.txt\n+++ b/Documentation/git-fast-export.txt\n@@ -164,7 +164,7 @@ This makes a new branch called 'other' from 'master~5..master'\n \n Note that this assumes that none of the blobs and commit messages\n referenced by that revision range contains the string\n-'refs/heads/master'.\n+`refs/heads/master`.\n \n \n ANONYMIZING\ndiff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt\nindex e6f08ab18..cef94c788 100644\n--- a/Documentation/git-filter-branch.txt\n+++ b/Documentation/git-filter-branch.txt\n@@ -48,7 +48,7 @@ rewriting published history.)\n \n Always verify that the rewritten version is correct: The original refs,\n if different from the rewritten ones, will be stored in the namespace\n-'refs/original/'.\n+`refs/original/`.\n \n Note that since this operation is very I/O expensive, it might\n be a good idea to redirect the temporary directory off-disk with the\n@@ -182,21 +182,21 @@ to other tags will be rewritten to point to the underlying commit.\n \n --original <namespace>::\n \tUse this option to set the namespace where the original commits\n-\twill be stored. The default value is 'refs/original'.\n+\twill be stored. The default value is `refs/original`.\n \n -d <directory>::\n \tUse this option to set the path to the temporary directory used for\n \trewriting.  When applying a tree filter, the command needs to\n \ttemporarily check out the tree to some directory, which may consume\n \tconsiderable space in case of large projects.  By default it\n-\tdoes this in the '.git-rewrite/' directory but you can override\n+\tdoes this in the `.git-rewrite/` directory but you can override\n \tthat choice by this parameter.\n \n -f::\n --force::\n \t'git filter-branch' refuses to start with an existing temporary\n \tdirectory or when there are already refs starting with\n-\t'refs/original/', unless forced.\n+\t`refs/original/`, unless forced.\n \n --state-branch <branch>::\n \tThis option will cause the mapping from old to new objects to\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex c318bf87e..f71db0daa 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -171,8 +171,8 @@ variable, we launch 'kfmclient' to try to open the man page on an\n already opened konqueror in a new tab if possible.\n \n For consistency, we also try such a trick if 'man.konqueror.path' is\n-set to something like 'A_PATH_TO/konqueror'. That means we will try to\n-launch 'A_PATH_TO/kfmclient' instead.\n+set to something like `A_PATH_TO/konqueror`. That means we will try to\n+launch `A_PATH_TO/kfmclient` instead.\n \n If you really want to use 'konqueror', then you can use something like\n the following:\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex b02e922dc..6e4867623 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -31,8 +31,8 @@ OPTIONS\n --no-decorate::\n --decorate[=short|full|auto|no]::\n \tPrint out the ref names of any commits that are shown. If 'short' is\n-\tspecified, the ref name prefixes 'refs/heads/', 'refs/tags/' and\n-\t'refs/remotes/' will not be printed. If 'full' is specified, the\n+\tspecified, the ref name prefixes `refs/heads/`, `refs/tags/` and\n+\t`refs/remotes/` will not be printed. If 'full' is specified, the\n \tfull ref name (including prefix) will be printed. If 'auto' is\n \tspecified, then if the output is going to a terminal, the ref names\n \tare shown as if 'short' were given, otherwise no ref names are\ndiff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt\nindex 9dee7bef3..a7515714d 100644\n--- a/Documentation/git-ls-tree.txt\n+++ b/Documentation/git-ls-tree.txt\n@@ -27,9 +27,9 @@ in the current working directory.  Note that:\n    taken as relative to the current working directory.  E.g. when you are\n    in a directory 'sub' that has a directory 'dir', you can run 'git\n    ls-tree -r HEAD dir' to list the contents of the tree (that is\n-   'sub/dir' in `HEAD`).  You don't want to give a tree that is not at the\n+   `sub/dir` in `HEAD`).  You don't want to give a tree that is not at the\n    root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that\n-   would result in asking for 'sub/sub/dir' in the `HEAD` commit.\n+   would result in asking for `sub/sub/dir` in the `HEAD` commit.\n    However, the current working directory can be ignored by passing\n    --full-tree option.\n \ndiff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt\nindex 3494a1db3..88d7338d0 100644\n--- a/Documentation/git-p4.txt\n+++ b/Documentation/git-p4.txt\n@@ -74,7 +74,7 @@ This:\n 1. Creates an empty Git repository in a subdirectory called 'project'.\n +\n 2. Imports the full contents of the head revision from the given p4\n-   depot path into a single commit in the Git branch 'refs/remotes/p4/master'.\n+   depot path into a single commit in the Git branch `refs/remotes/p4/master`.\n +\n 3. Creates a local branch, 'master' from this remote and checks it out.\n \n@@ -103,11 +103,11 @@ $ git init\n $ git p4 sync //path/in/your/perforce/depot\n ------------\n This imports the specified depot into\n-'refs/remotes/p4/master' in an existing Git repository.  The\n+`refs/remotes/p4/master` in an existing Git repository.  The\n `--branch` option can be used to specify a different branch to\n be used for the p4 content.\n \n-If a Git repository includes branches 'refs/remotes/origin/p4', these\n+If a Git repository includes branches `refs/remotes/origin/p4`, these\n will be fetched and consulted first during a 'git p4 sync'.  Since\n importing directly from p4 is considerably slower than pulling changes\n from a Git remote, this can be useful in a multi-developer environment.\n@@ -139,7 +139,7 @@ variable 'git-p4.client'.  The p4 client must exist, but the client root\n will be created and populated if it does not already exist.\n \n To submit all changes that are in the current Git branch but not in\n-the 'p4/master' branch, use:\n+the `p4/master` branch, use:\n ------------\n $ git p4 submit\n ------------\n@@ -155,7 +155,7 @@ $ git p4 submit --commit <sha1>\n $ git p4 submit --commit <sha1..sha1>\n ------------\n \n-The upstream reference is generally 'refs/remotes/p4/master', but can\n+The upstream reference is generally `refs/remotes/p4/master`, but can\n be overridden using the `--origin=` command-line option.\n \n The p4 changes will be created as the user invoking 'git p4 submit'. The\n@@ -254,10 +254,10 @@ Git repository:\n \tImport labels from p4 into Git.\n \n --import-local::\n-\tBy default, p4 branches are stored in 'refs/remotes/p4/',\n+\tBy default, p4 branches are stored in `refs/remotes/p4/`,\n \twhere they will be treated as remote-tracking branches by\n \tlinkgit:git-branch[1] and other commands.  This option instead\n-\tputs p4 branches in 'refs/heads/p4/'.  Note that future\n+\tputs p4 branches in `refs/heads/p4/`.  Note that future\n \tsync operations must specify `--import-local` as well so that\n \tthey can find the p4 branches in refs/heads.\n \n@@ -281,9 +281,9 @@ Git repository:\n \tThe mapping of file names from the p4 depot path to Git, by\n \tdefault, involves removing the entire depot path.  With this\n \toption, the full p4 depot path is retained in Git.  For example,\n-\tpath '//depot/main/foo/bar.c', when imported from\n-\t'//depot/main/', becomes 'foo/bar.c'.  With `--keep-path`, the\n-\tGit path is instead 'depot/main/foo/bar.c'.\n+\tpath `//depot/main/foo/bar.c`, when imported from\n+\t`//depot/main/`, becomes `foo/bar.c`.  With `--keep-path`, the\n+\tGit path is instead `depot/main/foo/bar.c`.\n \n --use-client-spec::\n \tUse a client spec to find the list of interesting files in p4.\n@@ -483,8 +483,8 @@ Then this 'git p4 clone' command:\n ----\n git p4 clone --detect-branches //depot@all\n ----\n-produces a separate branch in 'refs/remotes/p4/' for //depot/main,\n-called 'master', and one for //depot/branch1 called 'depot/branch1'.\n+produces a separate branch in `refs/remotes/p4/` for //depot/main,\n+called 'master', and one for //depot/branch1 called `depot/branch1`.\n \n However, it is not necessary to create branches in p4 to be able to use\n them like branches.  Because it is difficult to infer branch\n@@ -552,7 +552,7 @@ Clone and sync variables\n git-p4.syncFromOrigin::\n \tBecause importing commits from other Git repositories is much faster\n \tthan importing them from p4, a mechanism exists to find p4 changes\n-\tfirst in Git remotes.  If branches exist under 'refs/remote/origin/p4',\n+\tfirst in Git remotes.  If branches exist under `refs/remote/origin/p4`,\n \tthose will be fetched and used when syncing from p4.  This\n \tvariable can be set to 'false' to disable this behavior.\n \ndiff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt\nindex 3fc5d9433..6ccffa1c1 100644\n--- a/Documentation/git-remote-ext.txt\n+++ b/Documentation/git-remote-ext.txt\n@@ -104,7 +104,7 @@ begins with `ext::`.  Examples:\n \tlink-level address).\n \n \"ext::git-server-alias foo %G/repo% with% spaces %Vfoo\"::\n-\tRepresents a repository with path '/repo with spaces' accessed\n+\tRepresents a repository with path `/repo with spaces` accessed\n \tusing the helper program \"git-server-alias foo\".  The hostname for\n \tthe remote server passed in the protocol stream will be \"foo\"\n \t(this allows multiple virtual Git servers to share a\ndiff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt\nindex 0cad37fb8..06cf486f7 100644\n--- a/Documentation/git-remote.txt\n+++ b/Documentation/git-remote.txt\n@@ -72,8 +72,8 @@ With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set\n up to point at remote's `<master>` branch. See also the set-head command.\n +\n When a fetch mirror is created with `--mirror=fetch`, the refs will not\n-be stored in the 'refs/remotes/' namespace, but rather everything in\n-'refs/' on the remote will be directly mirrored into 'refs/' in the\n+be stored in the `refs/remotes/` namespace, but rather everything in\n+`refs/` on the remote will be directly mirrored into 'refs/' in the\n local repository. This option only makes sense in bare repositories,\n because a fetch would overwrite any local commits.\n +\ndiff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt\nindex ab4d27192..ce7a3a636 100644\n--- a/Documentation/git-show-ref.txt\n+++ b/Documentation/git-show-ref.txt\n@@ -89,9 +89,9 @@ OPTIONS\n \n \tShow references matching one or more patterns. Patterns are matched from\n \tthe end of the full name, and only complete parts are matched, e.g.\n-\t'master' matches 'refs/heads/master', 'refs/remotes/origin/master',\n-\t'refs/tags/jedi/master' but not 'refs/heads/mymaster' or\n-\t'refs/remotes/master/jedi'.\n+\t'master' matches `refs/heads/master`, `refs/remotes/origin/master`,\n+\t`refs/tags/jedi/master` but not `refs/heads/mymaster` or\n+\t`refs/remotes/master/jedi`.\n \n OUTPUT\n ------\ndiff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt\nindex ba3c4df55..764bcf13e 100644\n--- a/Documentation/git-submodule.txt\n+++ b/Documentation/git-submodule.txt\n@@ -38,7 +38,7 @@ This may be either an absolute URL, or (if it begins with ./\n or ../), the location relative to the superproject's default remote\n repository (Please note that to specify a repository 'foo.git'\n which is located right next to a superproject 'bar.git', you'll\n-have to use '../foo.git' instead of './foo.git' - as one might expect\n+have to use `../foo.git` instead of `./foo.git` - as one might expect\n when following the rules for relative URLs - because the evaluation\n of relative URLs in Git is identical to that of relative directories).\n +\ndiff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt\nindex fd952a5ff..8d162b56c 100644\n--- a/Documentation/git-web--browse.txt\n+++ b/Documentation/git-web--browse.txt\n@@ -92,8 +92,8 @@ configuration variable, we launch 'kfmclient' to try to open the HTML\n man page on an already opened konqueror in a new tab if possible.\n \n For consistency, we also try such a trick if 'browser.konqueror.path' is\n-set to something like 'A_PATH_TO/konqueror'. That means we will try to\n-launch 'A_PATH_TO/kfmclient' instead.\n+set to something like `A_PATH_TO/konqueror`. That means we will try to\n+launch `A_PATH_TO/kfmclient` instead.\n \n If you really want to use 'konqueror', then you can use something like\n the following:\ndiff --git a/Documentation/gitk.txt b/Documentation/gitk.txt\nindex 244cd0149..1eabb0aaf 100644\n--- a/Documentation/gitk.txt\n+++ b/Documentation/gitk.txt\n@@ -168,12 +168,12 @@ Files\n -----\n User configuration and preferences are stored at:\n \n-* '$XDG_CONFIG_HOME/git/gitk' if it exists, otherwise\n-* '$HOME/.gitk' if it exists\n+* `$XDG_CONFIG_HOME/git/gitk` if it exists, otherwise\n+* `$HOME/.gitk` if it exists\n \n-If neither of the above exist then '$XDG_CONFIG_HOME/git/gitk' is created and\n+If neither of the above exist then `$XDG_CONFIG_HOME/git/gitk` is created and\n used by default. If '$XDG_CONFIG_HOME' is not set it defaults to\n-'$HOME/.config' in all cases.\n+`$HOME/.config` in all cases.\n \n History\n -------\ndiff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt\nindex 312b6f925..a66e95b70 100644\n--- a/Documentation/gitmodules.txt\n+++ b/Documentation/gitmodules.txt\n@@ -115,7 +115,7 @@ Consider the following .gitmodules file:\n \n \n This defines two submodules, `libfoo` and `libbar`. These are expected to\n-be checked out in the paths 'include/foo' and 'include/bar', and for both\n+be checked out in the paths `include/foo` and `include/bar`, and for both\n submodules a URL is specified which can be used for cloning the submodules.\n \n SEE ALSO\ndiff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt\nindex 366dee238..216b11ee8 100644\n--- a/Documentation/gitrepository-layout.txt\n+++ b/Documentation/gitrepository-layout.txt\n@@ -84,7 +84,7 @@ objects/info/alternates::\n \tto the object database, not to the repository!) in your\n \talternates file, but it will not work if you use absolute\n \tpaths unless the absolute path in filesystem and web URL\n-\tis the same. See also 'objects/info/http-alternates'.\n+\tis the same. See also `objects/info/http-alternates`.\n \n objects/info/http-alternates::\n \tThis file records URLs to alternate object stores that\ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex 242de31cb..f87eaa46e 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -109,7 +109,7 @@ summary of the situation with 'git status':\n $ git status\n On branch master\n Changes to be committed:\n-Your branch is up to date with 'origin/master'.\n+Your branch is up to date with `origin/master`.\n   (use \"git reset HEAD <file>...\" to unstage)\n \n \tmodified:   file1\ndiff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt\nindex 92535dbac..18e1b6ad4 100644\n--- a/Documentation/gitweb.conf.txt\n+++ b/Documentation/gitweb.conf.txt\n@@ -50,11 +50,11 @@ following order:\n  * built-in values (some set during build stage),\n \n  * common system-wide configuration file (defaults to\n-   '/etc/gitweb-common.conf'),\n+   `/etc/gitweb-common.conf`),\n \n  * either per-instance configuration file (defaults to 'gitweb_config.perl'\n    in the same directory as the installed gitweb), or if it does not exists\n-   then fallback system-wide configuration file (defaults to '/etc/gitweb.conf').\n+   then fallback system-wide configuration file (defaults to `/etc/gitweb.conf`).\n \n Values obtained in later configuration files override values obtained earlier\n in the above sequence.\n@@ -82,7 +82,7 @@ You can include other configuration file using read_config_file()\n subroutine.  For example, one might want to put gitweb configuration\n related to access control for viewing repositories via Gitolite (one\n of Git repository management tools) in a separate file, e.g. in\n-'/etc/gitweb-gitolite.conf'.  To include it, put\n+`/etc/gitweb-gitolite.conf`.  To include it, put\n \n --------------------------------------------------\n read_config_file(\"/etc/gitweb-gitolite.conf\");\n@@ -142,7 +142,7 @@ and its path_info based equivalent\n http://git.example.com/gitweb.cgi/foo/bar.git\n ------------------------------------------------\n +\n-will map to the path '/srv/git/foo/bar.git' on the filesystem.\n+will map to the path `/srv/git/foo/bar.git` on the filesystem.\n \n $projects_list::\n \tName of a plain text file listing projects, or a name of directory\n@@ -234,9 +234,9 @@ $GIT::\n \n $mimetypes_file::\n \tFile to use for (filename extension based) guessing of MIME types before\n-\ttrying '/etc/mime.types'.  *NOTE* that this path, if relative, is taken\n+\ttrying `/etc/mime.types`.  *NOTE* that this path, if relative, is taken\n \tas relative to the current Git repository, not to CGI script.  If unset,\n-\tonly '/etc/mime.types' is used (if present on filesystem).  If no mimetypes\n+\tonly `/etc/mime.types` is used (if present on filesystem).  If no mimetypes\n \tfile is found, mimetype guessing based on extension of file is disabled.\n \tUnset by default.\n \n@@ -297,8 +297,8 @@ relative to base URI of gitweb.\n +\n This list should contain the URI of gitweb's standard stylesheet.  The default\n URI of gitweb stylesheet can be set at build time using the `GITWEB_CSS`\n-makefile variable.  Its default value is 'static/gitweb.css'\n-(or 'static/gitweb.min.css' if the `CSSMIN` variable is defined,\n+makefile variable.  Its default value is `static/gitweb.css`\n+(or `static/gitweb.min.css` if the `CSSMIN` variable is defined,\n i.e. if CSS minifier is used during build).\n +\n *Note*: there is also a legacy `$stylesheet` configuration variable, which was\n@@ -311,7 +311,7 @@ $logo::\n \tis displayed in the top right corner of each gitweb page and used as\n \ta logo for the Atom feed.  Relative to the base URI of gitweb (as a path).\n \tCan be adjusted when building gitweb using `GITWEB_LOGO` variable\n-\tBy default set to 'static/git-logo.png'.\n+\tBy default set to `static/git-logo.png`.\n \n $favicon::\n \tPoints to the location where you put 'git-favicon.png' on your web\n@@ -320,7 +320,7 @@ $favicon::\n \tmay display them in the browser's URL bar and next to the site name in\n \tbookmarks.  Relative to the base URI of gitweb.  Can be adjusted at\n \tbuild time using `GITWEB_FAVICON` variable.\n-\tBy default set to 'static/git-favicon.png'.\n+\tBy default set to `static/git-favicon.png`.\n \n $javascript::\n \tPoints to the location where you put 'gitweb.js' on your web server,\n@@ -328,7 +328,7 @@ $javascript::\n \tRelative to the base URI of gitweb.  Can be set at build time using\n \tthe `GITWEB_JS` build-time configuration variable.\n +\n-The default value is either 'static/gitweb.js', or 'static/gitweb.min.js' if\n+The default value is either `static/gitweb.js`, or `static/gitweb.min.js` if\n the `JSMIN` build variable was defined, i.e. if JavaScript minifier was used\n at build time.  *Note* that this single file is generated from multiple\n individual JavaScript \"modules\".\n@@ -444,7 +444,7 @@ $default_blob_plain_mimetype::\n \tdoesn't result in some other type; by default \"text/plain\".\n \tGitweb guesses mimetype of a file to display based on extension\n \tof its filename, using `$mimetypes_file` (if set and file exists)\n-\tand '/etc/mime.types' files (see *mime.types*(5) manpage; only\n+\tand `/etc/mime.types` files (see *mime.types*(5) manpage; only\n \tfilename extension rules are supported by gitweb).\n \n $default_text_plain_charset::\n@@ -486,7 +486,7 @@ affects how \"summary\" pages look like, or load limiting).\n \t(for example one for `git://` protocol, and one for `http://`\n \tprotocol).\n +\n-Note that per repository configuration can be set in '$GIT_DIR/cloneurl'\n+Note that per repository configuration can be set in `$GIT_DIR/cloneurl`\n file, or as values of multi-value `gitweb.url` configuration variable in\n project config.  Per-repository configuration takes precedence over value\n composed from `@git_base_url_list` elements and project name.\n@@ -520,7 +520,7 @@ $maxload::\n \tIf the server load exceeds this value then gitweb will return\n \t\"503 Service Unavailable\" error.  The server load is taken to be 0\n \tif gitweb cannot determine its value.  Currently it works only on Linux,\n-\twhere it uses '/proc/loadavg'; the load there is the number of active\n+\twhere it uses `/proc/loadavg`; the load there is the number of active\n \ttasks on the system -- processes that are actually running -- averaged\n \tover the last minute.\n +\n@@ -739,7 +739,7 @@ Currently available providers are *\"gravatar\"* and *\"picon\"*.\n Only one provider at a time can be selected ('default' is one element list).\n If an unknown provider is specified, the feature is disabled.\n *Note* that some providers might require extra Perl packages to be\n-installed; see 'gitweb/INSTALL' for more details.\n+installed; see `gitweb/INSTALL` for more details.\n +\n This feature can be configured on a per-repository basis via\n repository's `gitweb.avatar` configuration variable.\ndiff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt\nindex 88450589a..e350b0556 100644\n--- a/Documentation/gitweb.txt\n+++ b/Documentation/gitweb.txt\n@@ -36,7 +36,7 @@ browsed using gitweb itself.\n CONFIGURATION\n -------------\n Various aspects of gitweb's behavior can be controlled through the configuration\n-file 'gitweb_config.perl' or '/etc/gitweb.conf'.  See the linkgit:gitweb.conf[5]\n+file `gitweb_config.perl` or `/etc/gitweb.conf`.  See the linkgit:gitweb.conf[5]\n for details.\n \n Repositories\n@@ -48,10 +48,10 @@ repository root, i.e. be all under a single parent repository (but see also\n projects' root\" subsection).\n \n -----------------------------------------------------------------------\n-our $projectroot = '/path/to/parent/directory';\n+our $projectroot = `/path/to/parent/directory`;\n -----------------------------------------------------------------------\n \n-The default value for `$projectroot` is '/pub/git'.  You can change it during\n+The default value for `$projectroot` is `/pub/git`.  You can change it during\n building gitweb via `GITWEB_PROJECTROOT` build configuration variable.\n \n By default all Git repositories under `$projectroot` are visible and available\n@@ -231,7 +231,7 @@ Unnamed repository; edit this file to name it for gitweb.\n -------------------------------------------------------------------------------\n +\n from the template during repository creation, usually installed in\n-'/usr/share/git-core/templates/'.  You can use the `gitweb.description` repo\n+`/usr/share/git-core/templates/`.  You can use the `gitweb.description` repo\n configuration variable, but the file takes precedence.\n \n category (or `gitweb.category`)::\n@@ -407,7 +407,7 @@ in the instructions so they can be included in a future release.\n Apache as CGI\n ~~~~~~~~~~~~~\n Apache must be configured to support CGI scripts in the directory in\n-which gitweb is installed.  Let's assume that it is '/var/www/cgi-bin'\n+which gitweb is installed.  Let's assume that it is `/var/www/cgi-bin`\n directory.\n \n -----------------------------------------------------------------------\n@@ -431,7 +431,7 @@ You can use mod_perl with gitweb.  You must install Apache::Registry\n (for mod_perl 1.x) or ModPerl::Registry (for mod_perl 2.x) to enable\n this support.\n \n-Assuming that gitweb is installed to '/var/www/perl', the following\n+Assuming that gitweb is installed to `/var/www/perl`, the following\n Apache configuration (for mod_perl 2.x) is suitable.\n \n -----------------------------------------------------------------------\n@@ -456,7 +456,7 @@ Apache with FastCGI\n ~~~~~~~~~~~~~~~~~~~\n Gitweb works with Apache and FastCGI.  First you need to rename, copy\n or symlink gitweb.cgi to gitweb.fcgi.  Let's assume that gitweb is\n-installed in '/usr/share/gitweb' directory.  The following Apache\n+installed in `/usr/share/gitweb` directory.  The following Apache\n configuration is suitable (UNTESTED!)\n \n -----------------------------------------------------------------------\n@@ -503,22 +503,22 @@ repositories, you can configure Apache like this:\n -----------------------------------------------------------------------\n \n The above configuration expects your public repositories to live under\n-'/pub/git' and will serve them as `http://git.domain.org/dir-under-pub-git`,\n+`/pub/git` and will serve them as `http://git.domain.org/dir-under-pub-git`,\n both as clonable Git URL and as browseable gitweb interface.  If you then\n start your linkgit:git-daemon[1] with `--base-path=/pub/git --export-all`\n then you can even use the `git://` URL with exactly the same path.\n \n Setting the environment variable `GITWEB_CONFIG` will tell gitweb to use the\n-named file (i.e. in this example '/etc/gitweb.conf') as a configuration for\n+named file (i.e. in this example `/etc/gitweb.conf`) as a configuration for\n gitweb.  You don't really need it in above example; it is required only if\n your configuration file is in different place than built-in (during\n-compiling gitweb) 'gitweb_config.perl' or '/etc/gitweb.conf'.  See\n+compiling gitweb) 'gitweb_config.perl' or `/etc/gitweb.conf`.  See\n linkgit:gitweb.conf[5] for details, especially information about precedence\n rules.\n \n If you use the rewrite rules from the example you *might* also need\n something like the following in your gitweb configuration file\n-('/etc/gitweb.conf' following example):\n+(`/etc/gitweb.conf` following example):\n ----------------------------------------------------------------------------\n @stylesheets = (\"/some/absolute/path/gitweb.css\");\n $my_uri    = \"/\";\n@@ -575,7 +575,7 @@ like this:\n \n Here actual project root is passed to gitweb via `GITWEB_PROJECT_ROOT`\n environment variable from a web server, so you need to put the following\n-line in gitweb configuration file ('/etc/gitweb.conf' in above example):\n+line in gitweb configuration file (`/etc/gitweb.conf` in above example):\n --------------------------------------------------------------------------\n $projectroot = $ENV{'GITWEB_PROJECTROOT'} || \"/pub/git\";\n --------------------------------------------------------------------------\n@@ -585,7 +585,7 @@ referenced by `$per_request_config`;\n \n These configurations enable two things. First, each unix user (`<user>`) of\n the server will be able to browse through gitweb Git repositories found in\n-'~/public_git/' with the following url:\n+`~/public_git/` with the following url:\n \n   http://git.example.org/~<user>/\n \n@@ -596,7 +596,7 @@ If you already use `mod_userdir` in your virtual host or you don't want to\n use the \\'~' as first character, just comment or remove the second rewrite\n rule, and uncomment one of the following according to what you want.\n \n-Second, repositories found in '/pub/scm/' and '/var/git/' will be accessible\n+Second, repositories found in `/pub/scm/` and `/var/git/` will be accessible\n through `http://git.example.org/scm/` and `http://git.example.org/var/`.\n You can add as many project roots as you want by adding rewrite rules like\n the third and the fourth.\n@@ -614,7 +614,7 @@ that it consumes and produces URLs in the form\n   http://git.example.com/project.git/shortlog/sometag\n \n i.e. without 'gitweb.cgi' part, by using a configuration such as the\n-following.  This configuration assumes that '/var/www/gitweb' is the\n+following.  This configuration assumes that `/var/www/gitweb` is the\n DocumentRoot of your webserver, contains the gitweb.cgi script and\n complementary static files (stylesheet, favicon, JavaScript):\n \n@@ -645,9 +645,9 @@ parameter.\n `@stylesheets`, `$my_uri` and `$home_link`, but you lose \"dumb client\"\n access to your project .git dirs (described in \"Single URL for gitweb and\n for fetching\" section).  A possible workaround for the latter is the\n-following: in your project root dir (e.g. '/pub/git') have the projects\n-named *without* a .git extension (e.g. '/pub/git/project' instead of\n-'/pub/git/project.git') and configure Apache as follows:\n+following: in your project root dir (e.g. `/pub/git`) have the projects\n+named *without* a .git extension (e.g. `/pub/git/project` instead of\n+`/pub/git/project.git`) and configure Apache as follows:\n ----------------------------------------------------------------------------\n <VirtualHost *:80>\n \tServerAlias git.example.com\n@@ -681,7 +681,7 @@ cloned), while\n will provide human-friendly gitweb access.\n \n This solution is not 100% bulletproof, in the sense that if some project has\n-a named ref (branch, tag) starting with 'git/', then paths such as\n+a named ref (branch, tag) starting with `git/`, then paths such as\n \n   http://git.example.com/project/command/abranch..git/abranch\n \n@@ -697,7 +697,7 @@ SEE ALSO\n --------\n linkgit:gitweb.conf[5], linkgit:git-instaweb[1]\n \n-'gitweb/README', 'gitweb/INSTALL'\n+`gitweb/README`, `gitweb/INSTALL`\n \n GIT\n ---\ndiff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt\nindex 023ca95e7..9848d0d84 100644\n--- a/Documentation/glossary-content.txt\n+++ b/Documentation/glossary-content.txt\n@@ -524,7 +524,7 @@ The most notable example is `HEAD`.\n [[def_remote_tracking_branch]]remote-tracking branch::\n \tA <<def_ref,ref>> that is used to follow changes from another\n \t<<def_repository,repository>>. It typically looks like\n-\t'refs/remotes/foo/bar' (indicating that it tracks a branch named\n+\t`refs/remotes/foo/bar` (indicating that it tracks a branch named\n \t'bar' in a remote named 'foo'), and matches the right-hand-side of\n \ta configured fetch <<def_refspec,refspec>>. A remote-tracking\n \tbranch should not contain direct modifications or have local\n@@ -654,7 +654,7 @@ The most notable example is `HEAD`.\n \tThe default <<def_branch,branch>> that is merged into the branch in\n \tquestion (or the branch in question is rebased onto). It is configured\n \tvia branch.<name>.remote and branch.<name>.merge. If the upstream branch\n-\tof 'A' is 'origin/B' sometimes we say \"'A' is tracking 'origin/B'\".\n+\tof 'A' is `origin/B` sometimes we say \"'A' is tracking `origin/B`\".\n \n [[def_working_tree]]working tree::\n \tThe tree of actual checked out files.  The working tree normally\ndiff --git a/Documentation/howto/maintain-git.txt b/Documentation/howto/maintain-git.txt\nindex ca4378740..2d76e2916 100644\n--- a/Documentation/howto/maintain-git.txt\n+++ b/Documentation/howto/maintain-git.txt\n@@ -348,7 +348,7 @@ Some observations to be made.\n  * A topic already in 'next' can get fixes while still in\n    'next'.  Such a topic will have many merges to 'next' (in\n    other words, \"git log --first-parent next\" will show many\n-   \"Merge branch 'ai/topic' to next\" for the same topic.\n+   \"Merge branch `ai/topic` to next\" for the same topic.\n \n  * An unobvious fix for 'maint' is cooked in 'next' and then\n    merged to 'master' to make extra sure it is Ok and then\ndiff --git a/Documentation/howto/setup-git-server-over-http.txt b/Documentation/howto/setup-git-server-over-http.txt\nindex f44e5e945..bfe6f9b50 100644\n--- a/Documentation/howto/setup-git-server-over-http.txt\n+++ b/Documentation/howto/setup-git-server-over-http.txt\n@@ -244,8 +244,8 @@ Using a proxy:\n --------------\n \n If you have to access the WebDAV server from behind an HTTP(S) proxy,\n-set the variable 'all_proxy' to 'http://proxy-host.com:port', or\n-'http://login-on-proxy:passwd-on-proxy@proxy-host.com:port'. See 'man\n+set the variable 'all_proxy' to `http://proxy-host.com:port`, or\n+`http://login-on-proxy:passwd-on-proxy@proxy-host.com:port`. See 'man\n curl' for details.\n \n \ndiff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt\nindex 63a3fc095..e28f2dd64 100644\n--- a/Documentation/merge-options.txt\n+++ b/Documentation/merge-options.txt\n@@ -36,7 +36,7 @@ set to `no` at the beginning of them.\n \tCreate a merge commit even when the merge resolves as a\n \tfast-forward.  This is the default behaviour when merging an\n \tannotated (and possibly signed) tag that is not stored in\n-\tits natural place in 'refs/tags/' hierarchy.\n+\tits natural place in `refs/tags/` hierarchy.\n \n --ff-only::\n \tRefuse to merge and exit with a non-zero status unless the\ndiff --git a/Documentation/revisions.txt b/Documentation/revisions.txt\nindex 72daa20e7..92b1d5638 100644\n--- a/Documentation/revisions.txt\n+++ b/Documentation/revisions.txt\n@@ -23,27 +23,27 @@ characters and to avoid word splitting.\n   followed by a dash and a number of commits, followed by a dash, a\n   'g', and an abbreviated object name.\n \n-'<refname>', e.g. 'master', 'heads/master', 'refs/heads/master'::\n+'<refname>', e.g. 'master', `heads/master`, `refs/heads/master`::\n   A symbolic ref name.  E.g. 'master' typically means the commit\n-  object referenced by 'refs/heads/master'.  If you\n-  happen to have both 'heads/master' and 'tags/master', you can\n-  explicitly say 'heads/master' to tell Git which one you mean.\n+  object referenced by `refs/heads/master`.  If you\n+  happen to have both `heads/master` and `tags/master`, you can\n+  explicitly say `heads/master` to tell Git which one you mean.\n   When ambiguous, a '<refname>' is disambiguated by taking the\n   first match in the following rules:\n \n-  . If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually\n+  . If `$GIT_DIR/<refname>` exists, that is what you mean (this is usually\n     useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`\n     and `CHERRY_PICK_HEAD`);\n \n-  . otherwise, 'refs/<refname>' if it exists;\n+  . otherwise, `refs/<refname>` if it exists;\n \n-  . otherwise, 'refs/tags/<refname>' if it exists;\n+  . otherwise, `refs/tags/<refname>` if it exists;\n \n-  . otherwise, 'refs/heads/<refname>' if it exists;\n+  . otherwise, `refs/heads/<refname>` if it exists;\n \n-  . otherwise, 'refs/remotes/<refname>' if it exists;\n+  . otherwise, `refs/remotes/<refname>` if it exists;\n \n-  . otherwise, 'refs/remotes/<refname>/HEAD' if it exists.\n+  . otherwise, `refs/remotes/<refname>/HEAD` if it exists.\n +\n `HEAD` names the commit on which you based the changes in the working tree.\n `FETCH_HEAD` records the branch which you fetched from a remote repository\n@@ -57,8 +57,8 @@ when you run `git merge`.\n `CHERRY_PICK_HEAD` records the commit which you are cherry-picking\n when you run `git cherry-pick`.\n +\n-Note that any of the 'refs/*' cases above may come either from\n-the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.\n+Note that any of the `refs/*` cases above may come either from\n+the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.\n While the ref name encoding is unspecified, UTF-8 is preferred as\n some output processing may assume ref names in UTF-8.\n \n@@ -108,7 +108,7 @@ some output processing may assume ref names in UTF-8.\n   `git push` were run while `branchname` was checked out (or the current\n   `HEAD` if no branchname is specified). Since our push destination is\n   in a remote repository, of course, we report the local tracking branch\n-  that corresponds to that branch (i.e., something in 'refs/remotes/').\n+  that corresponds to that branch (i.e., something in `refs/remotes/`).\n +\n Here's an example to make it more clear:\n +\ndiff --git a/Documentation/sequencer.txt b/Documentation/sequencer.txt\nindex 5747f442f..5a57c4a40 100644\n--- a/Documentation/sequencer.txt\n+++ b/Documentation/sequencer.txt\n@@ -1,6 +1,6 @@\n --continue::\n \tContinue the operation in progress using the information in\n-\t'.git/sequencer'.  Can be used to continue after resolving\n+\t`.git/sequencer`.  Can be used to continue after resolving\n \tconflicts in a failed cherry-pick or revert.\n \n --quit::\ndiff --git a/Documentation/technical/pack-protocol.txt b/Documentation/technical/pack-protocol.txt\nindex 7a2375a55..bbc984235 100644\n--- a/Documentation/technical/pack-protocol.txt\n+++ b/Documentation/technical/pack-protocol.txt\n@@ -107,7 +107,7 @@ Initiating the upload-pack or receive-pack processes over SSH is\n executing the binary on the server via SSH remote execution.\n It is basically equivalent to running this:\n \n-   $ ssh git.example.com \"git-upload-pack '/project.git'\"\n+   $ ssh git.example.com \"git-upload-pack `/project.git`\"\n \n For a server to support Git pushing and pulling for a given user over\n SSH, that user needs to be able to execute one or both of those\n-- \n2.11.0\n\n\n"},{"id":"369323","messageId":"CAPig+cSkpUCm0=TZ-T2Lv5F0bxhGhyMMS6Nxj42JFbNupgpf0A@mail.gmail.com","threadId":"50507","inReplyTo":"20190214163043.7103-1-corentin.bompard@etu.univ-lyon1.fr","subject":"Re: [PATCH] doc: format pathnames and URLs as monospace","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2019-02-14T19:04:23Z","receivedAt":"2019-02-14T19:04:34Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Thu, Feb 14, 2019 at 11:32 AM Corentin BOMPARD\n<corentin.bompard@etu.univ-lyon1.fr> wrote:\n> diff --git a/Documentation/technical/pack-protocol.txt b/Documentation/technical/pack-protocol.txt\n> @@ -107,7 +107,7 @@ Initiating the upload-pack or receive-pack processes over SSH is\n>  It is basically equivalent to running this:\n>\n> -   $ ssh git.example.com \"git-upload-pack '/project.git'\"\n> +   $ ssh git.example.com \"git-upload-pack `/project.git`\"\n\nThis is already formatted as literal text using a monospaced font.\nMore importantly, however, it is meant as a literal example of what a\nuser would type, so changing the quoting is undesirable since doing so\nactually changes the meaning of the command. Therefore this should be\ndropped.\n\nAlso, there are several other instances of this example command just\nbelow this one which you didn't change. It's not clear why this one\nwas singled out.\n"},{"id":"369340","messageId":"xmqq4l9685ia.fsf@gitster-ct.c.googlers.com","threadId":"50507","inReplyTo":"20190214163043.7103-1-corentin.bompard@etu.univ-lyon1.fr","subject":"Re: [PATCH] doc: format pathnames and URLs as monospace","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-02-14T20:44:13Z","receivedAt":"2019-02-14T20:44:19Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr> writes:\n\n> diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt\n> index c4118fa19..8ba92f274 100644\n> --- a/Documentation/config/checkout.txt\n> +++ b/Documentation/config/checkout.txt\n> @@ -1,7 +1,7 @@\n>  checkout.defaultRemote::\n>  \tWhen you run 'git checkout <something>' and only have one\n>  \tremote, it may implicitly fall back on checking out and\n> -\ttracking e.g. 'origin/<something>'. This stops working as soon\n> +\ttracking e.g. `origin/<something>`. This stops working as soon\n\nAre you doing only pathnames and URLs, or are you also doing refnames?\n\nI am not sure if \"this is a pathname, or a URL or a refname, so it\nmust be typeset with monospace\" is the direction we'd want to go in\nin the first place.  One rule we tried to follow (but with minor\ninconsistencies everywhere, apparently we are not doing a very good\njob at) is \"this is a string the user would literally type or see\nwhen following this description, so it must be typeset with\nmonospace\".\n\nFrom that point of view, we'd want the `git checkout <something>` we\nsee in the introductory sentence of this paragraph also typeset in\nmono.  In order to match (i.e. to make it clear that the <something>\npart came from what the user typed), the change in this hunk your\npatch makes does make sense.\n\n> diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt\n> index f98b7c6ed..6643bc39f 100644\n> --- a/Documentation/git-cvsserver.txt\n> +++ b/Documentation/git-cvsserver.txt\n> @@ -140,7 +140,7 @@ CVS_SERVER directly in CVSROOT like\n>  ------\n>  cvs -d \":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git\" co <HEAD_name>\n>  ------\n> -This has the advantage that it will be saved in your 'CVS/Root' files and\n> +This has the advantage that it will be saved in your `CVS/Root` files and\n>  you don't need to worry about always setting the correct environment\n>  variable.  SSH users restricted to 'git-shell' don't need to override the default\n>  with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean\n\nI am using this hunk as just an example, but \"this is what the user\nliterally sees or types\" point-of-view, `CVS/Root` and `CVS_SERVER`\nin the hunk fall into the same category.  They are both literals in\nthe sense that you cannot say \"I do not like the words Root or\nSERVER, so in my CVS repository I am using CVS/Leaf and CVS_HELPER\ninstead\".\n\n> @@ -179,7 +179,7 @@ allowing access over SSH.\n>  ------\n>  --\n>  3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,\n> -   automatically saving it in your 'CVS/Root' files, then you need to set them\n> +   automatically saving it in your `CVS/Root` files, then you need to set them\n>     explicitly in your environment.  CVSROOT should be set as per normal, but the\n>     directory should point at the appropriate Git repo.  As above, for SSH clients\n>     _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.\n\nEven if you are doing only pathnames and URLs, `git-shell` and\n`git-cvsserver` would be candidates to be in monospace, as they are\nnames in $GIT_EXEC_PATH/.\n\n> diff --git a/Documentation/technical/pack-protocol.txt b/Documentation/technical/pack-protocol.txt\n> index 7a2375a55..bbc984235 100644\n> --- a/Documentation/technical/pack-protocol.txt\n> +++ b/Documentation/technical/pack-protocol.txt\n> @@ -107,7 +107,7 @@ Initiating the upload-pack or receive-pack processes over SSH is\n>  executing the binary on the server via SSH remote execution.\n>  It is basically equivalent to running this:\n>  \n> -   $ ssh git.example.com \"git-upload-pack '/project.git'\"\n> +   $ ssh git.example.com \"git-upload-pack `/project.git`\"\n>  \n>  For a server to support Git pushing and pulling for a given user over\n>  SSH, that user needs to be able to execute one or both of those\n\nI agree with Eric's comment.  If the user types `/project.git`, it\nwould give a funny result ;-).\n"},{"id":"369763","messageId":"1550742866944.14637@etu.univ-lyon1.fr","threadId":"50507","inReplyTo":"xmqq4l9685ia.fsf@gitster-ct.c.googlers.com","subject":"RE: [PATCH] doc: format pathnames and URLs as monospace","fromName":"BOMPARD CORENTIN p1603631","fromEmail":"corentin.bompard@etu.univ-lyon1.fr","sentAt":"2019-02-21T09:54:27Z","receivedAt":"2019-02-21T09:54:34Z","isPatch":true,"sender":{"key":"corentin.bompard@etu.univ-lyon1.fr","avatar":"https://avatars.githubusercontent.com/u/23448477?v=4"},"body":">>Corentin BOMPARD <corentin.bompard@etu.univ-lyon1.fr> writes:\n>>\n>> diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt\n>> index c4118fa19..8ba92f274 100644\n>> --- a/Documentation/config/checkout.txt\n>> +++ b/Documentation/config/checkout.txt\n>> @@ -1,7 +1,7 @@\n>>  checkout.defaultRemote::\n>>  \tWhen you run 'git checkout <something>' and only have one\n>>  \tremote, it may implicitly fall back on checking out and\n>> -\ttracking e.g. 'origin/<something>'. This stops working as soon\n>> +\ttracking e.g. `origin/<something>`. This stops working as soon\n>\n>Are you doing only pathnames and URLs, or are you also doing refnames?\n>\n>I am not sure if \"this is a pathname, or a URL or a refname, so it\n>must be typeset with monospace\" is the direction we'd want to go in\n>in the first place.  One rule we tried to follow (but with minor\n>inconsistencies everywhere, apparently we are not doing a very good\n>job at) is \"this is a string the user would literally type or see\n>when following this description, so it must be typeset with\n>monospace\".\n>\n>From that point of view, we'd want the `git checkout <something>` we\n>see in the introductory sentence of this paragraph also typeset in\n>mono.  In order to match (i.e. to make it clear that the <something>\n>part came from what the user typed), the change in this hunk your\n>patch makes does make sense.\n>\n>> diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt\n>> index f98b7c6ed..6643bc39f 100644\n>> --- a/Documentation/git-cvsserver.txt\n>> +++ b/Documentation/git-cvsserver.txt\n>> @@ -140,7 +140,7 @@ CVS_SERVER directly in CVSROOT like\n>>  ------\n>>  cvs -d \":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git\" co <HEAD_name>\n>>  ------\n>> -This has the advantage that it will be saved in your 'CVS/Root' files and\n>> +This has the advantage that it will be saved in your `CVS/Root` files and\n>>  you don't need to worry about always setting the correct environment\n>>  variable.  SSH users restricted to 'git-shell' don't need to override the default\n>>  with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean\n>\n>I am using this hunk as just an example, but \"this is what the user\n>literally sees or types\" point-of-view, `CVS/Root` and `CVS_SERVER`\n>in the hunk fall into the same category.  They are both literals in\n>the sense that you cannot say \"I do not like the words Root or\n>SERVER, so in my CVS repository I am using CVS/Leaf and CVS_HELPER\n>instead\".\n>\n>> @@ -179,7 +179,7 @@ allowing access over SSH.\n>>  ------\n>>  --\n>>  3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,\n>> -   automatically saving it in your 'CVS/Root' files, then you need to set them\n>> +   automatically saving it in your `CVS/Root` files, then you need to set them\n>>     explicitly in your environment.  CVSROOT should be set as per normal, but the\n>>     directory should point at the appropriate Git repo.  As above, for SSH clients\n>>     _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.\n>\n>Even if you are doing only pathnames and URLs, `git-shell` and\n>`git-cvsserver` would be candidates to be in monospace, as they are\n>names in $GIT_EXEC_PATH/.\n>\n>> diff --git a/Documentation/technical/pack-protocol.txt b/Documentation/technical/pack-protocol.txt\n>> index 7a2375a55..bbc984235 100644\n>> --- a/Documentation/technical/pack-protocol.txt\n>> +++ b/Documentation/technical/pack-protocol.txt\n>> @@ -107,7 +107,7 @@ Initiating the upload-pack or receive-pack processes over SSH is\n>>  executing the binary on the server via SSH remote execution.\n>>  It is basically equivalent to running this:\n>>  \n>> -   $ ssh git.example.com \"git-upload-pack '/project.git'\"\n>> +   $ ssh git.example.com \"git-upload-pack `/project.git`\"\n>>  \n>>  For a server to support Git pushing and pulling for a given user over\n>>  SSH, that user needs to be able to execute one or both of those\n>\n>I agree with Eric's comment.  If the user types `/project.git`, it\n>would give a funny result ;-).\n\nHello thanks for your reply we will soon use your answer to rework our patch.\nCorentin BOMPARD, Nathan BERBEZIER, Pablo CHABANNE\n"}]}