{"thread":{"id":"64658","subject":"[PATCH 0/5] doc: convert git-status, git remote and git stage to synopsis style","startedAt":"2025-12-20T19:16:30Z","lastAt":"2025-12-20T19:16:39Z","messageCount":6,"participants":["Jean-Noël Avila via GitGitGadget"],"isPatch":true,"patchVersion":1,"patchTotal":5},"messages":[{"id":"532597","messageId":"pull.2020.git.1766258187.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":null,"subject":"[PATCH 0/5] doc: convert git-status, git remote and git stage to synopsis style","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:22Z","receivedAt":"2025-12-20T19:16:30Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"The changes are basically the expected stuff for synopsis conversion, and a\nfew cases of \"imperative mood\" style.\n\nAdditionally, this series has two special commits\n\n * fix to the comparison of synopsis and help, to allow using synopsis\n paragraph elsewhere in manpages\n * the \"ascii art\" tables in git-status are converted to plain asciidoc\n tables. The alignment output is managed by the asciidoc processor.\n\nThe second patch is a RFC as to whether we should convert our tables or not.\nFor the translations of the manual pages, this setup simplifies the\nmaintenance, because we are able to export each table cell as a separate\nsegment.\n\nJean-Noël Avila (5):\n doc: fix t0450-txt-doc-vs-help to select only first synopsis block\n doc: convert git-status to synopsis style\n doc: convert git-status tables to AsciiDoc format\n doc: convert git stage to use synopsis block\n doc: convert git-remote to synopsis style\n\n Documentation/git-remote.adoc | 106 +++++-----\n Documentation/git-stage.adoc | 4 +-\n Documentation/git-status.adoc | 356 +++++++++++++++++-----------------\n t/t0450-txt-doc-vs-help.sh | 2 +-\n 4 files changed, 238 insertions(+), 230 deletions(-)\n\n\nbase-commit: c4a0c8845e2426375ad257b6c221a3a7d92ecfda\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-2020%2Fjnavila%2Fdoc_git_status-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2020/jnavila/doc_git_status-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/2020\n-- \ngitgitgadget\n"},{"id":"532598","messageId":"d470451c92b195f2b25f584722573bed1b54a154.1766258187.git.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":"pull.2020.git.1766258187.gitgitgadget@gmail.com","subject":"[PATCH 1/5] doc: fix t0450-txt-doc-vs-help to select only first synopsis block","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:23Z","receivedAt":"2025-12-20T19:16:32Z","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?= \n\nIn case there are multiple synopsis blocks (declared with [synopsis]\nor [verse] style) in the same file, the previous implementation was\nincorrectly picking up text from all the blocks until the first empty\nline. This commit modifies the sed command to stop processing upon\nencountering the first empty line after the first block declaration,\nthereby ensuring that only the intended block is captured.\n\nSigned-off-by: Jean-Noël Avila \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 e12e18f97f..822b0d55a5 100755\n--- a/t/t0450-txt-doc-vs-help.sh\n+++ b/t/t0450-txt-doc-vs-help.sh\n@@ -56,7 +56,7 @@ adoc_to_synopsis () {\n \tb2t=\"$(builtin_to_adoc \"$builtin\")\" &&\n \tsed -n \\\n \t\t-E '/^\\[(verse|synopsis)\\]$/,/^$/ {\n-\t\t\t/^$/d;\n+\t\t\t/^$/q;\n \t\t\t/^\\[(verse|synopsis)\\]$/d;\n \t\t\ts/\\{litdd\\}/--/g;\n \t\t\ts/'\\''(git[ a-z-]*)'\\''/\\1/g;\n-- \ngitgitgadget\n\n"},{"id":"532599","messageId":"08f3bb0e36f0fc67dae3767211b97439a80980a1.1766258187.git.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":"pull.2020.git.1766258187.gitgitgadget@gmail.com","subject":"[PATCH 2/5] doc: convert git-status to synopsis style","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:24Z","receivedAt":"2025-12-20T19:16:34Z","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?= \n\nAlso convert unformatted lists to proper AsciiDoc lists.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-status.adoc | 182 ++++++++++++++++++----------------\n 1 file changed, 95 insertions(+), 87 deletions(-)\n\ndiff --git a/Documentation/git-status.adoc b/Documentation/git-status.adoc\nindex 9a376886a5..37b0453898 100644\n--- a/Documentation/git-status.adoc\n+++ b/Documentation/git-status.adoc\n@@ -8,8 +8,9 @@ git-status - Show the working tree status\n \n SYNOPSIS\n --------\n-[verse]\n-'git status' [] [--] [...]\n+\n+[synopsis]\n+git status [] [--] [...]\n \n DESCRIPTION\n -----------\n@@ -18,57 +19,57 @@ current HEAD commit, paths that have differences between the working\n tree and the index file, and paths in the working tree that are not\n tracked by Git (and are not ignored by linkgit:gitignore[5]). The first\n are what you _would_ commit by running `git commit`; the second and\n-third are what you _could_ commit by running 'git add' before running\n+third are what you _could_ commit by running `git add` before running\n `git commit`.\n \n OPTIONS\n -------\n \n--s::\n---short::\n+`-s`::\n+`--short`::\n \tGive the output in the short-format.\n \n--b::\n---branch::\n+`-b`::\n+`--branch`::\n \tShow the branch and tracking info even in short-format.\n \n---show-stash::\n+`--show-stash`::\n \tShow the number of entries currently stashed away.\n \n---porcelain[=]::\n+`--porcelain[=]`::\n \tGive the output in an easy-to-parse format for scripts.\n \tThis is similar to the short output, but will remain stable\n \tacross Git versions and regardless of user configuration. See\n \tbelow for details.\n +\n-The version parameter is used to specify the format version.\n-This is optional and defaults to the original version 'v1' format.\n+The __ parameter is used to specify the format version.\n+This is optional and defaults to the original version `v1` format.\n \n---long::\n+`--long`::\n \tGive the output in the long-format. This is the default.\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tIn addition to the names of files that have been changed, also\n \tshow the textual changes that are staged to be committed\n \t(i.e., like the output of `git diff --cached`). If `-v` is specified\n \ttwice, then also show the changes in the working tree that\n \thave not yet been staged (i.e., like the output of `git diff`).\n \n--u[]::\n---untracked-files[=]::\n+`-u[]`::\n+`--untracked-files[=]`::\n \tShow untracked files.\n +\n --\n The mode parameter is used to specify the handling of untracked files.\n-It is optional: it defaults to 'all', and if specified, it must be\n+It is optional: it defaults to `all`, and if specified, it must be\n stuck to the option (e.g. `-uno`, but not `-u no`).\n \n The possible options are:\n \n-\t- 'no' - Show no untracked files.\n-\t- 'normal' - Shows untracked files and directories.\n-\t- 'all' - Also shows individual files in untracked directories.\n+`no`:: Show no untracked files.\n+`normal`:: Show untracked files and directories.\n+`all`:: Also show individual files in untracked directories.\n \n When `-u` option is not used, untracked files and directories are\n shown (i.e. the same as specifying `normal`), to help you avoid\n@@ -82,76 +83,78 @@ return more quickly without showing untracked files.\n All usual spellings for Boolean value `true` are taken as `normal`\n and `false` as `no`.\n \n-The default can be changed using the status.showUntrackedFiles\n+The default can be changed using the `status.showUntrackedFiles`\n configuration variable documented in linkgit:git-config[1].\n --\n \n---ignore-submodules[=]::\n-\tIgnore changes to submodules when looking for changes. can be\n-\teither \"none\", \"untracked\", \"dirty\" or \"all\", which is the default.\n-\tUsing \"none\" will consider the submodule modified when it either contains\n+`--ignore-submodules[=]`::\n+\tIgnore changes to submodules when looking for changes. __ can be\n+\teither `none`, `untracked`, `dirty` or `all`, which is the default.\n+`none`;; will consider the submodule modified when it either contains\n \tuntracked or modified files or its HEAD differs from the commit recorded\n \tin the superproject and can be used to override any settings of the\n-\t'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When\n-\t\"untracked\" is used submodules are not considered dirty when they only\n+\t`ignore` option in linkgit:git-config[1] or linkgit:gitmodules[5].\n+`untracked`;; submodules are not considered dirty when they only\n \tcontain untracked content (but they are still scanned for modified\n-\tcontent). Using \"dirty\" ignores all changes to the work tree of submodules,\n+\tcontent).\n+`dirty`;; ignore all changes to the work tree of submodules,\n \tonly changes to the commits stored in the superproject are shown (this was\n-\tthe behavior before 1.7.0). Using \"all\" hides all changes to submodules\n+\tthe behavior before 1.7.0).\n+`all`;; hide all changes to submodules\n \t(and suppresses the output of submodule summaries when the config option\n \t`status.submoduleSummary` is set).\n \n---ignored[=]::\n+`--ignored[=]`::\n \tShow ignored files as well.\n +\n --\n The mode parameter is used to specify the handling of ignored files.\n-It is optional: it defaults to 'traditional'.\n+It is optional: it defaults to `traditional`.\n \n The possible options are:\n \n-\t- 'traditional' - Shows ignored files and directories, unless\n-\t\t\t --untracked-files=all is specified, in which case\n-\t\t\t individual files in ignored directories are\n-\t\t\t displayed.\n-\t- 'no'\t - Show no ignored files.\n-\t- 'matching' - Shows ignored files and directories matching an\n-\t\t\t ignore pattern.\n-\n-When 'matching' mode is specified, paths that explicitly match an\n+`traditional`:: Show ignored files and directories, unless\n+`--untracked-files=all` is specified, in which case\n+ individual files in ignored directories are\n+ displayed.\n+`no`:: Show no ignored files.\n+`matching`:: Show ignored files and directories matching an\n+ignore pattern.\n++\n+Paths that explicitly match an\n ignored pattern are shown. If a directory matches an ignore pattern,\n then it is shown, but not paths contained in the ignored directory. If\n a directory does not match an ignore pattern, but all contents are\n ignored, then the directory is not shown, but all contents are shown.\n --\n \n--z::\n-\tTerminate entries with NUL, instead of LF. This implies\n+`-z`::\n+\tTerminate entries with _NUL_, instead of _LF_. This implies\n \tthe `--porcelain=v1` output format if no other format is given.\n \n---column[=]::\n---no-column::\n+`--column[=]`::\n+`--no-column`::\n \tDisplay untracked files in columns. See configuration variable\n \t`column.status` for option syntax. `--column` and `--no-column`\n-\twithout options are equivalent to 'always' and 'never'\n+\twithout options are equivalent to `always` and `never`\n \trespectively.\n \n---ahead-behind::\n---no-ahead-behind::\n+`--ahead-behind`::\n+`--no-ahead-behind`::\n \tDisplay or do not display detailed ahead/behind counts for the\n-\tbranch relative to its upstream branch. Defaults to true.\n+\tbranch relative to its upstream branch. Defaults to `true`.\n \n---renames::\n---no-renames::\n+`--renames`::\n+`--no-renames`::\n \tTurn on/off rename detection regardless of user configuration.\n \tSee also linkgit:git-diff[1] `--no-renames`.\n \n---find-renames[=]::\n+`--find-renames[=]`::\n \tTurn on rename detection, optionally setting the similarity\n \tthreshold.\n \tSee also linkgit:git-diff[1] `--find-renames`.\n \n-...::\n+`...`::\n \tSee the 'pathspec' entry in linkgit:gitglossary[7].\n \n OUTPUT\n@@ -173,12 +176,12 @@ Short Format\n In the short-format, the status of each path is shown as one of these\n forms\n \n-\tXY PATH\n-\tXY ORIG_PATH -> PATH\n+\t \n+\t -> \n \n-where `ORIG_PATH` is where the renamed/copied contents came\n-from. `ORIG_PATH` is only shown when the entry is renamed or\n-copied. The `XY` is a two-letter status code.\n+where __ is where the renamed/copied contents came\n+from. __ is only shown when the entry is renamed or\n+copied. The __ is a two-letter status code `XY`.\n \n The fields (including the `->`) are separated from each other by a\n single space. If a filename contains whitespace or other nonprintable\n@@ -187,7 +190,7 @@ literal: surrounded by ASCII double quote (34) characters, and with\n interior special characters backslash-escaped.\n \n There are three different types of states that are shown using this format, and\n-each one uses the `XY` syntax differently:\n+each one uses the __ syntax differently:\n \n * When a merge is occurring and the merge was successful, or outside of a merge\n \tsituation, `X` shows the status of the index and `Y` shows the status of the\n@@ -207,14 +210,14 @@ In the following table, these three classes are shown in separate sections, and\n these characters are used for `X` and `Y` fields for the first two sections that\n show tracked paths:\n \n-* ' ' = unmodified\n-* 'M' = modified\n-* 'T' = file type changed (regular file, symbolic link or submodule)\n-* 'A' = added\n-* 'D' = deleted\n-* 'R' = renamed\n-* 'C' = copied (if config option status.renames is set to \"copies\")\n-* 'U' = updated but unmerged\n+' ':: unmodified\n+`M`:: modified\n+`T`:: file type changed (regular file, symbolic link or submodule)\n+`A`:: added\n+`D`:: deleted\n+`R`:: renamed\n+`C`:: copied (if config option status.renames is set to \"copies\")\n+`U`:: updated but unmerged\n \n ....\n X Y Meaning\n@@ -248,19 +251,21 @@ U U unmerged, both modified\n \n Submodules have more state and instead report\n \n-* 'M' = the submodule has a different HEAD than recorded in the index\n-* 'm' = the submodule has modified content\n-* '?' = the submodule has untracked files\n+`M`:: the submodule has a different HEAD than recorded in the index\n+`m`:: the submodule has modified content\n+`?`:: the submodule has untracked files\n \n This is since modified content or untracked files in a submodule cannot be added\n via `git add` in the superproject to prepare a commit.\n \n-'m' and '?' are applied recursively. For example if a nested submodule\n-in a submodule contains an untracked file, this is reported as '?' as well.\n+`m` and `?` are applied recursively. For example if a nested submodule\n+in a submodule contains an untracked file, this is reported as `?` as well.\n+\n+If `-b` is used the short-format status is preceded by a line\n \n-If -b is used the short-format status is preceded by a line\n+[synopsis]\n+{empty}## \n \n- ## branchname tracking info\n \n Porcelain Format Version 1\n ~~~~~~~~~~~~~~~~~~~~~~~~~~\n@@ -271,16 +276,16 @@ based on user configuration. This makes it ideal for parsing by scripts.\n The description of the short format above also describes the porcelain\n format, with a few exceptions:\n \n-1. The user's color.status configuration is not respected; color will\n+1. The user's `color.status` configuration is not respected; color will\n always be off.\n \n-2. The user's status.relativePaths configuration is not respected; paths\n+2. The user's `status.relativePaths` configuration is not respected; paths\n shown will always be relative to the repository root.\n \n-There is also an alternate -z format recommended for machine parsing. In\n+There is also an alternate `-z` format recommended for machine parsing. In\n that format, the status field is the same, but some other things\n-change. First, the '\\->' is omitted from rename entries and the field\n-order is reversed (e.g 'from \\-> to' becomes 'to from'). Second, a NUL\n+change. First, the `->` is omitted from rename entries and the field\n+order is reversed (e.g `from -> to` becomes `to from`). Second, a _NUL_\n (ASCII 0) follows each filename, replacing space as a field separator\n and the terminating newline (but a space still separates the status\n field from the first filename). Third, filenames containing special\n@@ -296,7 +301,7 @@ Version 2 format adds more detailed information about the state of\n the worktree and changed items. Version 2 also defines an extensible\n set of easy to parse optional headers.\n \n-Header lines start with \"#\" and are added in response to specific\n+Header lines start with `#` and are added in response to specific\n command line arguments. Parsers should ignore headers they\n don't recognize.\n \n@@ -336,11 +341,13 @@ line types in any order.\n \n Ordinary changed entries have the following format:\n \n- 1 \n+[synopsis]\n+1 \n \n Renamed or copied entries have the following format:\n \n- 2 \n+[synopsis]\n+2 \n \n ....\n Field Meaning\n@@ -377,7 +384,8 @@ Field Meaning\n Unmerged entries have the following format; the first character is\n a \"u\" to distinguish from ordinary changed entries.\n \n- u

\n+[synopsis]\n+u

\n \n ....\n Field Meaning\n@@ -416,7 +424,7 @@ Pathname Format Notes and -z\n ^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n \n When the `-z` option is given, pathnames are printed as is and\n-without any quoting and lines are terminated with a NUL (ASCII 0x00)\n+without any quoting and lines are terminated with a _NUL_ (ASCII 0x00)\n byte.\n \n Without the `-z` option, pathnames with \"unusual\" characters are\n@@ -439,11 +447,11 @@ directory.\n If `status.submoduleSummary` is set to a non zero number or true (identical\n to -1 or an unlimited number), the submodule summary will be enabled for\n the long format and a summary of commits for modified submodules will be\n-shown (see --summary-limit option of linkgit:git-submodule[1]). Please note\n+shown (see `--summary-limit` option of linkgit:git-submodule[1]). Please note\n that the summary output from the status command will be suppressed for all\n-submodules when `diff.ignoreSubmodules` is set to 'all' or only for those\n+submodules when `diff.ignoreSubmodules` is set to `all` or only for those\n submodules where `submodule..ignore=all`. To also view the summary for\n-ignored submodules you can either use the --ignore-submodules=dirty command\n+ignored submodules you can either use the `--ignore-submodules=dirty` command\n line option or the 'git submodule summary' command, which shows a similar\n output but does not honor these settings.\n \n@@ -484,7 +492,7 @@ results, so it could be faster on subsequent runs.\n \tsetting this variable to `false` disables the warning message\n \tgiven when enumerating untracked files takes more than 2\n \tseconds. In a large project, it may take longer and the user\n-\tmay have already accepted the trade off (e.g. using \"-uno\" may\n+\tmay have already accepted the trade off (e.g. using `-uno` may\n \tnot be an acceptable option for the user), in which case, there\n \tis no point issuing the warning message, and in such a case,\n \tdisabling the warning may be the best.\n-- \ngitgitgadget\n\n"},{"id":"532600","messageId":"de0deb31cf5537d9c2d2edffc74d5ccda0452602.1766258187.git.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":"pull.2020.git.1766258187.gitgitgadget@gmail.com","subject":"[PATCH 3/5] doc: convert git-status tables to AsciiDoc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:25Z","receivedAt":"2025-12-20T19:16:35Z","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?= \n\nInstead of plain text tables with hand formatting, take advantage of\nasciidoc's table syntax to let the renderer do the heavy lifting and\nmake the tables more maintainable and translatable.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-status.adoc | 170 +++++++++++++++++-----------------\n 1 file changed, 85 insertions(+), 85 deletions(-)\n\ndiff --git a/Documentation/git-status.adoc b/Documentation/git-status.adoc\nindex 37b0453898..9acca52bfb 100644\n--- a/Documentation/git-status.adoc\n+++ b/Documentation/git-status.adoc\n@@ -219,35 +219,32 @@ show tracked paths:\n `C`:: copied (if config option status.renames is set to \"copies\")\n `U`:: updated but unmerged\n \n-....\n-X Y Meaning\n--------------------------------------------------\n-\t [AMD] not updated\n-M [ MTD] updated in index\n-T [ MTD] type changed in index\n-A [ MTD] added to index\n-D deleted from index\n-R [ MTD] renamed in index\n-C [ MTD] copied in index\n-[MTARC] index and work tree matches\n-[ MTARC] M work tree changed since index\n-[ MTARC] T type changed in work tree since index\n-[ MTARC] D deleted in work tree\n-\t R renamed in work tree\n-\t C copied in work tree\n--------------------------------------------------\n-D D unmerged, both deleted\n-A U unmerged, added by us\n-U D unmerged, deleted by them\n-U A unmerged, added by them\n-D U unmerged, deleted by us\n-A A unmerged, both added\n-U U unmerged, both modified\n--------------------------------------------------\n-? ? untracked\n-! ! ignored\n--------------------------------------------------\n-....\n+[cols=\"^1m,^1m,<2\",options=\"header\"]\n+|===\n+|X | Y |Meaning\n+| |[AMD] |not updated\n+|M |[ MTD] |updated in index\n+|T |[ MTD] |type changed in index\n+|A |[ MTD] |added to index\n+|D | |deleted from index\n+|R |[ MTD] |renamed in index\n+|C |[ MTD] |copied in index\n+|[MTARC] | |index and work tree matches\n+|[ MTARC] |M |work tree changed since index\n+|[ MTARC] |T |type changed in work tree since index\n+|[ MTARC] |D |deleted in work tree\n+| |R |renamed in work tree\n+| |C |copied in work tree\n+|D |D |unmerged, both deleted\n+|A |U |unmerged, added by us\n+|U |D |unmerged, deleted by them\n+|U |A |unmerged, added by them\n+|D |U |unmerged, deleted by us\n+|A |A |unmerged, both added\n+|U |U |unmerged, both modified\n+|? |? |untracked\n+|! |! |ignored\n+|===\n \n Submodules have more state and instead report\n \n@@ -311,16 +308,15 @@ Branch Headers\n If `--branch` is given, a series of header lines are printed with\n information about the current branch.\n \n-....\n-Line Notes\n-------------------------------------------------------------\n-# branch.oid | (initial) Current commit.\n-# branch.head | (detached) Current branch.\n-# branch.upstream If upstream is set.\n-# branch.ab + - If upstream is set and\n-\t\t\t\t\t the commit is present.\n-------------------------------------------------------------\n-....\n+[cols=\"<1,<1\",options=\"header\"]\n+|===\n+|Line |Notes\n+|`# branch.oid \\| (initial)` |Current commit.\n+|`# branch.head \\| (detached)` |Current branch.\n+|`# branch.upstream ` |If upstream is set.\n+|`# branch.ab + -` |If upstream is set and\n+\t\t\t\t\t the commit is present.\n+|===\n \n Stash Information\n ^^^^^^^^^^^^^^^^^\n@@ -349,37 +345,42 @@ Renamed or copied entries have the following format:\n [synopsis]\n 2 \n \n-....\n-Field Meaning\n---------------------------------------------------------\n- A 2 character field containing the staged and\n-\t unstaged XY values described in the short format,\n-\t with unchanged indicated by a \".\" rather than\n-\t a space.\n- A 4 character field describing the submodule state.\n-\t \"N...\" when the entry is not a submodule.\n-\t \"S\" when the entry is a submodule.\n-\t is \"C\" if the commit changed; otherwise \".\".\n-\t is \"M\" if it has tracked changes; otherwise \".\".\n-\t is \"U\" if there are untracked changes; otherwise \".\".\n- The octal file mode in HEAD.\n- The octal file mode in the index.\n- The octal file mode in the worktree.\n- The object name in HEAD.\n- The object name in the index.\n- The rename or copy score (denoting the percentage\n-\t of similarity between the source and target of the\n-\t move or copy). For example \"R100\" or \"C75\".\n- The pathname. In a renamed/copied entry, this\n-\t is the target path.\n- When the `-z` option is used, the 2 pathnames are separated\n-\t with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)\n-\t byte separates them.\n- The pathname in the commit at HEAD or in the index.\n-\t This is only present in a renamed/copied entry, and\n-\t tells where the renamed/copied contents came from.\n---------------------------------------------------------\n-....\n+[cols=\"<1,<1a\",options=\"header\"]\n+|===\n+|Field | Meaning\n+\n+|__\n+|A 2 character field containing the staged and\n+unstaged XY values described in the short format,\n+with unchanged indicated by a \".\" rather than\n+a space.\n+|__\n+|A 4 character field describing the submodule state.\n+\"N...\" when the entry is not a submodule.\n+`S` when the entry is a submodule.\n+\n+* __ is \"C\" if the commit changed; otherwise \".\".\n+* __ is \"M\" if it has tracked changes; otherwise \".\".\n+* __ is \"U\" if there are untracked changes; otherwise \".\".\n+|__ |The octal file mode in HEAD.\n+|__ |The octal file mode in the index.\n+|__ |The octal file mode in the worktree.\n+|__ |The object name in HEAD.\n+|__ |The object name in the index.\n+|__ |The rename or copy score (denoting the percentage\n+of similarity between the source and target of the\n+move or copy). For example \"R100\" or \"C75\".\n+|__\n+|The pathname. In a renamed/copied entry, this is the target path.\n+|__\n+|When the `-z` option is used, the 2 pathnames are separated\n+with a _NUL_ (ASCII 0x00) byte; otherwise, a _TAB_ (ASCII 0x09)\n+byte separates them.\n+|__\n+|The pathname in the commit at HEAD or in the index.\n+This is only present in a renamed/copied entry, and\n+tells where the renamed/copied contents came from.\n+|===\n \n Unmerged entries have the following format; the first character is\n a \"u\" to distinguish from ordinary changed entries.\n@@ -387,23 +388,22 @@ a \"u\" to distinguish from ordinary changed entries.\n [synopsis]\n u

\n \n-....\n-Field Meaning\n---------------------------------------------------------\n- A 2 character field describing the conflict type\n+[cols=\"<1,<1a\",options=\"header\"]\n+|===\n+|Field |Meaning\n+|__ |A 2 character field describing the conflict type\n \t as described in the short format.\n- A 4 character field describing the submodule state\n+|__ |A 4 character field describing the submodule state\n \t as described above.\n- The octal file mode in stage 1.\n- The octal file mode in stage 2.\n- The octal file mode in stage 3.\n- The octal file mode in the worktree.\n-

The object name in stage 1.\n-

The object name in stage 2.\n-

The object name in stage 3.\n- The pathname.\n---------------------------------------------------------\n-....\n+|__ |The octal file mode in stage 1.\n+|__ |The octal file mode in stage 2.\n+|__ |The octal file mode in stage 3.\n+|__ |The octal file mode in the worktree.\n+|_

_ |The object name in stage 1.\n+|_

_ |The object name in stage 2.\n+|_

_ |The object name in stage 3.\n+|__ |The pathname.\n+|===\n \n Other Items\n ^^^^^^^^^^^\n-- \ngitgitgadget\n\n"},{"id":"532601","messageId":"3c125bbc69342ad33d5f4dcec4512ce5e818c526.1766258187.git.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":"pull.2020.git.1766258187.gitgitgadget@gmail.com","subject":"[PATCH 4/5] doc: convert git stage to use synopsis block","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:26Z","receivedAt":"2025-12-20T19:16:38Z","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?= \n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-stage.adoc | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-stage.adoc b/Documentation/git-stage.adoc\nindex 2f6aaa75b9..753a817639 100644\n--- a/Documentation/git-stage.adoc\n+++ b/Documentation/git-stage.adoc\n@@ -8,8 +8,8 @@ git-stage - Add file contents to the staging area\n \n SYNOPSIS\n --------\n-[verse]\n-'git stage' ...\n+[synopsis]\n+git stage ...\n \n \n DESCRIPTION\n-- \ngitgitgadget\n\n"},{"id":"532602","messageId":"e6012ebf102861b97b3219adf79391898ae3e4fa.1766258187.git.gitgitgadget@gmail.com","threadId":"64658","inReplyTo":"pull.2020.git.1766258187.gitgitgadget@gmail.com","subject":"[PATCH 5/5] doc: convert git-remote to synopsis style","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-12-20T19:16:27Z","receivedAt":"2025-12-20T19:16:39Z","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?= \n\n- Switch the synopsis to a synopsis block which will automatically\n format placeholders in italics and keywords in monospace\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n- also convert first sentences to imperative mood where applicable\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-remote.adoc | 106 +++++++++++++++++-----------------\n 1 file changed, 53 insertions(+), 53 deletions(-)\n\ndiff --git a/Documentation/git-remote.adoc b/Documentation/git-remote.adoc\nindex 932a5c3ea4..eaae30aa88 100644\n--- a/Documentation/git-remote.adoc\n+++ b/Documentation/git-remote.adoc\n@@ -8,20 +8,20 @@ git-remote - Manage set of tracked repositories\n \n SYNOPSIS\n --------\n-[verse]\n-'git remote' [-v | --verbose]\n-'git remote add' [-t ] [-m ] [-f] [--[no-]tags] [--mirror=(fetch|push)] \n-'git remote rename' [--[no-]progress] \n-'git remote remove' \n-'git remote set-head' (-a | --auto | -d | --delete | )\n-'git remote set-branches' [--add] ...\n-'git remote get-url' [--push] [--all] \n-'git remote set-url' [--push] []\n-'git remote set-url --add' [--push] \n-'git remote set-url --delete' [--push] \n-'git remote' [-v | --verbose] 'show' [-n] ...\n-'git remote prune' [-n | --dry-run] ...\n-'git remote' [-v | --verbose] 'update' [-p | --prune] [( | )...]\n+[synopsis]\n+git remote [-v | --verbose]\n+git remote add [-t ] [-m ] [-f] [--[no-]tags] [--mirror=(fetch|push)] \n+git remote rename [--[no-]progress] \n+git remote remove \n+git remote set-head (-a | --auto | -d | --delete | )\n+git remote set-branches [--add] ...\n+git remote get-url [--push] [--all] \n+git remote set-url [--push] []\n+git remote set-url --add [--push] \n+git remote set-url --delete [--push] \n+git remote [-v | --verbose] show [-n] ...\n+git remote prune [-n | --dry-run] ...\n+git remote [-v | --verbose] update [-p | --prune] [( | )...]\n \n DESCRIPTION\n -----------\n@@ -32,8 +32,8 @@ Manage the set of repositories (\"remotes\") whose branches you track.\n OPTIONS\n -------\n \n--v::\n---verbose::\n+`-v`::\n+`--verbose`::\n \tBe a little more verbose and show remote url after name.\n \tFor promisor remotes, also show which filters (`blob:none` etc.)\n \tare configured.\n@@ -43,14 +43,14 @@ OPTIONS\n COMMANDS\n --------\n \n-With no arguments, shows a list of existing remotes. Several\n+With no arguments, show a list of existing remotes. Several\n subcommands are available to perform operations on the remotes.\n \n-'add'::\n+`add`::\n \n-Add a remote named for the repository at\n-. The command `git fetch ` can then be used to create and\n-update remote-tracking branches /.\n+Add a remote named __ for the repository at\n+__. The command `git fetch ` can then be used to create and\n+update remote-tracking branches `/`.\n +\n With `-f` option, `git fetch ` is run immediately after\n the remote information is set up.\n@@ -66,40 +66,40 @@ By default, only tags on fetched branches are imported\n +\n With `-t ` option, instead of the default glob\n refspec for the remote to track all branches under\n-the `refs/remotes//` namespace, a refspec to track only ``\n+the `refs/remotes//` namespace, a refspec to track only __\n is created. You can give more than one `-t ` to track\n multiple branches without grabbing all branches.\n +\n With `-m ` option, a symbolic-ref `refs/remotes//HEAD` is set\n-up to point at remote's `` branch. See also the set-head command.\n+up to point at remote's __ branch. See also the set-head command.\n +\n When a fetch mirror is created with `--mirror=fetch`, the refs will not\n-be stored in the 'refs/remotes/' namespace, but rather everything in\n-'refs/' on the remote will be directly mirrored into 'refs/' in the\n+be stored in the `refs/remotes/` namespace, but rather everything in\n+`refs/` on the remote will be directly mirrored into `refs/` in the\n local repository. This option only makes sense in bare repositories,\n because a fetch would overwrite any local commits.\n +\n When a push mirror is created with `--mirror=push`, then `git push`\n will always behave as if `--mirror` was passed.\n \n-'rename'::\n+`rename`::\n \n-Rename the remote named to . All remote-tracking branches and\n+Rename the remote named __ to __. All remote-tracking branches and\n configuration settings for the remote are updated.\n +\n-In case and are the same, and is a file under\n+In case __ and __ are the same, and __ is a file under\n `$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to\n the configuration file format.\n \n-'remove'::\n-'rm'::\n+`remove`::\n+`rm`::\n \n-Remove the remote named . All remote-tracking branches and\n+Remove the remote named __. All remote-tracking branches and\n configuration settings for the remote are removed.\n \n-'set-head'::\n+`set-head`::\n \n-Sets or deletes the default branch (i.e. the target of the\n+Set or delete the default branch (i.e. the target of the\n symbolic-ref `refs/remotes//HEAD`) for\n the named remote. Having a default branch for a remote is not required,\n but allows the name of the remote to be specified in lieu of a specific\n@@ -116,15 +116,15 @@ the symbolic-ref `refs/remotes/origin/HEAD` to `refs/remotes/origin/next`. This\n only work if `refs/remotes/origin/next` already exists; if not it must be\n fetched first.\n +\n-Use `` to set the symbolic-ref `refs/remotes//HEAD` explicitly. e.g., `git\n+Use __ to set the symbolic-ref `refs/remotes//HEAD` explicitly. e.g., `git\n remote set-head origin master` will set the symbolic-ref `refs/remotes/origin/HEAD` to\n `refs/remotes/origin/master`. This will only work if\n `refs/remotes/origin/master` already exists; if not it must be fetched first.\n +\n \n-'set-branches'::\n+`set-branches`::\n \n-Changes the list of branches tracked by the named remote.\n+Change the list of branches tracked by the named remote.\n This can be used to track a subset of the available remote branches\n after the initial setup for a remote.\n +\n@@ -134,7 +134,7 @@ The named branches will be interpreted as if specified with the\n With `--add`, instead of replacing the list of currently tracked\n branches, adds to that list.\n \n-'get-url'::\n+`get-url`::\n \n Retrieves the URLs for a remote. Configurations for `insteadOf` and\n `pushInsteadOf` are expanded here. By default, only the first URL is listed.\n@@ -143,18 +143,18 @@ With `--push`, push URLs are queried rather than fetch URLs.\n +\n With `--all`, all URLs for the remote will be listed.\n \n-'set-url'::\n+`set-url`::\n \n-Changes URLs for the remote. Sets first URL for remote that matches\n-regex (first URL if no is given) to . If\n- doesn't match any URL, an error occurs and nothing is changed.\n+Change URLs for the remote. Sets first URL for remote __ that matches\n+regex __ (first URL if no __ is given) to __. If\n+__ doesn't match any URL, an error occurs and nothing is changed.\n +\n With `--push`, push URLs are manipulated instead of fetch URLs.\n +\n With `--add`, instead of changing existing URLs, new URL is added.\n +\n With `--delete`, instead of changing existing URLs, all URLs matching\n-regex are deleted for remote . Trying to delete all\n+regex __ are deleted for remote __. Trying to delete all\n non-push URLs is an error.\n +\n Note that the push URL and the fetch URL, even though they can\n@@ -165,17 +165,17 @@ fetch from one place (e.g. your upstream) and push to another (e.g.\n your publishing repository), use two separate remotes.\n \n \n-'show'::\n+`show`::\n \n-Gives some information about the remote .\n+Give some information about the remote __.\n +\n With `-n` option, the remote heads are not queried first with\n `git ls-remote `; cached information is used instead.\n \n-'prune'::\n+`prune`::\n \n-Deletes stale references associated with . By default, stale\n-remote-tracking branches under are deleted, but depending on\n+Delete stale references associated with __. By default, stale\n+remote-tracking branches under __ are deleted, but depending on\n global configuration and the configuration of the remote we might even\n prune local tags that haven't been pushed there. Equivalent to `git\n fetch --prune `, except that no new references will be fetched.\n@@ -186,13 +186,13 @@ depending on various configuration.\n With `--dry-run` option, report what branches would be pruned, but do not\n actually prune them.\n \n-'update'::\n+`update`::\n \n Fetch updates for remotes or remote groups in the repository as defined by\n `remotes.`. If neither group nor remote is specified on the command line,\n-the configuration parameter remotes.default will be used; if\n-remotes.default is not defined, all remotes which do not have the\n-configuration parameter `remote..skipDefaultUpdate` set to true will\n+the configuration parameter `remotes.default` will be used; if\n+`remotes.default` is not defined, all remotes which do not have the\n+configuration parameter `remote..skipDefaultUpdate` set to `true` will\n be updated. (See linkgit:git-config[1]).\n +\n With `--prune` option, run pruning against all the remotes that are updated.\n@@ -210,7 +210,7 @@ EXIT STATUS\n \n On success, the exit status is `0`.\n \n-When subcommands such as 'add', 'rename', and 'remove' can't find the\n+When subcommands such as `add`, `rename`, and `remove` can't find the\n remote in question, the exit status is `2`. When the remote already\n exists, the exit status is `3`.\n \n@@ -247,7 +247,7 @@ $ git switch -c staging staging/master\n ...\n ------------\n \n-* Imitate 'git clone' but track only selected branches\n+* Imitate `git clone` but track only selected branches\n +\n ------------\n $ mkdir project.git\n-- \ngitgitgadget\n"}]}