{"thread":{"id":"61197","subject":"[PATCH 0/4] Doc new guidelines","startedAt":"2024-03-24T22:19:03Z","lastAt":"2024-03-30T17:37:25Z","messageCount":21,"participants":["Jean-Noël Avila via GitGitGadget","Martin Ågren","Junio C Hamano","Jean-Noël AVILA","Jeff King","Eric Sunshine"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"491381","messageId":"pull.1702.git.1711318739.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":null,"subject":"[PATCH 0/4] Doc new guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-24T22:18:55Z","receivedAt":"2024-03-24T22:19:03Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This is hopefully the final rehearsal of documentation style rework before\nthe reroll on the all the man pages.\n\nFollowing some more research on how man pages are usually formatted and on\nour track record of editing our documentation, this series states as the new\nstandard that all literal text is now formatted in verbatim and that\nplaceholders are emphasized, wherever they appear.\n\nThe markup is a bit more involved in some cases, but the output is more\nconsistent and follows the principle of least surprise for readers\naccustomed to reading man pages.\n\nJean-Noël Avila (4):\n  doc: rework CodingGuidelines with new formatting rules\n  doc: allow literal and emphasis format in doc vs help tests\n  doc: git-init: apply new documentation formatting guidelines\n  doc: git-clone: apply new documentation guidelines\n\n Documentation/CodingGuidelines | 147 ++++++++++++++++++---------------\n Documentation/config/clone.txt |  23 ++++--\n Documentation/config/init.txt  |   4 +-\n Documentation/git-clone.txt    | 120 +++++++++++++--------------\n Documentation/git-init.txt     |  46 +++++------\n Documentation/urls.txt         |  22 ++---\n t/t0450-txt-doc-vs-help.sh     |   2 +-\n 7 files changed, 193 insertions(+), 171 deletions(-)\n\n\nbase-commit: 11c821f2f2a31e70fb5cc449f9a29401c333aad2\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1702%2Fjnavila%2Fdoc_new_Guidelines-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1702/jnavila/doc_new_Guidelines-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1702\n-- \ngitgitgadget\n"},{"id":"491382","messageId":"d08e8bfd9bc548793f8fd403f12fd8126cec1f5d.1711318739.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.git.1711318739.gitgitgadget@gmail.com","subject":"[PATCH 1/4] doc: rework CodingGuidelines with new formatting rules","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-24T22:18:56Z","receivedAt":"2024-03-24T22:19:04Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nLiteral and placeholder formatting is more heavily enforced, with some\nasciidoc magic. Basically, the markup is preserved everywhere.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/CodingGuidelines | 147 ++++++++++++++++++---------------\n 1 file changed, 79 insertions(+), 68 deletions(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32e69f798ee..b9e4c7cc19d 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -641,15 +641,15 @@ Writing Documentation:\n   - Prefer succinctness and matter-of-factly describing functionality\n     in the abstract.  E.g.\n \n-     --short:: Emit output in the short-format.\n+     `--short`:: Emit output in the short-format.\n \n     and avoid something like these overly verbose alternatives:\n \n-     --short:: Use this to emit output in the short-format.\n-     --short:: You can use this to get output in the short-format.\n-     --short:: A user who prefers shorter output could....\n-     --short:: Should a person and/or program want shorter output, he\n-               she/they/it can...\n+     `--short`:: Use this to emit output in the short-format.\n+     `--short`:: You can use this to get output in the short-format.\n+     `--short`:: A user who prefers shorter output could....\n+     `--short`:: Should a person and/or program want shorter output, he\n+                 she/they/it can...\n \n     This practice often eliminates the need to involve human actors in\n     your description, but it is a good practice regardless of the\n@@ -659,12 +659,12 @@ Writing Documentation:\n     addressing the hypothetical user, and possibly \"we\" when\n     discussing how the program might react to the user.  E.g.\n \n-      You can use this option instead of --xyz, but we might remove\n+      You can use this option instead of `--xyz`, but we might remove\n       support for it in future versions.\n \n     while keeping in mind that you can probably be less verbose, e.g.\n \n-      Use this instead of --xyz. This option might be removed in future\n+      Use this instead of `--xyz`. This option might be removed in future\n       versions.\n \n   - If you still need to refer to an example person that is\n@@ -682,68 +682,112 @@ Writing Documentation:\n  The same general rule as for code applies -- imitate the existing\n  conventions.\n \n- A few commented examples follow to provide reference when writing or\n- modifying command usage strings and synopsis sections in the manual\n- pages:\n \n- Placeholders are spelled in lowercase and enclosed in angle brackets:\n-   <file>\n-   --sort=<key>\n-   --abbrev[=<n>]\n+Markup:\n+\n+ Literal parts (e.g. use of command-line options, command names,\n+ branch names, URLs, pathnames (files and directories), configuration and\n+ environment variables) must be typeset as verbatim (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+ An environment variable must be prefixed with \"$\" only when referring to its\n+ value and not when referring to the variable itself, in this case there is\n+ nothing to add except the backticks:\n+   `GIT_DIR` is specified\n+   `$GIT_DIR/hooks/pre-receive`\n+\n+ Word phrases enclosed in `backtick characters` are rendered literally\n+ and will not be further expanded. The use of `backticks` to achieve the\n+ previous rule means that literal examples should not use AsciiDoc\n+ escapes.\n+   Correct:\n+      `--pretty=oneline`\n+   Incorrect:\n+      `\\--pretty=oneline`\n+\n+ Placeholders are spelled in lowercase and enclosed in\n+ angle brackets surrounded by underscores:\n+   _<file>_\n+   _<commit>_\n \n  If a placeholder has multiple words, they are separated by dashes:\n-   <new-branch-name>\n-   --template=<template-directory>\n+   _<new-branch-name>_\n+   _<template-directory>_\n+\n+ A placeholder is not enclosed in backticks, as it is not a literal.\n+\n+ When needed, use a distinctive identifier for placeholders, usually\n+ made of a qualification and a type:\n+   _<git-dir>_\n+   _<key-id>_\n+\n+ When literal and placeholders are mixed, each markup is applied for\n+ each sub-entity. If they are stuck, a special markup, with an {empty}\n+ entity is needed:\n+   `--jobs` _<n>_\n+   `--sort=`{empty}__<key>__\n+   __<directory>__{empty}`/.git`\n+   `remote.`{empty}__<name>__{empty}`.mirror`\n+\n+Synopsis Syntax\n \n- When a placeholder is cited in text paragraph, it is enclosed in angle\n- brackets to remind the reader the reference in the synopsis section.\n- For better visibility, the placeholder is typeset in italics:\n-   The _<file>_ to be added.\n+ Syntax grammar is formatted neither as literal nor as placeholder.\n+\n+ A few commented examples follow to provide reference when writing or\n+ modifying command usage strings and synopsis sections in the manual\n+ pages:\n \n  Possibility of multiple occurrences is indicated by three dots:\n-   <file>...\n+   _<file>_...\n    (One or more of <file>.)\n \n  Optional parts are enclosed in square brackets:\n-   [<file>...]\n+   [_<file>_...]\n    (Zero or more of <file>.)\n \n-   --exec-path[=<path>]\n+   `--exec-path`[`=`{empty}__<path>__]\n    (Option with an optional argument.  Note that the \"=\" is inside the\n    brackets.)\n \n-   [<patch>...]\n+   [_<patch>_...]\n    (Zero or more of <patch>.  Note that the dots are inside, not\n    outside the brackets.)\n \n  Multiple alternatives are indicated with vertical bars:\n-   [-q | --quiet]\n-   [--utf8 | --no-utf8]\n+   [`-q` | `--quiet`]\n+   [`--utf8` | `--no-utf8`]\n \n  Use spacing around \"|\" token(s), but not immediately after opening or\n  before closing a [] or () pair:\n-   Do: [-q | --quiet]\n-   Don't: [-q|--quiet]\n+   Do: [`-q` | `--quiet`]\n+   Don't: [`-q`|`--quiet`]\n \n  Don't use spacing around \"|\" tokens when they're used to separate the\n  alternate arguments of an option:\n-    Do: --track[=(direct|inherit)]\n-    Don't: --track[=(direct | inherit)]\n+    Do: `--track`[`=`(`direct`|`inherit`)]`\n+    Don't: `--track`[`=`(`direct` | `inherit`)]\n \n  Parentheses are used for grouping:\n-   [(<rev> | <range>)...]\n+   [(_<rev>_ | _<range>_)...]\n    (Any number of either <rev> or <range>.  Parens are needed to make\n    it clear that \"...\" pertains to both <rev> and <range>.)\n \n-   [(-p <parent>)...]\n+   [(`-p` _<parent>_)...]\n    (Any number of option -p, each with one <parent> argument.)\n \n-   git remote set-head <name> (-a | -d | <branch>)\n+   `git remote set-head` _<name>_ (`-a` | `-d` | _<branch>_)\n    (One and only one of \"-a\", \"-d\" or \"<branch>\" _must_ (no square\n    brackets) be provided.)\n \n  And a somewhat more contrived example:\n-   --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]\n+   `--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`\n    Here \"=\" is outside the brackets, because \"--diff-filter=\" is a\n    valid usage.  \"*\" has its own pair of brackets, because it can\n    (optionally) be specified only when one or more of the letters is\n@@ -754,39 +798,6 @@ Writing Documentation:\n    the user would type into a shell and use 'Git' (uppercase first letter)\n    when talking about the version control system and its properties.\n \n- A few commented examples follow to provide reference when writing or\n- modifying paragraphs or option/command explanations that contain options\n- or commands:\n-\n- Literal examples (e.g. use of command-line options, command names,\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- An environment variable must be prefixed with \"$\" only when referring to its\n- value and not when referring to the variable itself, in this case there is\n- nothing to add except the backticks:\n-   `GIT_DIR` is specified\n-   `$GIT_DIR/hooks/pre-receive`\n-\n- Word phrases enclosed in `backtick characters` are rendered literally\n- and will not be further expanded. The use of `backticks` to achieve the\n- previous rule means that literal examples should not use AsciiDoc\n- escapes.\n-   Correct:\n-      `--pretty=oneline`\n-   Incorrect:\n-      `\\--pretty=oneline`\n-\n-A placeholder is not enclosed in backticks, as it is not a literal.\n-\n  If some place in the documentation needs to typeset a command usage\n  example with inline substitutions, it is fine to use +monospaced and\n  inline substituted text+ instead of `monospaced literal text`, and with\n-- \ngitgitgadget\n\n"},{"id":"491383","messageId":"202ed891463c134904b89a0d746d85bb62338d52.1711318739.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.git.1711318739.gitgitgadget@gmail.com","subject":"[PATCH 2/4] doc: allow literal and emphasis format in doc vs help tests","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-24T22:18:57Z","receivedAt":"2024-03-24T22:19:05Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nAs the new formatting of literal and placeholders is introduced,\nthe synopsis in the man pages can now hold additional markup with\nrespect to the command help.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n t/t0450-txt-doc-vs-help.sh | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh\nindex cd3969e852b..e47599cbf26 100755\n--- a/t/t0450-txt-doc-vs-help.sh\n+++ b/t/t0450-txt-doc-vs-help.sh\n@@ -59,7 +59,7 @@ txt_to_synopsis () {\n \t\t-e '/^\\[verse\\]$/,/^$/ {\n \t\t\t/^$/d;\n \t\t\t/^\\[verse\\]$/d;\n-\n+\t\t\ts/{empty}\\|_\\|`//g;\n \t\t\ts/{litdd}/--/g;\n \t\t\ts/'\\''\\(git[ a-z-]*\\)'\\''/\\1/g;\n \n-- \ngitgitgadget\n\n"},{"id":"491384","messageId":"310f09fc81c75ef03eb00629db6302d1904585fe.1711318740.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.git.1711318739.gitgitgadget@gmail.com","subject":"[PATCH 3/4] doc: git-init: apply new documentation formatting guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-24T22:18:58Z","receivedAt":"2024-03-24T22:19:07Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/config/init.txt |  4 +--\n Documentation/git-init.txt    | 46 +++++++++++++++++------------------\n 2 files changed, 25 insertions(+), 25 deletions(-)\n\ndiff --git a/Documentation/config/init.txt b/Documentation/config/init.txt\nindex dd1d8332737..af03acdbcbb 100644\n--- a/Documentation/config/init.txt\n+++ b/Documentation/config/init.txt\n@@ -3,8 +3,8 @@ ifndef::git-init[]\n :see-git-init: (See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n endif::[]\n \n-init.templateDir::\n+`init.templateDir`::\n \tSpecify the directory from which templates will be copied. {see-git-init}\n-init.defaultBranch::\n+`init.defaultBranch`::\n \tAllows overriding the default branch name e.g. when initializing\n \ta new repository.\ndiff --git a/Documentation/git-init.txt b/Documentation/git-init.txt\nindex 2f864e11ed9..ac4c4a80e26 100644\n--- a/Documentation/git-init.txt\n+++ b/Documentation/git-init.txt\n@@ -9,11 +9,11 @@ git-init - Create an empty Git repository or reinitialize an existing one\n SYNOPSIS\n --------\n [verse]\n-'git init' [-q | --quiet] [--bare] [--template=<template-directory>]\n-\t  [--separate-git-dir <git-dir>] [--object-format=<format>]\n-\t  [--ref-format=<format>]\n-\t  [-b <branch-name> | --initial-branch=<branch-name>]\n-\t  [--shared[=<permissions>]] [<directory>]\n+`git init` [`-q` | `--quiet`] [`--bare`] [`--template=`{empty}__<template-directory>__]\n+\t  [`--separate-git-dir` _<git-dir>_] [`--object-format=`{empty}__<format>__]\n+\t  [`--ref-format=`{empty}__<format>__]\n+\t  [`-b` _<branch-name>_ | `--initial-branch=`{empty}__<branch-name>__]\n+\t  [`--shared`[`=`{empty}__<permissions>__]] [_<directory>_]\n \n \n DESCRIPTION\n@@ -41,35 +41,35 @@ the repository to another place if `--separate-git-dir` is given).\n OPTIONS\n -------\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \n Only print error and warning messages; all other output will be suppressed.\n \n---bare::\n+`--bare`::\n \n Create a bare repository. If `GIT_DIR` environment is not set, it is set to the\n current working directory.\n \n---object-format=<format>::\n+`--object-format=`{empty}__<format>__::\n \n Specify the given object _<format>_ (hash algorithm) for the repository.  The valid\n values are `sha1` and (if enabled) `sha256`.  `sha1` is the default.\n +\n include::object-format-disclaimer.txt[]\n \n---ref-format=<format>::\n+`--ref-format=`{empty}__<format>__::\n \n Specify the given ref storage _<format>_ for the repository. The valid values are:\n +\n include::ref-storage-format.txt[]\n \n---template=<template-directory>::\n+`--template=`{empty}__<template-directory>__::\n \n Specify the directory from which templates will be used.  (See the \"TEMPLATE\n DIRECTORY\" section below.)\n \n---separate-git-dir=<git-dir>::\n+`--separate-git-dir=`{empty}__<git-dir>__::\n \n Instead of initializing the repository as a directory to either `$GIT_DIR` or\n `./.git/`, create a text file there containing the path to the actual\n@@ -78,15 +78,15 @@ repository.\n +\n If this is a reinitialization, the repository will be moved to the specified path.\n \n--b <branch-name>::\n---initial-branch=<branch-name>::\n+`-b` _<branch-name>_::\n+`--initial-branch=`{empty}__<branch-name>__::\n \n Use _<branch-name>_ for the initial branch in the newly created\n repository.  If not specified, fall back to the default name (currently\n `master`, but this is subject to change in the future; the name can be\n customized via the `init.defaultBranch` configuration variable).\n \n---shared[=(false|true|umask|group|all|world|everybody|<perm>)]::\n+`--shared`[`=`(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::\n \n Specify that the Git repository is to be shared amongst several users.  This\n allows users belonging to the same group to push into that\n@@ -99,14 +99,14 @@ The option can have the following values, defaulting to `group` if no value\n is given:\n +\n --\n-umask::\n-false::\n+`umask`::\n+`false`::\n \n Use permissions reported by umask(2). The default, when `--shared` is not\n specified.\n \n-group::\n-true::\n+`group`::\n+`true`::\n \n Make the repository group-writable, (and g+sx, since the git group may not be\n the primary group of all users). This is used to loosen the permissions of an\n@@ -115,13 +115,13 @@ permission bits (e.g. if umask is `0022`, using `group` will not remove read\n privileges from other (non-group) users). See `0xxx` for how to exactly specify\n the repository permissions.\n \n-all::\n-world::\n-everybody::\n+`all`::\n+`world`::\n+`everybody`::\n \n Same as `group`, but make the repository readable by all users.\n \n-<perm>::\n+_<perm>_::\n \n _<perm>_ is a 3-digit octal number prefixed with `0` and each file\n will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n-- \ngitgitgadget\n\n"},{"id":"491385","messageId":"5ae83d3f799e9ab84d5233f77cb91715415ae167.1711318740.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.git.1711318739.gitgitgadget@gmail.com","subject":"[PATCH 4/4] doc: git-clone: apply new documentation guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-24T22:18:59Z","receivedAt":"2024-03-24T22:19:08Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nHeavily apply literal and placeholder markup everywhere.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/config/clone.txt |  23 +++++--\n Documentation/git-clone.txt    | 120 ++++++++++++++++-----------------\n Documentation/urls.txt         |  22 +++---\n 3 files changed, 88 insertions(+), 77 deletions(-)\n\ndiff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt\nindex d037b57f729..0e0a8a1ae4a 100644\n--- a/Documentation/config/clone.txt\n+++ b/Documentation/config/clone.txt\n@@ -1,13 +1,22 @@\n-clone.defaultRemoteName::\n+`clone.defaultRemoteName`::\n \tThe name of the remote to create when cloning a repository.  Defaults to\n-\t`origin`, and can be overridden by passing the `--origin` command-line\n+\t`origin`.\n+ifdef::git-clone[]\n+\tIt can be overridden by passing the `--origin` command-line\n+\toption.\n+endif::[]\n+ifndef::git-clone[]\n+\tIt can be overridden by passing the `--origin` command-line\n \toption to linkgit:git-clone[1].\n+endif::[]\n+`clone.rejectShallow`::\n+\tReject cloning a repository if it is a shallow one. This can be overridden by\n+\tpassing the `--reject-shallow` option on the command line.\n+ifndef::git-clone[]\n+\tSee linkgit:git-clone[1]\n+endif::[]\n \n-clone.rejectShallow::\n-\tReject cloning a repository if it is a shallow one; this can be overridden by\n-\tpassing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]\n-\n-clone.filterSubmodules::\n+`clone.filterSubmodules`::\n \tIf a partial clone filter is provided (see `--filter` in\n \tlinkgit:git-rev-list[1]) and `--recurse-submodules` is used, also apply\n \tthe filter to submodules.\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex f90977a8519..134b5278ca1 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -9,15 +9,15 @@ git-clone - Clone a repository into a new directory\n SYNOPSIS\n --------\n [verse]\n-'git clone' [--template=<template-directory>]\n-\t  [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n-\t  [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n-\t  [--dissociate] [--separate-git-dir <git-dir>]\n-\t  [--depth <depth>] [--[no-]single-branch] [--no-tags]\n-\t  [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n-\t  [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n-\t  [--filter=<filter> [--also-filter-submodules]] [--] <repository>\n-\t  [<directory>]\n+`git clone` [`--template=`{empty}__<template-directory>__]\n+\t  [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]\n+\t  [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]\n+\t  [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n+\t  [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n+\t  [`--recurse-submodules`[`=`{empty}__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n+\t  [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]\n+\t  [`--filter=`{empty}__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n+\t  [_<directory>_]\n \n DESCRIPTION\n -----------\n@@ -31,7 +31,7 @@ currently active branch.\n After the clone, a plain `git fetch` without arguments will update\n all the remote-tracking branches, and a `git pull` without\n arguments will in addition merge the remote master branch into the\n-current master branch, if any (this is untrue when \"--single-branch\"\n+current master branch, if any (this is untrue when `--single-branch`\n is given; see below).\n \n This default configuration is achieved by creating references to\n@@ -42,12 +42,12 @@ configuration variables.\n \n OPTIONS\n -------\n--l::\n---local::\n+`-l`::\n+`--local`::\n \tWhen the repository to clone from is on a local machine,\n \tthis flag bypasses the normal \"Git aware\" transport\n \tmechanism and clones the repository by making a copy of\n-\tHEAD and everything under objects and refs directories.\n+\t`HEAD` and everything under objects and refs directories.\n \tThe files under `.git/objects/` directory are hardlinked\n \tto save space when possible.\n +\n@@ -67,14 +67,14 @@ links.\n source repository, similar to running `cp -r src dst` while modifying\n `src`.\n \n---no-hardlinks::\n+`--no-hardlinks`::\n \tForce the cloning process from a repository on a local\n \tfilesystem to copy the files under the `.git/objects`\n \tdirectory instead of using hardlinks. This may be desirable\n \tif you are trying to make a back-up of your repository.\n \n--s::\n---shared::\n+`-s`::\n+`--shared`::\n \tWhen the repository to clone is on the local machine,\n \tinstead of using hard links, automatically setup\n \t`.git/objects/info/alternates` to share the objects\n@@ -101,7 +101,7 @@ If you want to break the dependency of a repository cloned with `--shared` on\n its source repository, you can simply run `git repack -a` to copy all\n objects from the source repository into a pack in the cloned repository.\n \n---reference[-if-able] <repository>::\n+`--reference`[`-if-able`] _<repository>_::\n \tIf the reference _<repository>_ is on the local machine,\n \tautomatically setup `.git/objects/info/alternates` to\n \tobtain objects from the reference _<repository>_.  Using\n@@ -115,7 +115,7 @@ objects from the source repository into a pack in the cloned repository.\n *NOTE*: see the NOTE for the `--shared` option, and also the\n `--dissociate` option.\n \n---dissociate::\n+`--dissociate`::\n \tBorrow the objects from reference repositories specified\n \twith the `--reference` options only to reduce network\n \ttransfer, and stop borrowing from them after a clone is made\n@@ -126,43 +126,43 @@ objects from the source repository into a pack in the cloned repository.\n \tsame repository, and this option can be used to stop the\n \tborrowing.\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \tOperate quietly.  Progress is not reported to the standard\n \terror stream.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tRun verbosely. Does not affect the reporting of progress status\n \tto the standard error stream.\n \n---progress::\n+`--progress`::\n \tProgress status is reported on the standard error stream\n \tby default when it is attached to a terminal, unless `--quiet`\n \tis specified. This flag forces progress status even if the\n \tstandard error stream is not directed to a terminal.\n \n---server-option=<option>::\n+`--server-option=`{empty}__<option>__::\n \tTransmit the given string to the server when communicating using\n \tprotocol version 2.  The given string must not contain a NUL or LF\n \tcharacter.  The server's handling of server options, including\n \tunknown ones, is server-specific.\n-\tWhen multiple `--server-option=<option>` are given, they are all\n+\tWhen multiple `--server-option=`{empty}__<option>__ are given, they are all\n \tsent to the other side in the order listed on the command line.\n \n--n::\n---no-checkout::\n+`-n`::\n+`--no-checkout`::\n \tNo checkout of HEAD is performed after the clone is complete.\n \n---[no-]reject-shallow::\n+`--`[`no-`]`reject-shallow`::\n \tFail if the source repository is a shallow repository.\n \tThe `clone.rejectShallow` configuration variable can be used to\n \tspecify the default.\n \n---bare::\n+`--bare`::\n \tMake a 'bare' Git repository.  That is, instead of\n \tcreating _<directory>_ and placing the administrative\n-\tfiles in `<directory>/.git`, make the _<directory>_\n+\tfiles in _<directory>_`/.git`, make the _<directory>_\n \titself the `$GIT_DIR`. This obviously implies the `--no-checkout`\n \tbecause there is nowhere to check out the working tree.\n \tAlso the branch heads at the remote are copied directly\n@@ -171,28 +171,28 @@ objects from the source repository into a pack in the cloned repository.\n \tused, neither remote-tracking branches nor the related\n \tconfiguration variables are created.\n \n---sparse::\n+`--sparse`::\n \tEmploy a sparse-checkout, with only files in the toplevel\n \tdirectory initially being present.  The\n \tlinkgit:git-sparse-checkout[1] command can be used to grow the\n \tworking directory as needed.\n \n---filter=<filter-spec>::\n+`--filter=`{empty}__<filter-spec>__::\n \tUse the partial clone feature and request that the server sends\n \ta subset of reachable objects according to a given object filter.\n \tWhen using `--filter`, the supplied _<filter-spec>_ is used for\n \tthe partial clone filter. For example, `--filter=blob:none` will\n \tfilter out all blobs (file contents) until needed by Git. Also,\n-\t`--filter=blob:limit=<size>` will filter out all blobs of size\n+\t`--filter=blob:limit=`{empty}__<size>__ will filter out all blobs of size\n \tat least _<size>_. For more details on filter specifications, see\n \tthe `--filter` option in linkgit:git-rev-list[1].\n \n---also-filter-submodules::\n+`--also-filter-submodules`::\n \tAlso apply the partial clone filter to any submodules in the repository.\n \tRequires `--filter` and `--recurse-submodules`. This can be turned on by\n \tdefault by setting the `clone.filterSubmodules` config option.\n \n---mirror::\n+`--mirror`::\n \tSet up a mirror of the source repository.  This implies `--bare`.\n \tCompared to `--bare`, `--mirror` not only maps local branches of the\n \tsource to local branches of the target, it maps all refs (including\n@@ -200,14 +200,14 @@ objects from the source repository into a pack in the cloned repository.\n \tthat all these refs are overwritten by a `git remote update` in the\n \ttarget repository.\n \n--o <name>::\n---origin <name>::\n+`-o` _<name>_::\n+`--origin` _<name>_::\n \tInstead of using the remote name `origin` to keep track of the upstream\n \trepository, use _<name>_.  Overrides `clone.defaultRemoteName` from the\n \tconfig.\n \n--b <name>::\n---branch <name>::\n+`-b` _<name>_::\n+`--branch` _<name>_::\n \tInstead of pointing the newly created HEAD to the branch pointed\n \tto by the cloned repository's HEAD, point to _<name>_ branch\n \tinstead. In a non-bare repository, this is the branch that will\n@@ -215,18 +215,18 @@ objects from the source repository into a pack in the cloned repository.\n \t`--branch` can also take tags and detaches the HEAD at that commit\n \tin the resulting repository.\n \n--u <upload-pack>::\n---upload-pack <upload-pack>::\n+`-u` _<upload-pack>_::\n+`--upload-pack` _<upload-pack>_::\n \tWhen given, and the repository to clone from is accessed\n \tvia ssh, this specifies a non-default path for the command\n \trun on the other end.\n \n---template=<template-directory>::\n+`--template=`{empty}__<template-directory>__::\n \tSpecify the directory from which templates will be used;\n \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n \n--c <key>=<value>::\n---config <key>=<value>::\n+`-c` __<key>__{empty}`=`{empty}__<value>__::\n+`--config` __<key>__{empty}`=`{empty}__<value>__::\n \tSet a configuration variable in the newly-created repository;\n \tthis takes effect immediately after the repository is\n \tinitialized, but before the remote history is fetched or any\n@@ -239,25 +239,25 @@ objects from the source repository into a pack in the cloned repository.\n Due to limitations of the current implementation, some configuration\n variables do not take effect until after the initial fetch and checkout.\n Configuration variables known to not take effect are:\n-`remote.<name>.mirror` and `remote.<name>.tagOpt`.  Use the\n+`remote.`{empty}__<name>__{empty}`.mirror` and `remote.`{empty}__<name>__{empty}`.tagOpt`.  Use the\n corresponding `--mirror` and `--no-tags` options instead.\n \n---depth <depth>::\n+`--depth` _<depth>_::\n \tCreate a 'shallow' clone with a history truncated to the\n \tspecified number of commits. Implies `--single-branch` unless\n \t`--no-single-branch` is given to fetch the histories near the\n \ttips of all branches. If you want to clone submodules shallowly,\n \talso pass `--shallow-submodules`.\n \n---shallow-since=<date>::\n+`--shallow-since=`{empty}__<date>__::\n \tCreate a shallow clone with a history after the specified time.\n \n---shallow-exclude=<revision>::\n+`--shallow-exclude=`{empty}__<revision>__::\n \tCreate a shallow clone with a history, excluding commits\n \treachable from a specified remote branch or tag.  This option\n \tcan be specified multiple times.\n \n---[no-]single-branch::\n+`--`[`no-`]`single-branch`::\n \tClone only the history leading to the tip of a single branch,\n \teither specified by the `--branch` option or the primary\n \tbranch remote's `HEAD` points at.\n@@ -267,7 +267,7 @@ corresponding `--mirror` and `--no-tags` options instead.\n \tbranch when `--single-branch` clone was made, no remote-tracking\n \tbranch is created.\n \n---no-tags::\n+`--no-tags`::\n \tDon't clone any tags, and set\n \t`remote.<remote>.tagOpt=--no-tags` in the config, ensuring\n \tthat future `git pull` and `git fetch` operations won't follow\n@@ -279,7 +279,7 @@ maintain a branch with no references other than a single cloned\n branch. This is useful e.g. to maintain minimal clones of the default\n branch of some repository for search indexing.\n \n---recurse-submodules[=<pathspec>]::\n+`--recurse-submodules`[`=`{empty}__<pathspec>__]::\n \tAfter the clone is created, initialize and clone submodules\n \twithin based on the provided _<pathspec>_.  If no _=<pathspec>_ is\n \tprovided, all submodules are initialized and cloned.\n@@ -295,46 +295,46 @@ the clone is finished. This option is ignored if the cloned repository does\n not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,\n or `--mirror` is given)\n \n---[no-]shallow-submodules::\n+`--`[`no-`]`shallow-submodules`::\n \tAll submodules which are cloned will be shallow with a depth of 1.\n \n---[no-]remote-submodules::\n+`--`[`no-`]`remote-submodules`::\n \tAll submodules which are cloned will use the status of the submodule's\n \tremote-tracking branch to update the submodule, rather than the\n \tsuperproject's recorded SHA-1. Equivalent to passing `--remote` to\n \t`git submodule update`.\n \n---separate-git-dir=<git-dir>::\n+`--separate-git-dir=`{empty}__<git-dir>__::\n \tInstead of placing the cloned repository where it is supposed\n \tto be, place the cloned repository at the specified directory,\n \tthen make a filesystem-agnostic Git symbolic link to there.\n \tThe result is Git repository can be separated from working\n \ttree.\n \n---ref-format=<ref-format>::\n+`--ref-format=`{empty}__<ref-format>__::\n \n Specify the given ref storage format for the repository. The valid values are:\n +\n include::ref-storage-format.txt[]\n \n--j <n>::\n---jobs <n>::\n+`-j` _<n>_::\n+`--jobs` _<n>_::\n \tThe number of submodules fetched at the same time.\n \tDefaults to the `submodule.fetchJobs` option.\n \n-<repository>::\n+_<repository>_::\n \tThe (possibly remote) _<repository>_ to clone from.  See the\n \t<<URLS,GIT URLS>> section below for more information on specifying\n \trepositories.\n \n-<directory>::\n+_<directory>_::\n \tThe name of a new directory to clone into.  The \"humanish\"\n \tpart of the source repository is used if no _<directory>_ is\n \texplicitly given (`repo` for `/path/to/repo.git` and `foo`\n \tfor `host.xz:foo/.git`).  Cloning into an existing directory\n \tis only allowed if the directory is empty.\n \n---bundle-uri=<uri>::\n+`--bundle-uri=`{empty}__<uri>__::\n \tBefore fetching from the remote, fetch a bundle from the given\n \t_<uri>_ and unbundle the data into the local repository. The refs\n \tin the bundle will be stored under the hidden `refs/bundle/*`\ndiff --git a/Documentation/urls.txt b/Documentation/urls.txt\nindex 0b9e0c4302d..f1a0c275ee1 100644\n--- a/Documentation/urls.txt\n+++ b/Documentation/urls.txt\n@@ -57,11 +57,11 @@ endif::git-clone[]\n accept a suitable bundle file. See linkgit:git-bundle[1].\n \n When Git doesn't know how to handle a certain transport protocol, it\n-attempts to use the `remote-<transport>` remote helper, if one\n+attempts to use the `remote-`{empty}__<transport>__ remote helper, if one\n exists. To explicitly request a remote helper, the following syntax\n may be used:\n \n-- _<transport>_::_<address>_\n+- _<transport>_::__<address>__\n \n where _<address>_ may be a path, a server and path, or an arbitrary\n URL-like string recognized by the specific remote helper being\n@@ -72,10 +72,11 @@ you want to use a different format for them (such that the URLs you\n use will be rewritten into URLs that work), you can create a\n configuration section of the form:\n \n-------------\n-\t[url \"<actual-url-base>\"]\n-\t\tinsteadOf = <other-url-base>\n-------------\n+[verse]\n+--\n+\t[url \"__<actual-url-base>__\"]\n+\t\tinsteadOf = _<other-url-base>_\n+--\n \n For example, with this:\n \n@@ -91,10 +92,11 @@ rewritten in any context that takes a URL to be \"git://git.host.xz/repo.git\".\n If you want to rewrite URLs for push only, you can create a\n configuration section of the form:\n \n-------------\n-\t[url \"<actual-url-base>\"]\n-\t\tpushInsteadOf = <other-url-base>\n-------------\n+[verse]\n+--\n+\t[url \"__<actual-url-base>__\"]\n+\t\tpushInsteadOf = _<other-url-base>_\n+--\n \n For example, with this:\n \n-- \ngitgitgadget\n"},{"id":"491595","messageId":"CAN0heSoSNxuoObvO_xtu1fXb+XYH+gBvVOWfJVBkpXouR0cmWQ@mail.gmail.com","threadId":"61197","inReplyTo":"5ae83d3f799e9ab84d5233f77cb91715415ae167.1711318740.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 4/4] doc: git-clone: apply new documentation guidelines","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2024-03-26T20:03:25Z","receivedAt":"2024-03-26T20:03:37Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"Thanks for working on this. This renders really nicely.\n\nOn Sun, 24 Mar 2024 at 23:20, Jean-Noël Avila via GitGitGadget\n<gitgitgadget@gmail.com> wrote:\n>\n> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n>\n> Heavily apply literal and placeholder markup everywhere.\n>\n> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>\n> ---\n>  Documentation/config/clone.txt |  23 +++++--\n>  Documentation/git-clone.txt    | 120 ++++++++++++++++-----------------\n>  Documentation/urls.txt         |  22 +++---\n>  3 files changed, 88 insertions(+), 77 deletions(-)\n>\n> diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt\n> index d037b57f729..0e0a8a1ae4a 100644\n> --- a/Documentation/config/clone.txt\n> +++ b/Documentation/config/clone.txt\n> @@ -1,13 +1,22 @@\n> -clone.defaultRemoteName::\n> +`clone.defaultRemoteName`::\n>         The name of the remote to create when cloning a repository.  Defaults to\n> -       `origin`, and can be overridden by passing the `--origin` command-line\n> +       `origin`.\n> +ifdef::git-clone[]\n> +       It can be overridden by passing the `--origin` command-line\n> +       option.\n> +endif::[]\n> +ifndef::git-clone[]\n> +       It can be overridden by passing the `--origin` command-line\n>         option to linkgit:git-clone[1].\n> +endif::[]\n\nThere's a bit more going on here than the commit message claims. FWIW, I\nthink these changes are good, even if maybe a bit surprising.\n\n> -'git clone' [--template=<template-directory>]\n> -         [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n> -         [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n> -         [--dissociate] [--separate-git-dir <git-dir>]\n> -         [--depth <depth>] [--[no-]single-branch] [--no-tags]\n> -         [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n> -         [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n> -         [--filter=<filter> [--also-filter-submodules]] [--] <repository>\n> -         [<directory>]\n> +`git clone` [`--template=`{empty}__<template-directory>__]\n> +         [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]\n> +         [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]\n> +         [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n> +         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n> +         [`--recurse-submodules`[`=`{empty}__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n> +         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]\n> +         [`--filter=`{empty}__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n> +         [_<directory>_]\n\nDon't ask me why, but I need this on top (whitespace-damaged)\n\n-         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n-         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n[`--`[`no-`]`shallow-submodules`]\n-         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_]\n[`--sparse`] [`--`[`no-`]`reject-shallow`]\n+         [`--depth` _<depth>_] [`--`[`no-`]{empty}`single-branch`]\n[`--no-tags`]\n+         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n[`--`[`no-`]{empty}`shallow-submodules`]\n+         [`--`[`no-`]{empty}`remote-submodules`] [`--jobs` _<n>_]\n[`--sparse`] [`--`[`no-`]{empty}`reject-shallow`]\n\ni.e., some sprinkling of \"{empty}\", to keep each of these \"[--[no-]\"\nfrom simply disappearing. This is with Asciidoctor 1.5.5, which is\nadmittedly starting to get old, but still ok as per our INSTALL\ndocument.\n\n> ---bare::\n> +`--bare`::\n>         Make a 'bare' Git repository.  That is, instead of\n>         creating _<directory>_ and placing the administrative\n> -       files in `<directory>/.git`, make the _<directory>_\n> +       files in _<directory>_`/.git`, make the _<directory>_\n\nThis should be __<directory>__{empty}`/.git`\n\nThanks. Apart from the small mistake and the misrendering of \"[--[no-]\",\nthis looks really nice to me, both HTML and manpage. The source .txt\nfiles do get a bit messier, especially with the {empty} trickery, but\nok. (I haven't been paying attention. Maybe this has been discussed\nbefore, and TBH I haven't even dug -- I don't mean to start another\nround of discussion.)\n\nMartin\n"},{"id":"491597","messageId":"CAN0heSpVLAw3iYiCcgTnOtO9saY0KXR+00r7mR-PfqU+EcfPoA@mail.gmail.com","threadId":"61197","inReplyTo":"310f09fc81c75ef03eb00629db6302d1904585fe.1711318740.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 3/4] doc: git-init: apply new documentation formatting guidelines","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2024-03-26T20:18:31Z","receivedAt":"2024-03-26T20:18:43Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"On Sun, 24 Mar 2024 at 23:19, Jean-Noël Avila via GitGitGadget\n<gitgitgadget@gmail.com> wrote:\n> -umask::\n> -false::\n> +`umask`::\n> +`false`::\n\n(It should be `umask` here exactly as you did, ok, good.)\n\n>  Use permissions reported by umask(2). The default, when `--shared` is not\n>  specified.\n\n>  _<perm>_ is a 3-digit octal number prefixed with `0` and each file\n>  will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n\nIt's a bit of a mix whether umask(2) should be `umask(2)` with backticks\nor just umask(2) without. That's pretty much the only thing I noticed,\neverything else looks really nice and consistent. I guess it's not a\nliteral, since we don't expect to user to actually type the 8 characters\n\"umask(2)\"? If you do decide to drop the backticks, notice that there's\none instance (seen above) of \"users'`umask(2)`\" with a missing space,\nso you might want to fix that up at the same time.\n\nMartin\n"},{"id":"491598","messageId":"xmqq8r24agov.fsf@gitster.g","threadId":"61197","inReplyTo":"CAN0heSoSNxuoObvO_xtu1fXb+XYH+gBvVOWfJVBkpXouR0cmWQ@mail.gmail.com","subject":"Re: [PATCH 4/4] doc: git-clone: apply new documentation guidelines","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-03-26T20:20:16Z","receivedAt":"2024-03-26T20:20:22Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Martin Ågren <martin.agren@gmail.com> writes:\n\n>> +`git clone` [`--template=`{empty}__<template-directory>__]\n>> +         [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]\n>> +         [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]\n>> +         [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n>> +         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n>> +         [`--recurse-submodules`[`=`{empty}__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n>> +         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]\n>> +         [`--filter=`{empty}__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n>> +         [_<directory>_]\n>\n> Don't ask me why, but I need this on top (whitespace-damaged)\n>\n> -         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n> -         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n> [`--`[`no-`]`shallow-submodules`]\n> -         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_]\n> [`--sparse`] [`--`[`no-`]`reject-shallow`]\n> +         [`--depth` _<depth>_] [`--`[`no-`]{empty}`single-branch`]\n> [`--no-tags`]\n> +         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n> [`--`[`no-`]{empty}`shallow-submodules`]\n> +         [`--`[`no-`]{empty}`remote-submodules`] [`--jobs` _<n>_]\n> [`--sparse`] [`--`[`no-`]{empty}`reject-shallow`]\n>\n> i.e., some sprinkling of \"{empty}\", to keep each of these \"[--[no-]\"\n> from simply disappearing. This is with Asciidoctor 1.5.5, which is\n> admittedly starting to get old, but still ok as per our INSTALL\n> document.\n\nThe original from Jean-Noël was already bad enough with all these\n{empty}, but now this is even worse.\n\n>> ---bare::\n>> +`--bare`::\n>>         Make a 'bare' Git repository.  That is, instead of\n>>         creating _<directory>_ and placing the administrative\n>> -       files in `<directory>/.git`, make the _<directory>_\n>> +       files in _<directory>_`/.git`, make the _<directory>_\n>\n> This should be __<directory>__{empty}`/.git`\n\nThe worst part is that I am not sure if there is a pattern easily\nunderstandable by document writers to help them decide where to\nsprinkle these {empty} mark-ups.  Of course, they are visually very\ndistracting and made our documentation that used to be perfectly\nreadable in the source form to something much less pleasant to read.\n\nCan we make both the rendered output nicer while keeping the source\nstill readable and easy to maintain?\n\nThanks.\n"},{"id":"491601","messageId":"12408886.O9o76ZdvQC@cayenne","threadId":"61197","inReplyTo":"CAN0heSpVLAw3iYiCcgTnOtO9saY0KXR+00r7mR-PfqU+EcfPoA@mail.gmail.com","subject":"Re: [PATCH 3/4] doc: git-init: apply new documentation formatting guidelines","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2024-03-26T20:26:43Z","receivedAt":"2024-03-26T20:26:53Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"Le mardi 26 mars 2024, 21:18:31 CET Martin Ågren a écrit :\n> On Sun, 24 Mar 2024 at 23:19, Jean-Noël Avila via GitGitGadget\n> <gitgitgadget@gmail.com> wrote:\n> > -umask::\n> > -false::\n> > +`umask`::\n> > +`false`::\n> \n> (It should be `umask` here exactly as you did, ok, good.)\n> \n> >  Use permissions reported by umask(2). The default, when `--shared` is not\n> >  specified.\n> \n> >  _<perm>_ is a 3-digit octal number prefixed with `0` and each file\n> >  will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n> \n> It's a bit of a mix whether umask(2) should be `umask(2)` with backticks\n> or just umask(2) without. That's pretty much the only thing I noticed,\n> everything else looks really nice and consistent. I guess it's not a\n> literal, since we don't expect to user to actually type the 8 characters\n> \"umask(2)\"? If you do decide to drop the backticks, notice that there's\n> one instance (seen above) of \"users'`umask(2)`\" with a missing space,\n> so you might want to fix that up at the same time.\n> \n> Martin\n> \n\nAh. Good point! As we are referring to the manpage of a function, this *is* \nindeed a case of verbatim text so, it must be backquoted. \n\nSo, I'll add it the guidelines and reroll with changes in the man pages.\n\nThanks\n\n\n\n\n"},{"id":"491604","messageId":"3285532.aeNJFYEL58@cayenne","threadId":"61197","inReplyTo":"xmqq8r24agov.fsf@gitster.g","subject":"Re: [PATCH 4/4] doc: git-clone: apply new documentation guidelines","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2024-03-26T20:49:17Z","receivedAt":"2024-03-26T20:49:29Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Tuesday, 26 March 2024 21:20:16 CET Junio C Hamano wrote:\n> Martin Ågren <martin.agren@gmail.com> writes:\n> \n> >> +`git clone` [`--template=`{empty}__<template-directory>__]\n> >> +         [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--\nmirror`]\n> >> +         [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--\nreference` _<repository>_]\n> >> +         [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n> >> +         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-\ntags`]\n> >> +         [`--recurse-submodules`[`=`{empty}__<pathspec>__]] [`--`[`no-\n`]`shallow-submodules`]\n> >> +         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] \n[`--`[`no-`]`reject-shallow`]\n> >> +         [`--filter=`{empty}__<filter-spec>__] [`--also-filter-\nsubmodules`]] [`--`] _<repository>_\n> >> +         [_<directory>_]\n> >\n> > Don't ask me why, but I need this on top (whitespace-damaged)\n> >\n> > -         [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n> > -         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n> > [`--`[`no-`]`shallow-submodules`]\n> > -         [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_]\n> > [`--sparse`] [`--`[`no-`]`reject-shallow`]\n> > +         [`--depth` _<depth>_] [`--`[`no-`]{empty}`single-branch`]\n> > [`--no-tags`]\n> > +         [`--recurse-submodules`[`=`{empty}__<pathspec>__]]\n> > [`--`[`no-`]{empty}`shallow-submodules`]\n> > +         [`--`[`no-`]{empty}`remote-submodules`] [`--jobs` _<n>_]\n> > [`--sparse`] [`--`[`no-`]{empty}`reject-shallow`]\n> >\n> > i.e., some sprinkling of \"{empty}\", to keep each of these \"[--[no-]\"\n> > from simply disappearing. This is with Asciidoctor 1.5.5, which is\n> > admittedly starting to get old, but still ok as per our INSTALL\n> > document.\n> \n> The original from Jean-Noël was already bad enough with all these\n> {empty}, but now this is even worse.\n\nI must concede this does not help make these parts readable in the source.\nThe point that Martin raised is the worst for me: if the processing of this \nworkaround is depend on the version of Asciidoc[tor], the way of writing this \nformatting for stuck parts in a compatible way must be clearly defined (and \nmade understandable).\n\n\n> \n> >> ---bare::\n> >> +`--bare`::\n> >>         Make a 'bare' Git repository.  That is, instead of\n> >>         creating _<directory>_ and placing the administrative\n> >> -       files in `<directory>/.git`, make the _<directory>_\n> >> +       files in _<directory>_`/.git`, make the _<directory>_\n> >\n> > This should be __<directory>__{empty}`/.git`\n> \n> The worst part is that I am not sure if there is a pattern easily\n> understandable by document writers to help them decide where to\n> sprinkle these {empty} mark-ups.  Of course, they are visually very\n> distracting and made our documentation that used to be perfectly\n> readable in the source form to something much less pleasant to read.\n> \n> Can we make both the rendered output nicer while keeping the source\n> still readable and easy to maintain?\n> \n> Thanks.\n> \n\nI came up with this trickery because of the use of \"legacy\" Asciidoc format, \nwhich does not understand unconstrained formatting (doubling the signs, so \nthat they don't care about word boundary). With the new format, we would \nsimply write:\n\n__<directory>__``/.git``\n``--filter=``__<filter-spec>__\n\nWithout having to pay attention to the surrounding characters.\n\nFor now, we are stuck with the compatibility with the existing tools. I will \ntry an propose something else. Would preprocessing be accepted?\n\n\n\n\n"},{"id":"491606","messageId":"xmqqsf0c90a8.fsf@gitster.g","threadId":"61197","inReplyTo":"3285532.aeNJFYEL58@cayenne","subject":"Re: [PATCH 4/4] doc: git-clone: apply new documentation guidelines","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-03-26T20:59:59Z","receivedAt":"2024-03-26T21:00:04Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jean-Noël AVILA <jn.avila@free.fr> writes:\n\n> For now, we are stuck with the compatibility with the existing tools. I will \n> try an propose something else. Would preprocessing be accepted?\n\nPre-processing will be hidden inside Documentation/Makefile and\nwould be invisible to developers, so as long as it is cleanly and\nrobustly done, that would be fine, I would say.\n\n"},{"id":"491736","messageId":"20240328100658.GA883510@coredump.intra.peff.net","threadId":"61197","inReplyTo":"202ed891463c134904b89a0d746d85bb62338d52.1711318739.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 2/4] doc: allow literal and emphasis format in doc vs help tests","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2024-03-28T10:06:58Z","receivedAt":"2024-03-28T10:06:59Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Sun, Mar 24, 2024 at 10:18:57PM +0000, Jean-Noël Avila via GitGitGadget wrote:\n\n> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n> \n> As the new formatting of literal and placeholders is introduced,\n> the synopsis in the man pages can now hold additional markup with\n> respect to the command help.\n> \n> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>\n> ---\n>  t/t0450-txt-doc-vs-help.sh | 2 +-\n>  1 file changed, 1 insertion(+), 1 deletion(-)\n> \n> diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh\n> index cd3969e852b..e47599cbf26 100755\n> --- a/t/t0450-txt-doc-vs-help.sh\n> +++ b/t/t0450-txt-doc-vs-help.sh\n> @@ -59,7 +59,7 @@ txt_to_synopsis () {\n>  \t\t-e '/^\\[verse\\]$/,/^$/ {\n>  \t\t\t/^$/d;\n>  \t\t\t/^\\[verse\\]$/d;\n> -\n> +\t\t\ts/{empty}\\|_\\|`//g;\n\nIt looks like this doesn't work in the macos CI jobs. E.g., this run:\n\n  https://github.com/git/git/actions/runs/8460326247/job/23178326007\n\nproduced output from t0450 like:\n\n  +++ diff -u txt help\n  --- txt    2024-03-28 00:14:15\n  +++ help   2024-03-28 00:14:15\n  @@ -1,5 +1,5 @@\n  -`git init` [`-q` | `--quiet`] [`--bare`] [`--template=`{empty}__<template-directory>__]\n  -         [`--separate-git-dir` _<git-dir>_] [`--object-format=`{empty}__<format>__]\n  -         [`--ref-format=`{empty}__<format>__]\n  -         [`-b` _<branch-name>_ | `--initial-branch=`{empty}__<branch-name>__]\n  -         [`--shared`[`=`{empty}__<permissions>__]] [_<directory>_]\n  +git init [-q | --quiet] [--bare] [--template=<template-directory>]\n  +         [--separate-git-dir <git-dir>] [--object-format=<format>]\n  +         [--ref-format=<format>]\n  +         [-b <branch-name> | --initial-branch=<branch-name>]\n  +         [--shared[=<permissions>]] [<directory>]\n\nI think the issue is that \"|\" alternation is not portable. In GNU sed,\ndoing \"\\|\" with BRE is enough, but in BSD sed you need to enable ERE\nwith \"-E\". I'm not sure how portable that is (we do seem to have at\nleast one instance in t6030, so maybe it's OK). The most basic\nalternative is just splitting it like:\n\n  s/{empty}//g;\n  s/[_`]//g;\n\n-Peff\n"},{"id":"491743","messageId":"CAPig+cSEJA9DiiGL3eFekkicMoaEET=2Tm-RkW+p65f7Q=2L3g@mail.gmail.com","threadId":"61197","inReplyTo":"20240328100658.GA883510@coredump.intra.peff.net","subject":"Re: [PATCH 2/4] doc: allow literal and emphasis format in doc vs help tests","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2024-03-28T10:21:00Z","receivedAt":"2024-03-28T10:21:13Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Thu, Mar 28, 2024 at 6:07 AM Jeff King <peff@peff.net> wrote:\n> On Sun, Mar 24, 2024 at 10:18:57PM +0000, Jean-Noël Avila via GitGitGadget wrote:\n> > +                     s/{empty}\\|_\\|`//g;\n>\n> It looks like this doesn't work in the macos CI jobs. E.g., this run:\n>\n> I think the issue is that \"|\" alternation is not portable. In GNU sed,\n> doing \"\\|\" with BRE is enough, but in BSD sed you need to enable ERE\n> with \"-E\". I'm not sure how portable that is (we do seem to have at\n> least one instance in t6030, so maybe it's OK). The most basic\n> alternative is just splitting it like:\n\nAfter reading a patch very recently which used `sed -E`, but before\nresponding that it was not portable and wouldn't work on macOS, I did\na bit of research and was surprised to find that it is POSIX, and that\n(at least) relatively recent macOS does support it. I recall that I\nalso spotted the existing instance in t6030, thus didn't respond after\nall.\n\n>   s/{empty}//g;\n>   s/[_`]//g;\n\nThat said, I'm not sure how recently macOS started supporting `sed\n-E`, so what you propose here may be a good idea anyhow; and it's\ncertainly going to be more portable done this way.\n"},{"id":"491821","messageId":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.git.1711318739.gitgitgadget@gmail.com","subject":"[PATCH v2 0/5] Doc new guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:36Z","receivedAt":"2024-03-29T11:19:46Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This version is a simplification of the markup. The behavior is variable,\ndepending on versions of asciidoc[tor], but at least, it works both on my\nstation and in github-ci. @Martin, please check on your platform.\n\nChanges since v1:\n\n * use unconstrained markup ++ for verbatim stuck to emphasis, instead of\n   {empty} trickery\n * document and apply markup on man page references\n * split git-clone commit into markup and non-autoreference\n\nJean-Noël Avila (5):\n  doc: rework CodingGuidelines with new formatting rules\n  doc: allow literal and emphasis format in doc vs help tests\n  doc: git-init: apply new documentation formatting guidelines\n  doc: git-clone: apply new documentation formatting guidelines\n  doc: git-clone: do not autoreference the manpage in itself\n\n Documentation/CodingGuidelines | 153 ++++++++++++++++++---------------\n Documentation/config/clone.txt |  20 +++--\n Documentation/config/init.txt  |   4 +-\n Documentation/git-clone.txt    | 120 +++++++++++++-------------\n Documentation/git-init.txt     |  56 ++++++------\n Documentation/urls.txt         |  44 +++++-----\n t/t0450-txt-doc-vs-help.sh     |   4 +-\n 7 files changed, 216 insertions(+), 185 deletions(-)\n\n\nbase-commit: 11c821f2f2a31e70fb5cc449f9a29401c333aad2\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1702%2Fjnavila%2Fdoc_new_Guidelines-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1702/jnavila/doc_new_Guidelines-v2\nPull-Request: https://github.com/gitgitgadget/git/pull/1702\n\nRange-diff vs v1:\n\n 1:  d08e8bfd9bc ! 1:  8a25ab1c3b6 doc: rework CodingGuidelines with new formatting rules\n     @@ Documentation/CodingGuidelines: Writing Documentation:\n      +   `.git/config`\n      +   `GIT_DIR`\n      +   `HEAD`\n     ++   `umask`(2)\n      +\n      + An environment variable must be prefixed with \"$\" only when referring to its\n      + value and not when referring to the variable itself, in this case there is\n     @@ Documentation/CodingGuidelines: Writing Documentation:\n      +   _<key-id>_\n      +\n      + When literal and placeholders are mixed, each markup is applied for\n     -+ each sub-entity. If they are stuck, a special markup, with an {empty}\n     -+ entity is needed:\n     ++ each sub-entity. If they are stuck, a special markup, called\n     ++ unconstrained formatting is required.\n     ++ Unconstrained formating for placeholders is __<like-this>__\n     ++ Unconstrained formatting for literal formatting is ++like this++\n      +   `--jobs` _<n>_\n     -+   `--sort=`{empty}__<key>__\n     -+   __<directory>__{empty}`/.git`\n     -+   `remote.`{empty}__<name>__{empty}`.mirror`\n     ++   ++--sort=++__<key>__\n     ++   __<directory>__++/.git++\n     ++   ++remote.++__<name>__++.mirror++\n      +\n     -+Synopsis Syntax\n     ++ caveat: ++ unconstrained format is not verbatim and may expand\n     ++ content. Use Asciidoc escapes inside them.\n       \n      - When a placeholder is cited in text paragraph, it is enclosed in angle\n      - brackets to remind the reader the reference in the synopsis section.\n      - For better visibility, the placeholder is typeset in italics:\n      -   The _<file>_ to be added.\n     ++Synopsis Syntax\n     ++\n      + Syntax grammar is formatted neither as literal nor as placeholder.\n      +\n      + A few commented examples follow to provide reference when writing or\n     @@ Documentation/CodingGuidelines: Writing Documentation:\n          (Zero or more of <file>.)\n       \n      -   --exec-path[=<path>]\n     -+   `--exec-path`[`=`{empty}__<path>__]\n     ++   ++--exec-path++[++=++__<path>__]\n          (Option with an optional argument.  Note that the \"=\" is inside the\n          brackets.)\n       \n     @@ Documentation/CodingGuidelines: Writing Documentation:\n        alternate arguments of an option:\n      -    Do: --track[=(direct|inherit)]\n      -    Don't: --track[=(direct | inherit)]\n     -+    Do: `--track`[`=`(`direct`|`inherit`)]`\n     -+    Don't: `--track`[`=`(`direct` | `inherit`)]\n     ++    Do: ++--track++[++=++(`direct`|`inherit`)]`\n     ++    Don't: ++--track++[++=++(`direct` | `inherit`)]\n       \n        Parentheses are used for grouping:\n      -   [(<rev> | <range>)...]\n 2:  202ed891463 ! 2:  1a4feff2aea doc: allow literal and emphasis format in doc vs help tests\n     @@ t/t0450-txt-doc-vs-help.sh: txt_to_synopsis () {\n       \t\t\t/^$/d;\n       \t\t\t/^\\[verse\\]$/d;\n      -\n     -+\t\t\ts/{empty}\\|_\\|`//g;\n     ++\t\t\ts/_//g;\n     ++\t\t\ts/++//g;\n     ++\t\t\ts/`//g;\n       \t\t\ts/{litdd}/--/g;\n       \t\t\ts/'\\''\\(git[ a-z-]*\\)'\\''/\\1/g;\n       \n 3:  310f09fc81c ! 3:  ad7986e4c39 doc: git-init: apply new documentation formatting guidelines\n     @@ Documentation/git-init.txt: git-init - Create an empty Git repository or reiniti\n      -\t  [--ref-format=<format>]\n      -\t  [-b <branch-name> | --initial-branch=<branch-name>]\n      -\t  [--shared[=<permissions>]] [<directory>]\n     -+`git init` [`-q` | `--quiet`] [`--bare`] [`--template=`{empty}__<template-directory>__]\n     -+\t  [`--separate-git-dir` _<git-dir>_] [`--object-format=`{empty}__<format>__]\n     -+\t  [`--ref-format=`{empty}__<format>__]\n     -+\t  [`-b` _<branch-name>_ | `--initial-branch=`{empty}__<branch-name>__]\n     -+\t  [`--shared`[`=`{empty}__<permissions>__]] [_<directory>_]\n     ++`git init` [`-q` | `--quiet`] [`--bare`] [++--template=++__<template-directory>__]\n     ++\t  [`--separate-git-dir` _<git-dir>_] [++--object-format=++__<format>__]\n     ++\t  [++--ref-format=++__<format>__]\n     ++\t  [`-b` _<branch-name>_ | ++--initial-branch=++__<branch-name>__]\n     ++\t  [++--shared++[++=++__<permissions>__]] [_<directory>_]\n       \n       \n       DESCRIPTION\n     @@ Documentation/git-init.txt: the repository to another place if `--separate-git-d\n       current working directory.\n       \n      ---object-format=<format>::\n     -+`--object-format=`{empty}__<format>__::\n     ++++--object-format=++__<format>__::\n       \n       Specify the given object _<format>_ (hash algorithm) for the repository.  The valid\n       values are `sha1` and (if enabled) `sha256`.  `sha1` is the default.\n     @@ Documentation/git-init.txt: the repository to another place if `--separate-git-d\n       include::object-format-disclaimer.txt[]\n       \n      ---ref-format=<format>::\n     -+`--ref-format=`{empty}__<format>__::\n     ++++--ref-format=++__<format>__::\n       \n       Specify the given ref storage _<format>_ for the repository. The valid values are:\n       +\n       include::ref-storage-format.txt[]\n       \n      ---template=<template-directory>::\n     -+`--template=`{empty}__<template-directory>__::\n     ++++--template=++__<template-directory>__::\n       \n       Specify the directory from which templates will be used.  (See the \"TEMPLATE\n       DIRECTORY\" section below.)\n       \n      ---separate-git-dir=<git-dir>::\n     -+`--separate-git-dir=`{empty}__<git-dir>__::\n     ++++--separate-git-dir=++__<git-dir>__::\n       \n       Instead of initializing the repository as a directory to either `$GIT_DIR` or\n       `./.git/`, create a text file there containing the path to the actual\n     @@ Documentation/git-init.txt: repository.\n      --b <branch-name>::\n      ---initial-branch=<branch-name>::\n      +`-b` _<branch-name>_::\n     -+`--initial-branch=`{empty}__<branch-name>__::\n     ++++--initial-branch=++__<branch-name>__::\n       \n       Use _<branch-name>_ for the initial branch in the newly created\n       repository.  If not specified, fall back to the default name (currently\n     @@ Documentation/git-init.txt: repository.\n       customized via the `init.defaultBranch` configuration variable).\n       \n      ---shared[=(false|true|umask|group|all|world|everybody|<perm>)]::\n     -+`--shared`[`=`(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::\n     ++++--shared++[++=++(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::\n       \n       Specify that the Git repository is to be shared amongst several users.  This\n       allows users belonging to the same group to push into that\n     -@@ Documentation/git-init.txt: The option can have the following values, defaulting to `group` if no value\n     + repository.  When specified, the config variable `core.sharedRepository` is\n     + set so that files and directories under `$GIT_DIR` are created with the\n     + requested permissions.  When not specified, Git will use permissions reported\n     +-by `umask(2)`.\n     ++by `umask`(2).\n     + +\n     + The option can have the following values, defaulting to `group` if no value\n       is given:\n       +\n       --\n     @@ Documentation/git-init.txt: The option can have the following values, defaulting\n      +`umask`::\n      +`false`::\n       \n     - Use permissions reported by umask(2). The default, when `--shared` is not\n     +-Use permissions reported by umask(2). The default, when `--shared` is not\n     ++Use permissions reported by `umask`(2). The default, when `--shared` is not\n       specified.\n       \n      -group::\n     @@ Documentation/git-init.txt: The option can have the following values, defaulting\n      +`group`::\n      +`true`::\n       \n     - Make the repository group-writable, (and g+sx, since the git group may not be\n     +-Make the repository group-writable, (and g+sx, since the git group may not be\n     ++Make the repository group-writable, (and `g+sx`, since the git group may not be\n       the primary group of all users). This is used to loosen the permissions of an\n     -@@ Documentation/git-init.txt: permission bits (e.g. if umask is `0022`, using `group` will not remove read\n     +-otherwise safe umask(2) value. Note that the umask still applies to the other\n     ++otherwise safe `umask`(2) value. Note that the umask still applies to the other\n     + permission bits (e.g. if umask is `0022`, using `group` will not remove read\n       privileges from other (non-group) users). See `0xxx` for how to exactly specify\n       the repository permissions.\n       \n     @@ Documentation/git-init.txt: permission bits (e.g. if umask is `0022`, using `gro\n      +_<perm>_::\n       \n       _<perm>_ is a 3-digit octal number prefixed with `0` and each file\n     - will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n     +-will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n     ++will have mode _<perm>_. _<perm>_ will override users' `umask`(2)\n     + value (and not only loosen permissions as `group` and `all`\n     + do). `0640` will create a repository which is group-readable, but\n     + not group-writable or accessible to others. `0660` will create a repo\n 4:  5ae83d3f799 ! 4:  54c2012429d doc: git-clone: apply new documentation guidelines\n     @@ Metadata\n      Author: Jean-Noël Avila <jn.avila@free.fr>\n      \n       ## Commit message ##\n     -    doc: git-clone: apply new documentation guidelines\n     -\n     -    Heavily apply literal and placeholder markup everywhere.\n     +    doc: git-clone: apply new documentation formatting guidelines\n      \n          Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>\n      \n     @@ Documentation/config/clone.txt\n      -clone.defaultRemoteName::\n      +`clone.defaultRemoteName`::\n       \tThe name of the remote to create when cloning a repository.  Defaults to\n     --\t`origin`, and can be overridden by passing the `--origin` command-line\n     -+\t`origin`.\n     -+ifdef::git-clone[]\n     -+\tIt can be overridden by passing the `--origin` command-line\n     -+\toption.\n     -+endif::[]\n     -+ifndef::git-clone[]\n     -+\tIt can be overridden by passing the `--origin` command-line\n     + \t`origin`, and can be overridden by passing the `--origin` command-line\n       \toption to linkgit:git-clone[1].\n     -+endif::[]\n     -+`clone.rejectShallow`::\n     -+\tReject cloning a repository if it is a shallow one. This can be overridden by\n     -+\tpassing the `--reject-shallow` option on the command line.\n     -+ifndef::git-clone[]\n     -+\tSee linkgit:git-clone[1]\n     -+endif::[]\n       \n      -clone.rejectShallow::\n     --\tReject cloning a repository if it is a shallow one; this can be overridden by\n     --\tpassing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]\n     --\n     ++`clone.rejectShallow`::\n     + \tReject cloning a repository if it is a shallow one; this can be overridden by\n     + \tpassing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]\n     + \n      -clone.filterSubmodules::\n      +`clone.filterSubmodules`::\n       \tIf a partial clone filter is provided (see `--filter` in\n     @@ Documentation/git-clone.txt: git-clone - Clone a repository into a new directory\n      -\t  [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n      -\t  [--filter=<filter> [--also-filter-submodules]] [--] <repository>\n      -\t  [<directory>]\n     -+`git clone` [`--template=`{empty}__<template-directory>__]\n     ++`git clone` [++--template=++__<template-directory>__]\n      +\t  [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]\n      +\t  [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]\n      +\t  [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n      +\t  [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n     -+\t  [`--recurse-submodules`[`=`{empty}__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n     ++\t  [++--recurse-submodules++[++=++__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n      +\t  [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]\n     -+\t  [`--filter=`{empty}__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n     ++\t  [++--filter=++__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n      +\t  [_<directory>_]\n       \n       DESCRIPTION\n     @@ Documentation/git-clone.txt: objects from the source repository into a pack in t\n       \tstandard error stream is not directed to a terminal.\n       \n      ---server-option=<option>::\n     -+`--server-option=`{empty}__<option>__::\n     ++++--server-option=++__<option>__::\n       \tTransmit the given string to the server when communicating using\n       \tprotocol version 2.  The given string must not contain a NUL or LF\n       \tcharacter.  The server's handling of server options, including\n       \tunknown ones, is server-specific.\n      -\tWhen multiple `--server-option=<option>` are given, they are all\n     -+\tWhen multiple `--server-option=`{empty}__<option>__ are given, they are all\n     ++\tWhen multiple ++--server-option=++__<option>__ are given, they are all\n       \tsent to the other side in the order listed on the command line.\n       \n      --n::\n     @@ Documentation/git-clone.txt: objects from the source repository into a pack in t\n       \tworking directory as needed.\n       \n      ---filter=<filter-spec>::\n     -+`--filter=`{empty}__<filter-spec>__::\n     ++++--filter=++__<filter-spec>__::\n       \tUse the partial clone feature and request that the server sends\n       \ta subset of reachable objects according to a given object filter.\n       \tWhen using `--filter`, the supplied _<filter-spec>_ is used for\n       \tthe partial clone filter. For example, `--filter=blob:none` will\n       \tfilter out all blobs (file contents) until needed by Git. Also,\n      -\t`--filter=blob:limit=<size>` will filter out all blobs of size\n     -+\t`--filter=blob:limit=`{empty}__<size>__ will filter out all blobs of size\n     ++\t++--filter=blob:limit=++__<size>__ will filter out all blobs of size\n       \tat least _<size>_. For more details on filter specifications, see\n       \tthe `--filter` option in linkgit:git-rev-list[1].\n       \n     @@ Documentation/git-clone.txt: objects from the source repository into a pack in t\n       \trun on the other end.\n       \n      ---template=<template-directory>::\n     -+`--template=`{empty}__<template-directory>__::\n     ++++--template=++__<template-directory>__::\n       \tSpecify the directory from which templates will be used;\n       \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n       \n      --c <key>=<value>::\n      ---config <key>=<value>::\n     -+`-c` __<key>__{empty}`=`{empty}__<value>__::\n     -+`--config` __<key>__{empty}`=`{empty}__<value>__::\n     ++`-c` __<key>__++=++__<value>__::\n     ++`--config` __<key>__++=++__<value>__::\n       \tSet a configuration variable in the newly-created repository;\n       \tthis takes effect immediately after the repository is\n       \tinitialized, but before the remote history is fetched or any\n     @@ Documentation/git-clone.txt: objects from the source repository into a pack in t\n       variables do not take effect until after the initial fetch and checkout.\n       Configuration variables known to not take effect are:\n      -`remote.<name>.mirror` and `remote.<name>.tagOpt`.  Use the\n     -+`remote.`{empty}__<name>__{empty}`.mirror` and `remote.`{empty}__<name>__{empty}`.tagOpt`.  Use the\n     ++++remote.++__<name>__++.mirror++ and ++remote.++__<name>__++.tagOpt++.  Use the\n       corresponding `--mirror` and `--no-tags` options instead.\n       \n      ---depth <depth>::\n     @@ Documentation/git-clone.txt: objects from the source repository into a pack in t\n       \talso pass `--shallow-submodules`.\n       \n      ---shallow-since=<date>::\n     -+`--shallow-since=`{empty}__<date>__::\n     ++++--shallow-since=++__<date>__::\n       \tCreate a shallow clone with a history after the specified time.\n       \n      ---shallow-exclude=<revision>::\n     -+`--shallow-exclude=`{empty}__<revision>__::\n     ++++--shallow-exclude=++__<revision>__::\n       \tCreate a shallow clone with a history, excluding commits\n       \treachable from a specified remote branch or tag.  This option\n       \tcan be specified multiple times.\n     @@ Documentation/git-clone.txt: the clone is finished. This option is ignored if th\n       \tin the bundle will be stored under the hidden `refs/bundle/*`\n      \n       ## Documentation/urls.txt ##\n     +@@ Documentation/urls.txt: should be used with caution on unsecured networks.\n     + \n     + The following syntaxes may be used with them:\n     + \n     +-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/\n     +-- git://host.xz{startsb}:port{endsb}/path/to/repo.git/\n     +-- http{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/\n     +-- ftp{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/\n     ++- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n     ++- ++git://++__<host>__{startsb}:__<port>__{endsb}++/++__<path-to-git-repo>__\n     ++- ++http++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n     ++- ++ftp++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n     + \n     + An alternative scp-like syntax may also be used with the ssh protocol:\n     + \n     +-- {startsb}user@{endsb}host.xz:path/to/repo.git/\n     ++- {startsb}__<user>__++@++{endsb}__<host>__++:/++__<path-to-git-repo>__\n     + \n     + This syntax is only recognized if there are no slashes before the\n     + first colon. This helps differentiate a local path that contains a\n     +@@ Documentation/urls.txt: colon. For example the local path `foo:bar` could be specified as an\n     + absolute path or `./foo:bar` to avoid being misinterpreted as an ssh\n     + url.\n     + \n     +-The ssh and git protocols additionally support ~username expansion:\n     ++The ssh and git protocols additionally support ++~++__<username>__ expansion:\n     + \n     +-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/\n     +-- git://host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/\n     +-- {startsb}user@{endsb}host.xz:/~{startsb}user{endsb}/path/to/repo.git/\n     ++- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__\n     ++- ++git://++__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__\n     ++- {startsb}__<user>__++@++{endsb}__<host>__++:~++__<user>__++/++__<path-to-git-repo>__\n     + \n     + For local repositories, also supported by Git natively, the following\n     + syntaxes may be used:\n     + \n     +-- /path/to/repo.git/\n     +-- \\file:///path/to/repo.git/\n     ++- `/path/to/repo.git/`\n     ++- ++file:///path/to/repo.git/++\n     + \n     + ifndef::git-clone[]\n     + These two syntaxes are mostly equivalent, except when cloning, when\n      @@ Documentation/urls.txt: endif::git-clone[]\n       accept a suitable bundle file. See linkgit:git-bundle[1].\n       \n -:  ----------- > 5:  38bd78c92eb doc: git-clone: do not autoreference the manpage in itself\n\n-- \ngitgitgadget\n"},{"id":"491822","messageId":"8a25ab1c3b61ebea9942fe106d4e0547a81743a4.1711711181.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","subject":"[PATCH v2 1/5] doc: rework CodingGuidelines with new formatting rules","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:37Z","receivedAt":"2024-03-29T11:19:47Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nLiteral and placeholder formatting is more heavily enforced, with some\nasciidoc magic. Basically, the markup is preserved everywhere.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/CodingGuidelines | 153 ++++++++++++++++++---------------\n 1 file changed, 85 insertions(+), 68 deletions(-)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32e69f798ee..ab39509d59d 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -641,15 +641,15 @@ Writing Documentation:\n   - Prefer succinctness and matter-of-factly describing functionality\n     in the abstract.  E.g.\n \n-     --short:: Emit output in the short-format.\n+     `--short`:: Emit output in the short-format.\n \n     and avoid something like these overly verbose alternatives:\n \n-     --short:: Use this to emit output in the short-format.\n-     --short:: You can use this to get output in the short-format.\n-     --short:: A user who prefers shorter output could....\n-     --short:: Should a person and/or program want shorter output, he\n-               she/they/it can...\n+     `--short`:: Use this to emit output in the short-format.\n+     `--short`:: You can use this to get output in the short-format.\n+     `--short`:: A user who prefers shorter output could....\n+     `--short`:: Should a person and/or program want shorter output, he\n+                 she/they/it can...\n \n     This practice often eliminates the need to involve human actors in\n     your description, but it is a good practice regardless of the\n@@ -659,12 +659,12 @@ Writing Documentation:\n     addressing the hypothetical user, and possibly \"we\" when\n     discussing how the program might react to the user.  E.g.\n \n-      You can use this option instead of --xyz, but we might remove\n+      You can use this option instead of `--xyz`, but we might remove\n       support for it in future versions.\n \n     while keeping in mind that you can probably be less verbose, e.g.\n \n-      Use this instead of --xyz. This option might be removed in future\n+      Use this instead of `--xyz`. This option might be removed in future\n       versions.\n \n   - If you still need to refer to an example person that is\n@@ -682,68 +682,118 @@ Writing Documentation:\n  The same general rule as for code applies -- imitate the existing\n  conventions.\n \n- A few commented examples follow to provide reference when writing or\n- modifying command usage strings and synopsis sections in the manual\n- pages:\n \n- Placeholders are spelled in lowercase and enclosed in angle brackets:\n-   <file>\n-   --sort=<key>\n-   --abbrev[=<n>]\n+Markup:\n+\n+ Literal parts (e.g. use of command-line options, command names,\n+ branch names, URLs, pathnames (files and directories), configuration and\n+ environment variables) must be typeset as verbatim (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+   `umask`(2)\n+\n+ An environment variable must be prefixed with \"$\" only when referring to its\n+ value and not when referring to the variable itself, in this case there is\n+ nothing to add except the backticks:\n+   `GIT_DIR` is specified\n+   `$GIT_DIR/hooks/pre-receive`\n+\n+ Word phrases enclosed in `backtick characters` are rendered literally\n+ and will not be further expanded. The use of `backticks` to achieve the\n+ previous rule means that literal examples should not use AsciiDoc\n+ escapes.\n+   Correct:\n+      `--pretty=oneline`\n+   Incorrect:\n+      `\\--pretty=oneline`\n+\n+ Placeholders are spelled in lowercase and enclosed in\n+ angle brackets surrounded by underscores:\n+   _<file>_\n+   _<commit>_\n \n  If a placeholder has multiple words, they are separated by dashes:\n-   <new-branch-name>\n-   --template=<template-directory>\n+   _<new-branch-name>_\n+   _<template-directory>_\n+\n+ A placeholder is not enclosed in backticks, as it is not a literal.\n+\n+ When needed, use a distinctive identifier for placeholders, usually\n+ made of a qualification and a type:\n+   _<git-dir>_\n+   _<key-id>_\n+\n+ When literal and placeholders are mixed, each markup is applied for\n+ each sub-entity. If they are stuck, a special markup, called\n+ unconstrained formatting is required.\n+ Unconstrained formating for placeholders is __<like-this>__\n+ Unconstrained formatting for literal formatting is ++like this++\n+   `--jobs` _<n>_\n+   ++--sort=++__<key>__\n+   __<directory>__++/.git++\n+   ++remote.++__<name>__++.mirror++\n+\n+ caveat: ++ unconstrained format is not verbatim and may expand\n+ content. Use Asciidoc escapes inside them.\n \n- When a placeholder is cited in text paragraph, it is enclosed in angle\n- brackets to remind the reader the reference in the synopsis section.\n- For better visibility, the placeholder is typeset in italics:\n-   The _<file>_ to be added.\n+Synopsis Syntax\n+\n+ Syntax grammar is formatted neither as literal nor as placeholder.\n+\n+ A few commented examples follow to provide reference when writing or\n+ modifying command usage strings and synopsis sections in the manual\n+ pages:\n \n  Possibility of multiple occurrences is indicated by three dots:\n-   <file>...\n+   _<file>_...\n    (One or more of <file>.)\n \n  Optional parts are enclosed in square brackets:\n-   [<file>...]\n+   [_<file>_...]\n    (Zero or more of <file>.)\n \n-   --exec-path[=<path>]\n+   ++--exec-path++[++=++__<path>__]\n    (Option with an optional argument.  Note that the \"=\" is inside the\n    brackets.)\n \n-   [<patch>...]\n+   [_<patch>_...]\n    (Zero or more of <patch>.  Note that the dots are inside, not\n    outside the brackets.)\n \n  Multiple alternatives are indicated with vertical bars:\n-   [-q | --quiet]\n-   [--utf8 | --no-utf8]\n+   [`-q` | `--quiet`]\n+   [`--utf8` | `--no-utf8`]\n \n  Use spacing around \"|\" token(s), but not immediately after opening or\n  before closing a [] or () pair:\n-   Do: [-q | --quiet]\n-   Don't: [-q|--quiet]\n+   Do: [`-q` | `--quiet`]\n+   Don't: [`-q`|`--quiet`]\n \n  Don't use spacing around \"|\" tokens when they're used to separate the\n  alternate arguments of an option:\n-    Do: --track[=(direct|inherit)]\n-    Don't: --track[=(direct | inherit)]\n+    Do: ++--track++[++=++(`direct`|`inherit`)]`\n+    Don't: ++--track++[++=++(`direct` | `inherit`)]\n \n  Parentheses are used for grouping:\n-   [(<rev> | <range>)...]\n+   [(_<rev>_ | _<range>_)...]\n    (Any number of either <rev> or <range>.  Parens are needed to make\n    it clear that \"...\" pertains to both <rev> and <range>.)\n \n-   [(-p <parent>)...]\n+   [(`-p` _<parent>_)...]\n    (Any number of option -p, each with one <parent> argument.)\n \n-   git remote set-head <name> (-a | -d | <branch>)\n+   `git remote set-head` _<name>_ (`-a` | `-d` | _<branch>_)\n    (One and only one of \"-a\", \"-d\" or \"<branch>\" _must_ (no square\n    brackets) be provided.)\n \n  And a somewhat more contrived example:\n-   --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]\n+   `--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`\n    Here \"=\" is outside the brackets, because \"--diff-filter=\" is a\n    valid usage.  \"*\" has its own pair of brackets, because it can\n    (optionally) be specified only when one or more of the letters is\n@@ -754,39 +804,6 @@ Writing Documentation:\n    the user would type into a shell and use 'Git' (uppercase first letter)\n    when talking about the version control system and its properties.\n \n- A few commented examples follow to provide reference when writing or\n- modifying paragraphs or option/command explanations that contain options\n- or commands:\n-\n- Literal examples (e.g. use of command-line options, command names,\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- An environment variable must be prefixed with \"$\" only when referring to its\n- value and not when referring to the variable itself, in this case there is\n- nothing to add except the backticks:\n-   `GIT_DIR` is specified\n-   `$GIT_DIR/hooks/pre-receive`\n-\n- Word phrases enclosed in `backtick characters` are rendered literally\n- and will not be further expanded. The use of `backticks` to achieve the\n- previous rule means that literal examples should not use AsciiDoc\n- escapes.\n-   Correct:\n-      `--pretty=oneline`\n-   Incorrect:\n-      `\\--pretty=oneline`\n-\n-A placeholder is not enclosed in backticks, as it is not a literal.\n-\n  If some place in the documentation needs to typeset a command usage\n  example with inline substitutions, it is fine to use +monospaced and\n  inline substituted text+ instead of `monospaced literal text`, and with\n-- \ngitgitgadget\n\n"},{"id":"491823","messageId":"1a4feff2aea2e25dc11cbc83f94d0ac6a40964c5.1711711181.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","subject":"[PATCH v2 2/5] doc: allow literal and emphasis format in doc vs help tests","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:38Z","receivedAt":"2024-03-29T11:19:49Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nAs the new formatting of literal and placeholders is introduced,\nthe synopsis in the man pages can now hold additional markup with\nrespect to the command help.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n t/t0450-txt-doc-vs-help.sh | 4 +++-\n 1 file changed, 3 insertions(+), 1 deletion(-)\n\ndiff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh\nindex cd3969e852b..69917d7b845 100755\n--- a/t/t0450-txt-doc-vs-help.sh\n+++ b/t/t0450-txt-doc-vs-help.sh\n@@ -59,7 +59,9 @@ txt_to_synopsis () {\n \t\t-e '/^\\[verse\\]$/,/^$/ {\n \t\t\t/^$/d;\n \t\t\t/^\\[verse\\]$/d;\n-\n+\t\t\ts/_//g;\n+\t\t\ts/++//g;\n+\t\t\ts/`//g;\n \t\t\ts/{litdd}/--/g;\n \t\t\ts/'\\''\\(git[ a-z-]*\\)'\\''/\\1/g;\n \n-- \ngitgitgadget\n\n"},{"id":"491824","messageId":"ad7986e4c3918e2f8ebb35339fe11d1d5f58156a.1711711181.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","subject":"[PATCH v2 3/5] doc: git-init: apply new documentation formatting guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:39Z","receivedAt":"2024-03-29T11:19:50Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/config/init.txt |  4 +--\n Documentation/git-init.txt    | 56 +++++++++++++++++------------------\n 2 files changed, 30 insertions(+), 30 deletions(-)\n\ndiff --git a/Documentation/config/init.txt b/Documentation/config/init.txt\nindex dd1d8332737..af03acdbcbb 100644\n--- a/Documentation/config/init.txt\n+++ b/Documentation/config/init.txt\n@@ -3,8 +3,8 @@ ifndef::git-init[]\n :see-git-init: (See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n endif::[]\n \n-init.templateDir::\n+`init.templateDir`::\n \tSpecify the directory from which templates will be copied. {see-git-init}\n-init.defaultBranch::\n+`init.defaultBranch`::\n \tAllows overriding the default branch name e.g. when initializing\n \ta new repository.\ndiff --git a/Documentation/git-init.txt b/Documentation/git-init.txt\nindex 2f864e11ed9..daff93bd164 100644\n--- a/Documentation/git-init.txt\n+++ b/Documentation/git-init.txt\n@@ -9,11 +9,11 @@ git-init - Create an empty Git repository or reinitialize an existing one\n SYNOPSIS\n --------\n [verse]\n-'git init' [-q | --quiet] [--bare] [--template=<template-directory>]\n-\t  [--separate-git-dir <git-dir>] [--object-format=<format>]\n-\t  [--ref-format=<format>]\n-\t  [-b <branch-name> | --initial-branch=<branch-name>]\n-\t  [--shared[=<permissions>]] [<directory>]\n+`git init` [`-q` | `--quiet`] [`--bare`] [++--template=++__<template-directory>__]\n+\t  [`--separate-git-dir` _<git-dir>_] [++--object-format=++__<format>__]\n+\t  [++--ref-format=++__<format>__]\n+\t  [`-b` _<branch-name>_ | ++--initial-branch=++__<branch-name>__]\n+\t  [++--shared++[++=++__<permissions>__]] [_<directory>_]\n \n \n DESCRIPTION\n@@ -41,35 +41,35 @@ the repository to another place if `--separate-git-dir` is given).\n OPTIONS\n -------\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \n Only print error and warning messages; all other output will be suppressed.\n \n---bare::\n+`--bare`::\n \n Create a bare repository. If `GIT_DIR` environment is not set, it is set to the\n current working directory.\n \n---object-format=<format>::\n+++--object-format=++__<format>__::\n \n Specify the given object _<format>_ (hash algorithm) for the repository.  The valid\n values are `sha1` and (if enabled) `sha256`.  `sha1` is the default.\n +\n include::object-format-disclaimer.txt[]\n \n---ref-format=<format>::\n+++--ref-format=++__<format>__::\n \n Specify the given ref storage _<format>_ for the repository. The valid values are:\n +\n include::ref-storage-format.txt[]\n \n---template=<template-directory>::\n+++--template=++__<template-directory>__::\n \n Specify the directory from which templates will be used.  (See the \"TEMPLATE\n DIRECTORY\" section below.)\n \n---separate-git-dir=<git-dir>::\n+++--separate-git-dir=++__<git-dir>__::\n \n Instead of initializing the repository as a directory to either `$GIT_DIR` or\n `./.git/`, create a text file there containing the path to the actual\n@@ -78,53 +78,53 @@ repository.\n +\n If this is a reinitialization, the repository will be moved to the specified path.\n \n--b <branch-name>::\n---initial-branch=<branch-name>::\n+`-b` _<branch-name>_::\n+++--initial-branch=++__<branch-name>__::\n \n Use _<branch-name>_ for the initial branch in the newly created\n repository.  If not specified, fall back to the default name (currently\n `master`, but this is subject to change in the future; the name can be\n customized via the `init.defaultBranch` configuration variable).\n \n---shared[=(false|true|umask|group|all|world|everybody|<perm>)]::\n+++--shared++[++=++(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::\n \n Specify that the Git repository is to be shared amongst several users.  This\n allows users belonging to the same group to push into that\n repository.  When specified, the config variable `core.sharedRepository` is\n set so that files and directories under `$GIT_DIR` are created with the\n requested permissions.  When not specified, Git will use permissions reported\n-by `umask(2)`.\n+by `umask`(2).\n +\n The option can have the following values, defaulting to `group` if no value\n is given:\n +\n --\n-umask::\n-false::\n+`umask`::\n+`false`::\n \n-Use permissions reported by umask(2). The default, when `--shared` is not\n+Use permissions reported by `umask`(2). The default, when `--shared` is not\n specified.\n \n-group::\n-true::\n+`group`::\n+`true`::\n \n-Make the repository group-writable, (and g+sx, since the git group may not be\n+Make the repository group-writable, (and `g+sx`, since the git group may not be\n the primary group of all users). This is used to loosen the permissions of an\n-otherwise safe umask(2) value. Note that the umask still applies to the other\n+otherwise safe `umask`(2) value. Note that the umask still applies to the other\n permission bits (e.g. if umask is `0022`, using `group` will not remove read\n privileges from other (non-group) users). See `0xxx` for how to exactly specify\n the repository permissions.\n \n-all::\n-world::\n-everybody::\n+`all`::\n+`world`::\n+`everybody`::\n \n Same as `group`, but make the repository readable by all users.\n \n-<perm>::\n+_<perm>_::\n \n _<perm>_ is a 3-digit octal number prefixed with `0` and each file\n-will have mode _<perm>_. _<perm>_ will override users'`umask(2)`\n+will have mode _<perm>_. _<perm>_ will override users' `umask`(2)\n value (and not only loosen permissions as `group` and `all`\n do). `0640` will create a repository which is group-readable, but\n not group-writable or accessible to others. `0660` will create a repo\n-- \ngitgitgadget\n\n"},{"id":"491825","messageId":"38bd78c92eb4ed456c6d8a471bd29658bd30c47f.1711711182.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","subject":"[PATCH v2 5/5] doc: git-clone: do not autoreference the manpage in itself","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:41Z","receivedAt":"2024-03-29T11:19:52Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nAuto-reference in man pages is a confusion factor.\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/config/clone.txt | 14 ++++++++++++--\n 1 file changed, 12 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt\nindex 71a967f262d..0a10efd174e 100644\n--- a/Documentation/config/clone.txt\n+++ b/Documentation/config/clone.txt\n@@ -1,11 +1,21 @@\n `clone.defaultRemoteName`::\n \tThe name of the remote to create when cloning a repository.  Defaults to\n-\t`origin`, and can be overridden by passing the `--origin` command-line\n+\t`origin`.\n+ifdef::git-clone[]\n+\tIt can be overridden by passing the `--origin` command-line\n+\toption.\n+endif::[]\n+ifndef::git-clone[]\n+\tIt can be overridden by passing the `--origin` command-line\n \toption to linkgit:git-clone[1].\n+endif::[]\n \n `clone.rejectShallow`::\n \tReject cloning a repository if it is a shallow one; this can be overridden by\n-\tpassing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]\n+\tpassing the `--reject-shallow` option on the command line.\n+ifndef::git-clone[]\n+\tSee linkgit:git-clone[1].\n+endif::[]\n \n `clone.filterSubmodules`::\n \tIf a partial clone filter is provided (see `--filter` in\n-- \ngitgitgadget\n"},{"id":"491826","messageId":"54c2012429d5fcc6cf16acaa823e3fc8d9025dbf.1711711182.git.gitgitgadget@gmail.com","threadId":"61197","inReplyTo":"pull.1702.v2.git.1711711181.gitgitgadget@gmail.com","subject":"[PATCH v2 4/5] doc: git-clone: apply new documentation formatting guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-03-29T11:19:40Z","receivedAt":"2024-03-29T11:19:52Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>\n\nSigned-off-by: Jean-Noël Avila <jn.avila@free.fr>\n---\n Documentation/config/clone.txt |   6 +-\n Documentation/git-clone.txt    | 120 ++++++++++++++++-----------------\n Documentation/urls.txt         |  44 ++++++------\n 3 files changed, 86 insertions(+), 84 deletions(-)\n\ndiff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt\nindex d037b57f729..71a967f262d 100644\n--- a/Documentation/config/clone.txt\n+++ b/Documentation/config/clone.txt\n@@ -1,13 +1,13 @@\n-clone.defaultRemoteName::\n+`clone.defaultRemoteName`::\n \tThe name of the remote to create when cloning a repository.  Defaults to\n \t`origin`, and can be overridden by passing the `--origin` command-line\n \toption to linkgit:git-clone[1].\n \n-clone.rejectShallow::\n+`clone.rejectShallow`::\n \tReject cloning a repository if it is a shallow one; this can be overridden by\n \tpassing the `--reject-shallow` option on the command line. See linkgit:git-clone[1]\n \n-clone.filterSubmodules::\n+`clone.filterSubmodules`::\n \tIf a partial clone filter is provided (see `--filter` in\n \tlinkgit:git-rev-list[1]) and `--recurse-submodules` is used, also apply\n \tthe filter to submodules.\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex f90977a8519..5de18de2ab8 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -9,15 +9,15 @@ git-clone - Clone a repository into a new directory\n SYNOPSIS\n --------\n [verse]\n-'git clone' [--template=<template-directory>]\n-\t  [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n-\t  [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n-\t  [--dissociate] [--separate-git-dir <git-dir>]\n-\t  [--depth <depth>] [--[no-]single-branch] [--no-tags]\n-\t  [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n-\t  [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n-\t  [--filter=<filter> [--also-filter-submodules]] [--] <repository>\n-\t  [<directory>]\n+`git clone` [++--template=++__<template-directory>__]\n+\t  [`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]\n+\t  [`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]\n+\t  [`--dissociate`] [`--separate-git-dir` _<git-dir>_]\n+\t  [`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]\n+\t  [++--recurse-submodules++[++=++__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]\n+\t  [`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]\n+\t  [++--filter=++__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_\n+\t  [_<directory>_]\n \n DESCRIPTION\n -----------\n@@ -31,7 +31,7 @@ currently active branch.\n After the clone, a plain `git fetch` without arguments will update\n all the remote-tracking branches, and a `git pull` without\n arguments will in addition merge the remote master branch into the\n-current master branch, if any (this is untrue when \"--single-branch\"\n+current master branch, if any (this is untrue when `--single-branch`\n is given; see below).\n \n This default configuration is achieved by creating references to\n@@ -42,12 +42,12 @@ configuration variables.\n \n OPTIONS\n -------\n--l::\n---local::\n+`-l`::\n+`--local`::\n \tWhen the repository to clone from is on a local machine,\n \tthis flag bypasses the normal \"Git aware\" transport\n \tmechanism and clones the repository by making a copy of\n-\tHEAD and everything under objects and refs directories.\n+\t`HEAD` and everything under objects and refs directories.\n \tThe files under `.git/objects/` directory are hardlinked\n \tto save space when possible.\n +\n@@ -67,14 +67,14 @@ links.\n source repository, similar to running `cp -r src dst` while modifying\n `src`.\n \n---no-hardlinks::\n+`--no-hardlinks`::\n \tForce the cloning process from a repository on a local\n \tfilesystem to copy the files under the `.git/objects`\n \tdirectory instead of using hardlinks. This may be desirable\n \tif you are trying to make a back-up of your repository.\n \n--s::\n---shared::\n+`-s`::\n+`--shared`::\n \tWhen the repository to clone is on the local machine,\n \tinstead of using hard links, automatically setup\n \t`.git/objects/info/alternates` to share the objects\n@@ -101,7 +101,7 @@ If you want to break the dependency of a repository cloned with `--shared` on\n its source repository, you can simply run `git repack -a` to copy all\n objects from the source repository into a pack in the cloned repository.\n \n---reference[-if-able] <repository>::\n+`--reference`[`-if-able`] _<repository>_::\n \tIf the reference _<repository>_ is on the local machine,\n \tautomatically setup `.git/objects/info/alternates` to\n \tobtain objects from the reference _<repository>_.  Using\n@@ -115,7 +115,7 @@ objects from the source repository into a pack in the cloned repository.\n *NOTE*: see the NOTE for the `--shared` option, and also the\n `--dissociate` option.\n \n---dissociate::\n+`--dissociate`::\n \tBorrow the objects from reference repositories specified\n \twith the `--reference` options only to reduce network\n \ttransfer, and stop borrowing from them after a clone is made\n@@ -126,43 +126,43 @@ objects from the source repository into a pack in the cloned repository.\n \tsame repository, and this option can be used to stop the\n \tborrowing.\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \tOperate quietly.  Progress is not reported to the standard\n \terror stream.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tRun verbosely. Does not affect the reporting of progress status\n \tto the standard error stream.\n \n---progress::\n+`--progress`::\n \tProgress status is reported on the standard error stream\n \tby default when it is attached to a terminal, unless `--quiet`\n \tis specified. This flag forces progress status even if the\n \tstandard error stream is not directed to a terminal.\n \n---server-option=<option>::\n+++--server-option=++__<option>__::\n \tTransmit the given string to the server when communicating using\n \tprotocol version 2.  The given string must not contain a NUL or LF\n \tcharacter.  The server's handling of server options, including\n \tunknown ones, is server-specific.\n-\tWhen multiple `--server-option=<option>` are given, they are all\n+\tWhen multiple ++--server-option=++__<option>__ are given, they are all\n \tsent to the other side in the order listed on the command line.\n \n--n::\n---no-checkout::\n+`-n`::\n+`--no-checkout`::\n \tNo checkout of HEAD is performed after the clone is complete.\n \n---[no-]reject-shallow::\n+`--`[`no-`]`reject-shallow`::\n \tFail if the source repository is a shallow repository.\n \tThe `clone.rejectShallow` configuration variable can be used to\n \tspecify the default.\n \n---bare::\n+`--bare`::\n \tMake a 'bare' Git repository.  That is, instead of\n \tcreating _<directory>_ and placing the administrative\n-\tfiles in `<directory>/.git`, make the _<directory>_\n+\tfiles in _<directory>_`/.git`, make the _<directory>_\n \titself the `$GIT_DIR`. This obviously implies the `--no-checkout`\n \tbecause there is nowhere to check out the working tree.\n \tAlso the branch heads at the remote are copied directly\n@@ -171,28 +171,28 @@ objects from the source repository into a pack in the cloned repository.\n \tused, neither remote-tracking branches nor the related\n \tconfiguration variables are created.\n \n---sparse::\n+`--sparse`::\n \tEmploy a sparse-checkout, with only files in the toplevel\n \tdirectory initially being present.  The\n \tlinkgit:git-sparse-checkout[1] command can be used to grow the\n \tworking directory as needed.\n \n---filter=<filter-spec>::\n+++--filter=++__<filter-spec>__::\n \tUse the partial clone feature and request that the server sends\n \ta subset of reachable objects according to a given object filter.\n \tWhen using `--filter`, the supplied _<filter-spec>_ is used for\n \tthe partial clone filter. For example, `--filter=blob:none` will\n \tfilter out all blobs (file contents) until needed by Git. Also,\n-\t`--filter=blob:limit=<size>` will filter out all blobs of size\n+\t++--filter=blob:limit=++__<size>__ will filter out all blobs of size\n \tat least _<size>_. For more details on filter specifications, see\n \tthe `--filter` option in linkgit:git-rev-list[1].\n \n---also-filter-submodules::\n+`--also-filter-submodules`::\n \tAlso apply the partial clone filter to any submodules in the repository.\n \tRequires `--filter` and `--recurse-submodules`. This can be turned on by\n \tdefault by setting the `clone.filterSubmodules` config option.\n \n---mirror::\n+`--mirror`::\n \tSet up a mirror of the source repository.  This implies `--bare`.\n \tCompared to `--bare`, `--mirror` not only maps local branches of the\n \tsource to local branches of the target, it maps all refs (including\n@@ -200,14 +200,14 @@ objects from the source repository into a pack in the cloned repository.\n \tthat all these refs are overwritten by a `git remote update` in the\n \ttarget repository.\n \n--o <name>::\n---origin <name>::\n+`-o` _<name>_::\n+`--origin` _<name>_::\n \tInstead of using the remote name `origin` to keep track of the upstream\n \trepository, use _<name>_.  Overrides `clone.defaultRemoteName` from the\n \tconfig.\n \n--b <name>::\n---branch <name>::\n+`-b` _<name>_::\n+`--branch` _<name>_::\n \tInstead of pointing the newly created HEAD to the branch pointed\n \tto by the cloned repository's HEAD, point to _<name>_ branch\n \tinstead. In a non-bare repository, this is the branch that will\n@@ -215,18 +215,18 @@ objects from the source repository into a pack in the cloned repository.\n \t`--branch` can also take tags and detaches the HEAD at that commit\n \tin the resulting repository.\n \n--u <upload-pack>::\n---upload-pack <upload-pack>::\n+`-u` _<upload-pack>_::\n+`--upload-pack` _<upload-pack>_::\n \tWhen given, and the repository to clone from is accessed\n \tvia ssh, this specifies a non-default path for the command\n \trun on the other end.\n \n---template=<template-directory>::\n+++--template=++__<template-directory>__::\n \tSpecify the directory from which templates will be used;\n \t(See the \"TEMPLATE DIRECTORY\" section of linkgit:git-init[1].)\n \n--c <key>=<value>::\n---config <key>=<value>::\n+`-c` __<key>__++=++__<value>__::\n+`--config` __<key>__++=++__<value>__::\n \tSet a configuration variable in the newly-created repository;\n \tthis takes effect immediately after the repository is\n \tinitialized, but before the remote history is fetched or any\n@@ -239,25 +239,25 @@ objects from the source repository into a pack in the cloned repository.\n Due to limitations of the current implementation, some configuration\n variables do not take effect until after the initial fetch and checkout.\n Configuration variables known to not take effect are:\n-`remote.<name>.mirror` and `remote.<name>.tagOpt`.  Use the\n+++remote.++__<name>__++.mirror++ and ++remote.++__<name>__++.tagOpt++.  Use the\n corresponding `--mirror` and `--no-tags` options instead.\n \n---depth <depth>::\n+`--depth` _<depth>_::\n \tCreate a 'shallow' clone with a history truncated to the\n \tspecified number of commits. Implies `--single-branch` unless\n \t`--no-single-branch` is given to fetch the histories near the\n \ttips of all branches. If you want to clone submodules shallowly,\n \talso pass `--shallow-submodules`.\n \n---shallow-since=<date>::\n+++--shallow-since=++__<date>__::\n \tCreate a shallow clone with a history after the specified time.\n \n---shallow-exclude=<revision>::\n+++--shallow-exclude=++__<revision>__::\n \tCreate a shallow clone with a history, excluding commits\n \treachable from a specified remote branch or tag.  This option\n \tcan be specified multiple times.\n \n---[no-]single-branch::\n+`--`[`no-`]`single-branch`::\n \tClone only the history leading to the tip of a single branch,\n \teither specified by the `--branch` option or the primary\n \tbranch remote's `HEAD` points at.\n@@ -267,7 +267,7 @@ corresponding `--mirror` and `--no-tags` options instead.\n \tbranch when `--single-branch` clone was made, no remote-tracking\n \tbranch is created.\n \n---no-tags::\n+`--no-tags`::\n \tDon't clone any tags, and set\n \t`remote.<remote>.tagOpt=--no-tags` in the config, ensuring\n \tthat future `git pull` and `git fetch` operations won't follow\n@@ -279,7 +279,7 @@ maintain a branch with no references other than a single cloned\n branch. This is useful e.g. to maintain minimal clones of the default\n branch of some repository for search indexing.\n \n---recurse-submodules[=<pathspec>]::\n+`--recurse-submodules`[`=`{empty}__<pathspec>__]::\n \tAfter the clone is created, initialize and clone submodules\n \twithin based on the provided _<pathspec>_.  If no _=<pathspec>_ is\n \tprovided, all submodules are initialized and cloned.\n@@ -295,46 +295,46 @@ the clone is finished. This option is ignored if the cloned repository does\n not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,\n or `--mirror` is given)\n \n---[no-]shallow-submodules::\n+`--`[`no-`]`shallow-submodules`::\n \tAll submodules which are cloned will be shallow with a depth of 1.\n \n---[no-]remote-submodules::\n+`--`[`no-`]`remote-submodules`::\n \tAll submodules which are cloned will use the status of the submodule's\n \tremote-tracking branch to update the submodule, rather than the\n \tsuperproject's recorded SHA-1. Equivalent to passing `--remote` to\n \t`git submodule update`.\n \n---separate-git-dir=<git-dir>::\n+`--separate-git-dir=`{empty}__<git-dir>__::\n \tInstead of placing the cloned repository where it is supposed\n \tto be, place the cloned repository at the specified directory,\n \tthen make a filesystem-agnostic Git symbolic link to there.\n \tThe result is Git repository can be separated from working\n \ttree.\n \n---ref-format=<ref-format>::\n+`--ref-format=`{empty}__<ref-format>__::\n \n Specify the given ref storage format for the repository. The valid values are:\n +\n include::ref-storage-format.txt[]\n \n--j <n>::\n---jobs <n>::\n+`-j` _<n>_::\n+`--jobs` _<n>_::\n \tThe number of submodules fetched at the same time.\n \tDefaults to the `submodule.fetchJobs` option.\n \n-<repository>::\n+_<repository>_::\n \tThe (possibly remote) _<repository>_ to clone from.  See the\n \t<<URLS,GIT URLS>> section below for more information on specifying\n \trepositories.\n \n-<directory>::\n+_<directory>_::\n \tThe name of a new directory to clone into.  The \"humanish\"\n \tpart of the source repository is used if no _<directory>_ is\n \texplicitly given (`repo` for `/path/to/repo.git` and `foo`\n \tfor `host.xz:foo/.git`).  Cloning into an existing directory\n \tis only allowed if the directory is empty.\n \n---bundle-uri=<uri>::\n+`--bundle-uri=`{empty}__<uri>__::\n \tBefore fetching from the remote, fetch a bundle from the given\n \t_<uri>_ and unbundle the data into the local repository. The refs\n \tin the bundle will be stored under the hidden `refs/bundle/*`\ndiff --git a/Documentation/urls.txt b/Documentation/urls.txt\nindex 0b9e0c4302d..7cec85aef17 100644\n--- a/Documentation/urls.txt\n+++ b/Documentation/urls.txt\n@@ -15,14 +15,14 @@ should be used with caution on unsecured networks.\n \n The following syntaxes may be used with them:\n \n-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/\n-- git://host.xz{startsb}:port{endsb}/path/to/repo.git/\n-- http{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/\n-- ftp{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/\n+- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n+- ++git://++__<host>__{startsb}:__<port>__{endsb}++/++__<path-to-git-repo>__\n+- ++http++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n+- ++ftp++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__\n \n An alternative scp-like syntax may also be used with the ssh protocol:\n \n-- {startsb}user@{endsb}host.xz:path/to/repo.git/\n+- {startsb}__<user>__++@++{endsb}__<host>__++:/++__<path-to-git-repo>__\n \n This syntax is only recognized if there are no slashes before the\n first colon. This helps differentiate a local path that contains a\n@@ -30,17 +30,17 @@ colon. For example the local path `foo:bar` could be specified as an\n absolute path or `./foo:bar` to avoid being misinterpreted as an ssh\n url.\n \n-The ssh and git protocols additionally support ~username expansion:\n+The ssh and git protocols additionally support ++~++__<username>__ expansion:\n \n-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/\n-- git://host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/\n-- {startsb}user@{endsb}host.xz:/~{startsb}user{endsb}/path/to/repo.git/\n+- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__\n+- ++git://++__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__\n+- {startsb}__<user>__++@++{endsb}__<host>__++:~++__<user>__++/++__<path-to-git-repo>__\n \n For local repositories, also supported by Git natively, the following\n syntaxes may be used:\n \n-- /path/to/repo.git/\n-- \\file:///path/to/repo.git/\n+- `/path/to/repo.git/`\n+- ++file:///path/to/repo.git/++\n \n ifndef::git-clone[]\n These two syntaxes are mostly equivalent, except when cloning, when\n@@ -57,11 +57,11 @@ endif::git-clone[]\n accept a suitable bundle file. See linkgit:git-bundle[1].\n \n When Git doesn't know how to handle a certain transport protocol, it\n-attempts to use the `remote-<transport>` remote helper, if one\n+attempts to use the `remote-`{empty}__<transport>__ remote helper, if one\n exists. To explicitly request a remote helper, the following syntax\n may be used:\n \n-- _<transport>_::_<address>_\n+- _<transport>_::__<address>__\n \n where _<address>_ may be a path, a server and path, or an arbitrary\n URL-like string recognized by the specific remote helper being\n@@ -72,10 +72,11 @@ you want to use a different format for them (such that the URLs you\n use will be rewritten into URLs that work), you can create a\n configuration section of the form:\n \n-------------\n-\t[url \"<actual-url-base>\"]\n-\t\tinsteadOf = <other-url-base>\n-------------\n+[verse]\n+--\n+\t[url \"__<actual-url-base>__\"]\n+\t\tinsteadOf = _<other-url-base>_\n+--\n \n For example, with this:\n \n@@ -91,10 +92,11 @@ rewritten in any context that takes a URL to be \"git://git.host.xz/repo.git\".\n If you want to rewrite URLs for push only, you can create a\n configuration section of the form:\n \n-------------\n-\t[url \"<actual-url-base>\"]\n-\t\tpushInsteadOf = <other-url-base>\n-------------\n+[verse]\n+--\n+\t[url \"__<actual-url-base>__\"]\n+\t\tpushInsteadOf = _<other-url-base>_\n+--\n \n For example, with this:\n \n-- \ngitgitgadget\n\n"},{"id":"491842","messageId":"CAPig+cSzqUcTfnHBFTQWxjMbUZQBKahpD7eafmL=QvUDYtXTpw@mail.gmail.com","threadId":"61197","inReplyTo":"8a25ab1c3b61ebea9942fe106d4e0547a81743a4.1711711181.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 1/5] doc: rework CodingGuidelines with new formatting rules","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2024-03-29T18:42:28Z","receivedAt":"2024-03-29T18:42:39Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Fri, Mar 29, 2024 at 7:19 AM Jean-Noël Avila via GitGitGadget\n<gitgitgadget@gmail.com> wrote:\n> Literal and placeholder formatting is more heavily enforced, with some\n> asciidoc magic. Basically, the markup is preserved everywhere.\n>\n> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>\n> ---\n> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> @@ -682,68 +682,118 @@ Writing Documentation:\n>   If a placeholder has multiple words, they are separated by dashes:\n> -   <new-branch-name>\n> -   --template=<template-directory>\n> +   _<new-branch-name>_\n> +   _<template-directory>_\n\nHaving two separate examples made sense in the original because it was\nillustrating a standalone placeholder versus a placeholder coupled\nwith some literal text (\"--template=\"). However, in the revised hunk,\nthere is no reason to use both \"_<new-branch-name>_\" and\n\"_<template-directory>_\" as examples; the reader does not learn\nanything new from the second example which couldn't be learned from\nthe first. As such, I'd drop the latter example.\n"},{"id":"491894","messageId":"12414787.O9o76ZdvQC@cayenne","threadId":"61197","inReplyTo":"CAPig+cSzqUcTfnHBFTQWxjMbUZQBKahpD7eafmL=QvUDYtXTpw@mail.gmail.com","subject":"Re: [PATCH v2 1/5] doc: rework CodingGuidelines with new formatting rules","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2024-03-30T17:36:57Z","receivedAt":"2024-03-30T17:37:25Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Friday, 29 March 2024 19:42:28 CET Eric Sunshine wrote:\n> On Fri, Mar 29, 2024 at 7:19 AM Jean-Noël Avila via GitGitGadget\n> <gitgitgadget@gmail.com> wrote:\n> > Literal and placeholder formatting is more heavily enforced, with some\n> > asciidoc magic. Basically, the markup is preserved everywhere.\n> >\n> > Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>\n> > ---\n> > diff --git a/Documentation/CodingGuidelines b/Documentation/\nCodingGuidelines\n> > @@ -682,68 +682,118 @@ Writing Documentation:\n> >   If a placeholder has multiple words, they are separated by dashes:\n> > -   <new-branch-name>\n> > -   --template=<template-directory>\n> > +   _<new-branch-name>_\n> > +   _<template-directory>_\n> \n> Having two separate examples made sense in the original because it was\n> illustrating a standalone placeholder versus a placeholder coupled\n> with some literal text (\"--template=\"). However, in the revised hunk,\n> there is no reason to use both \"_<new-branch-name>_\" and\n> \"_<template-directory>_\" as examples; the reader does not learn\n> anything new from the second example which couldn't be learned from\n> the first. As such, I'd drop the latter example.\n> \n\nA few examples don't hurt. Anyway, if I have to reroll a v3, I'll remove \n_<template-directory>_ which would be better located in the next paragraph.\n\n\n\n\n"}]}