{"thread":{"id":"50669","subject":"[PATCH 1/2 v3] doc/CodingGuidelines: URLs and paths as monospace.","startedAt":"2019-03-06T13:05:50Z","lastAt":"2019-03-13T09:53:57Z","messageCount":8,"participants":["Corentin BOMPARD","Matthieu Moy","Eric Sunshine","Andrei Rybak","Junio C Hamano"],"isPatch":true,"patchVersion":3,"patchTotal":2},"messages":[{"id":"370808","messageId":"20190306130446.2193-1-corentin.bompard@etu.univ-lyon1.fr","threadId":"50669","inReplyTo":null,"subject":"[PATCH 1/2 v3] doc/CodingGuidelines: URLs and paths as monospace.","fromName":"Corentin BOMPARD","fromEmail":"corentin.bompard@etu.univ-lyon1.fr","sentAt":"2019-03-06T13:04:45Z","receivedAt":"2019-03-06T13:05:50Z","isPatch":true,"sender":{"key":"corentin.bompard@etu.univ-lyon1.fr","avatar":"https://avatars.githubusercontent.com/u/23448477?v=4"},"body":"The current documentation uses both quotes (italics) and backquotes\n(monospace) to render URLs and pathnames, which is inconsistant.\nDocument a best practice in CodingGuidelines to help reduce\ninconsistencies in the futur.\n\nWe set the best practice to using backquotes, since:\n\n* It is already an established practice. For exemple:\n\n $ git grep \"'[^']/*[^']'\" | wc -l\n 206\n\n $ git grep '`[^`]/*[^`]`' | wc -l\n 690\n\n There are false on both sides, but after a cursory look at the\n output of both, It doesn't seem the false positive rate is really\n higher in the second case.\n\n At least, this shows that the existing documentation uses\n inconsistent formatting, and that it would be good to do\n something about it.\n\n* It may be debatable whether path names need to be typed in\n monospace but having them in italics is really unusual.\n\nSigned-off-by: Corentin BOMPARD \nSigned-off-by: Nathan BERBEZIER \nSigned-off-by: Pablo CHABANNE \nSigned-off-by: Matthieu MOY \n---\n Changes: According to Matthieu MOY we added a new guideline in\n Documentation/CodingGuidelines.txt about monospace.\n\n Documentation/CodingGuidelines | 7 +++++--\n 1 file changed, 5 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 857953071..0baff9dbe 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -580,11 +580,14 @@ Writing Documentation:\n or commands:\n \n Literal examples (e.g. use of command-line options, command names,\n- branch names, configuration and environment variables) must be\n- typeset in monospace (i.e. wrapped with backticks):\n+ branch names, URLs, pathnames (files and directories), configuration and\n+ environment variables) must be typeset in monospace (i.e. wrapped with \n+ backticks):\n `--pretty=oneline`\n `git rev-list`\n `remote.pushDefault`\n+ `http://git.example.com`\n+ `.git/config`\n `GIT_DIR`\n `HEAD`\n \n-- \n2.21.0-rc0\n\n"},{"id":"370809","messageId":"20190306130446.2193-2-corentin.bompard@etu.univ-lyon1.fr","threadId":"50669","inReplyTo":"20190306130446.2193-1-corentin.bompard@etu.univ-lyon1.fr","subject":"[PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Corentin BOMPARD","fromEmail":"corentin.bompard@etu.univ-lyon1.fr","sentAt":"2019-03-06T13:04:46Z","receivedAt":"2019-03-06T13:06:15Z","isPatch":true,"sender":{"key":"corentin.bompard@etu.univ-lyon1.fr","avatar":"https://avatars.githubusercontent.com/u/23448477?v=4"},"body":"Applying CodingGuidelines about monospace on pathnames and URLs.\n\nSee Documentation/CodingGuidelines.txt for more information.\n\nSigned-off-by: Corentin BOMPARD \nSigned-off-by: Nathan BERBEZIER \nSigned-off-by: Pablo CHABANNE \nSigned-off-by: Matthieu MOY \n---\n Changes: We listen to Matthieu MOY and Eric SUNSHINE's remarks about\n our mistakes on the last patch.\n\n Documentation/SubmittingPatches | 6 +--\n Documentation/config/core.txt | 14 +++----\n Documentation/git-daemon.txt | 2 +-\n Documentation/git-filter-branch.txt | 2 +-\n Documentation/git-help.txt | 4 +-\n Documentation/git-ls-tree.txt | 4 +-\n Documentation/git-remote-ext.txt | 2 +-\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/gitweb.conf.txt | 30 +++++++--------\n Documentation/gitweb.txt | 38 +++++++++----------\n .../howto/setup-git-server-over-http.txt | 4 +-\n Documentation/revisions.txt | 4 +-\n Documentation/sequencer.txt | 2 +-\n 17 files changed, 65 insertions(+), 65 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/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/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-filter-branch.txt b/Documentation/git-filter-branch.txt\nindex e6f08ab18..6b53dd7e0 100644\n--- a/Documentation/git-filter-branch.txt\n+++ b/Documentation/git-filter-branch.txt\n@@ -189,7 +189,7 @@ to other tags will be rewritten to point to the underlying commit.\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::\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-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-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-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/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..c7436098c 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@@ -51,7 +51,7 @@ projects' root\" subsection).\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 (``) 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/~/\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 \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/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/revisions.txt b/Documentation/revisions.txt\nindex 72daa20e7..2337a995e 100644\n--- a/Documentation/revisions.txt\n+++ b/Documentation/revisions.txt\n@@ -58,7 +58,7 @@ when you run `git merge`.\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+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::\n-- \n2.21.0-rc0\n\n"},{"id":"371246","messageId":"86va0o9qsp.fsf@matthieu-moy.fr","threadId":"50669","inReplyTo":"20190306130446.2193-2-corentin.bompard@etu.univ-lyon1.fr","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Matthieu Moy","fromEmail":"git@matthieu-moy.fr","sentAt":"2019-03-12T13:16:06Z","receivedAt":"2019-03-12T13:16:10Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"Corentin BOMPARD writes:\n\n> Applying CodingGuidelines about monospace on pathnames and URLs.\n>\n> See Documentation/CodingGuidelines.txt for more information.\n>\n> Signed-off-by: Corentin BOMPARD \n> Signed-off-by: Nathan BERBEZIER \n> Signed-off-by: Pablo CHABANNE \n> Signed-off-by: Matthieu MOY \n> ---\n> Changes: We listen to Matthieu MOY and Eric SUNSHINE's remarks about\n> our mistakes on the last patch.\n\nThis addresses all my previous remarks, so this (patches 1 and 2) is now\n\nReviewed-by: Matthieu Moy \n\nI'm Cc-ing Eric in case he has anything more to say.\n\n-- \nMatthieu Moy\nhttps://matthieu-moy.fr/\n"},{"id":"371269","messageId":"CAPig+cQEYDay9kTUpBepw6kN_PgpG4dRXeNf82Kty+E7piXeWg@mail.gmail.com","threadId":"50669","inReplyTo":"86va0o9qsp.fsf@matthieu-moy.fr","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2019-03-12T15:48:14Z","receivedAt":"2019-03-12T15:48:28Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Mar 12, 2019 at 9:16 AM Matthieu Moy wrote:\n> Corentin BOMPARD writes:\n> > Changes: We listen to Matthieu MOY and Eric SUNSHINE's remarks about\n> > our mistakes on the last patch.\n>\n> This addresses all my previous remarks, so this (patches 1 and 2) is now\n>\n> Reviewed-by: Matthieu Moy \n>\n> I'm Cc-ing Eric in case he has anything more to say.\n\nThanks. A few comments:\n\nIn patch 1/2:\n\n* drop the full stop from the first line of the commit message\n\n* s/futur/future/ in the commit message\n\n* s/There are false/& positives/ in the commit message\n\n* s/both, It/both, it/\n\nIn patch 2/2, there's a 'man curl' which probably ought to be\nconverted to `man curl` (per paragraph updated by patch 1/2), but\nperhaps that's outside the scope of this patch series (though it would\nbe easy enough to do -- but not necessarily worth a re-roll). Nothing\nelse popped out at me while scanning the patch.\n"},{"id":"371281","messageId":"8a8944a6-9559-74be-afee-e6af262412ab@gmail.com","threadId":"50669","inReplyTo":"CAPig+cQEYDay9kTUpBepw6kN_PgpG4dRXeNf82Kty+E7piXeWg@mail.gmail.com","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Andrei Rybak","fromEmail":"rybak.a.v@gmail.com","sentAt":"2019-03-12T17:13:48Z","receivedAt":"2019-03-12T17:57:01Z","isPatch":true,"sender":{"key":"rybak.a.v@gmail.com","avatar":"https://avatars.githubusercontent.com/u/624072?v=4"},"body":"On 2019-03-12 16:48, Eric Sunshine wrote:\n> Thanks. A few comments:\n>\n> In patch 1/2:\n>\n> * drop the full stop from the first line of the commit message\n>\n> * s/futur/future/ in the commit message\n>\n> * s/There are false/& positives/ in the commit message\n>\n> * s/both, It/both, it/\n\nAlso,\n\n* s/inconsistant/inconsistent/ in the first paragraph of the commit message.\n"},{"id":"371323","messageId":"xmqq5zsnfrhk.fsf@gitster-ct.c.googlers.com","threadId":"50669","inReplyTo":"8a8944a6-9559-74be-afee-e6af262412ab@gmail.com","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2019-03-13T02:16:55Z","receivedAt":"2019-03-13T02:16:59Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Andrei Rybak writes:\n\n> On 2019-03-12 16:48, Eric Sunshine wrote:\n>> Thanks. A few comments:\n>>\n>> In patch 1/2:\n>>\n>> * drop the full stop from the first line of the commit message\n>>\n>> * s/futur/future/ in the commit message\n>>\n>> * s/There are false/& positives/ in the commit message\n>>\n>> * s/both, It/both, it/\n>\n> Also,\n>\n> * s/inconsistant/inconsistent/ in the first paragraph of the commit message.\n\nHere is what I have locally, with the above input, relative to what\nMatthieu reviewed.\n\nThanks, all.\n\n1: ed3eba5cc5 ! 1: 0dbd305fe7 doc/CodingGuidelines: URLs and paths as monospace.\n @@ -1,11 +1,11 @@\n Author: Corentin BOMPARD \n \n - doc/CodingGuidelines: URLs and paths as monospace.\n + doc/CodingGuidelines: URLs and paths as monospace\n \n The current documentation uses both quotes (italics) and backquotes\n - (monospace) to render URLs and pathnames, which is inconsistant.\n + (monospace) to render URLs and pathnames, which is inconsistent.\n Document a best practice in CodingGuidelines to help reduce\n - inconsistencies in the futur.\n + inconsistencies in the future.\n \n We set the best practice to using backquotes, since:\n \n @@ -17,8 +17,8 @@\n $ git grep '`[^`]/*[^`]`' | wc -l\n 690\n \n - There are false on both sides, but after a cursory look at the\n - output of both, It doesn't seem the false positive rate is really\n + There are false positives on both sides, but after a cursory look at\n + the output of both, it doesn't seem the false positive rate is really\n higher in the second case.\n \n At least, this shows that the existing documentation uses\n2: 38ffa25f88 = 2: 68ed71b53c doc: format pathnames and URLs as monospace.\n"},{"id":"371332","messageId":"CAPig+cTxH9_mDwMdiRui5Lx7cmwg0K2PT2Cvj4YTn2gCg8Mcmw@mail.gmail.com","threadId":"50669","inReplyTo":"xmqq5zsnfrhk.fsf@gitster-ct.c.googlers.com","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2019-03-13T06:43:02Z","receivedAt":"2019-03-13T06:43:16Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Tue, Mar 12, 2019 at 10:17 PM Junio C Hamano wrote:\n> Andrei Rybak writes:\n> > On 2019-03-12 16:48, Eric Sunshine wrote:\n> >> * drop the full stop from the first line of the commit message\n> >> * s/futur/future/ in the commit message\n> >> * s/There are false/& positives/ in the commit message\n> >> * s/both, It/both, it/\n> >\n> > * s/inconsistant/inconsistent/ in the first paragraph of the commit message.\n>\n> Here is what I have locally, with the above input, relative to what\n> Matthieu reviewed.\n\nThe range-diff you presented looks good and addresses all the (minor)\nissues raised.\n"},{"id":"371339","messageId":"86lg1j6qy6.fsf@matthieu-moy.fr","threadId":"50669","inReplyTo":"CAPig+cQEYDay9kTUpBepw6kN_PgpG4dRXeNf82Kty+E7piXeWg@mail.gmail.com","subject":"Re: [PATCH 2/2 v3] doc: format pathnames and URLs as monospace.","fromName":"Matthieu Moy","fromEmail":"git@matthieu-moy.fr","sentAt":"2019-03-13T09:53:21Z","receivedAt":"2019-03-13T09:53:57Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"Eric Sunshine writes:\n\n> In patch 1/2:\n>\n> * drop the full stop from the first line of the commit message\n>\n> * s/futur/future/ in the commit message\n>\n> * s/There are false/& positives/ in the commit message\n>\n> * s/both, It/both, it/\n\nNice catches, thanks.\n\n> In patch 2/2, there's a 'man curl' which probably ought to be\n> converted to `man curl` (per paragraph updated by patch 1/2), but\n> perhaps that's outside the scope of this patch series\n\nYes, I have no objection in fixing it but I'd rather limit the scope of\nthe patch and keep other fixes for another time.\n\nThanks,\n\n-- \nMatthieu Moy\nhttps://matthieu-moy.fr/\n"}]}