{"thread":{"id":"62730","subject":"[PATCH 0/3] Doc git commit","startedAt":"2025-01-03T13:47:29Z","lastAt":"2025-01-16T10:17:24Z","messageCount":15,"participants":["Jean-Noël Avila via GitGitGadget","Patrick Steinhardt","Jean-Noël AVILA","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":3},"messages":[{"id":"509847","messageId":"pull.1845.git.1735912046.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":null,"subject":"[PATCH 0/3] Doc git commit","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-03T13:47:23Z","receivedAt":"2025-01-03T13:47:29Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This series continues the effort of rewriting the documentation with\nuniformization and better formatting of the man pages. This time, git-commit\nis processed, taking advantage of previous experiences.\n\nJean-Noël Avila (3):\n doc: git-commit: apply new documentation guidelines\n doc: git-commit.txt: convert git commit config to new format\n doc: git-commit: migrate secondary files to new format\n\n Documentation/config/commit.txt | 25 +--\n Documentation/git-commit.txt | 276 +++++++++++++++----------------\n Documentation/i18n.txt | 4 +-\n Documentation/signoff-option.txt | 8 +-\n builtin/commit.c | 2 +-\n 5 files changed, 159 insertions(+), 156 deletions(-)\n\n\nbase-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1845%2Fjnavila%2Fdoc_git-commit-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1845/jnavila/doc_git-commit-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1845\n-- \ngitgitgadget\n"},{"id":"509848","messageId":"9f518ec8f9d564107d9953bdb3bb20048cdd60e6.1735912046.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.git.1735912046.gitgitgadget@gmail.com","subject":"[PATCH 2/3] doc: git-commit.txt: convert git commit config to new format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-03T13:47:25Z","receivedAt":"2025-01-03T13:47:31Z","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 prevent git-commit manpage to refer to itself in the config\ndescription by using a variable.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/config/commit.txt | 25 +++++++++++++++----------\n 1 file changed, 15 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt\nindex 62f0d92fda5..d3f4624fd27 100644\n--- a/Documentation/config/commit.txt\n+++ b/Documentation/config/commit.txt\n@@ -1,29 +1,34 @@\n-commit.cleanup::\n+ifdef::git-commit[]\n+:see-git-commit:\n+endif::git-commit[]\n+ifndef::git-commit[]\n+:see-git-commit: See linkgit:git-commit[1] for details.\n+endif::git-commit[]\n+`commit.cleanup`::\n \tThis setting overrides the default of the `--cleanup` option in\n-\t`git commit`. See linkgit:git-commit[1] for details. Changing the\n-\tdefault can be useful when you always want to keep lines that begin\n+\t`git commit`. {see-git-commit} Changing the default can be useful\n+\twhen you always want to keep lines that begin\n \twith the comment character `#` in your log message, in which case you\n \twould do `git config commit.cleanup whitespace` (note that you will\n \thave to remove the help lines that begin with `#` in the commit log\n \ttemplate yourself, if you do this).\n \n-commit.gpgSign::\n-\n+`commit.gpgSign`::\n \tA boolean to specify whether all commits should be GPG signed.\n \tUse of this option when doing operations such as rebase can\n \tresult in a large number of commits being signed. It may be\n \tconvenient to use an agent to avoid typing your GPG passphrase\n \tseveral times.\n \n-commit.status::\n+`commit.status`::\n \tA boolean to enable/disable inclusion of status information in the\n \tcommit message template when using an editor to prepare the commit\n-\tmessage. Defaults to true.\n+\tmessage. Defaults to `true`.\n \n-commit.template::\n+`commit.template`::\n \tSpecify the pathname of a file to use as the template for\n \tnew commit messages.\n \n-commit.verbose::\n+`commit.verbose`::\n \tA boolean or int to specify the level of verbosity with `git commit`.\n-\tSee linkgit:git-commit[1].\n+\t{see-git-commit}\n-- \ngitgitgadget\n\n"},{"id":"509849","messageId":"dfd907fc3147b438222bbfad9b0a7ca61df642a5.1735912046.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.git.1735912046.gitgitgadget@gmail.com","subject":"[PATCH 1/3] doc: git-commit: apply new documentation guidelines","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-03T13:47:24Z","receivedAt":"2025-01-03T13:47:31Z","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\nThe documentation for git-commit has been updated to follow the new\ndocumentation guidelines. The following changes have been applied to\nthe series of patches:\n\n- switching 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\nAdditionally, some option descriptions have been turned into\nimperative mood to make them more consistent with the rest of the\ndocumentation.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-commit.txt | 276 +++++++++++++++++------------------\n builtin/commit.c | 2 +-\n 2 files changed, 138 insertions(+), 140 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex c822113c111..b08a398e31d 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -7,8 +7,8 @@ git-commit - Record changes to the repository\n \n SYNOPSIS\n --------\n-[verse]\n-'git commit' [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n+[synopsis]\n+git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\n \t [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n \t [-F | -m ] [--reset-author] [--allow-empty]\n \t [--allow-empty-message] [--no-verify] [-e] [--author=]\n@@ -23,31 +23,31 @@ Create a new commit containing the current contents of the index and\n the given log message describing the changes. The new commit is a\n direct child of HEAD, usually the tip of the current branch, and the\n branch is updated to point to it (unless no branch is associated with\n-the working tree, in which case HEAD is \"detached\" as described in\n+the working tree, in which case `HEAD` is \"detached\" as described in\n linkgit:git-checkout[1]).\n \n The content to be committed can be specified in several ways:\n \n 1. by using linkgit:git-add[1] to incrementally \"add\" changes to the\n- index before using the 'commit' command (Note: even modified files\n+ index before using the `commit` command (Note: even modified files\n must be \"added\");\n \n 2. by using linkgit:git-rm[1] to remove files from the working tree\n- and the index, again before using the 'commit' command;\n+ and the index, again before using the `commit` command;\n \n-3. by listing files as arguments to the 'commit' command\n- (without --interactive or --patch switch), in which\n+3. by listing files as arguments to the `commit` command\n+ (without `--interactive` or `--patch` switch), in which\n case the commit will ignore changes staged in the index, and instead\n record the current content of the listed files (which must already\n be known to Git);\n \n-4. by using the -a switch with the 'commit' command to automatically\n+4. by using the `-a` switch with the `commit` command to automatically\n \"add\" changes from all known files (i.e. all files that are already\n listed in the index) and to automatically \"rm\" files in the index\n that have been removed from the working tree, and then perform the\n actual commit;\n \n-5. by using the --interactive or --patch switches with the 'commit' command\n+5. by using the `--interactive` or `--patch` switches with the `commit` command\n to decide one by one which files or hunks should be part of the commit\n in addition to contents in the index,\n before finalizing the operation. See the ``Interactive Mode'' section of\n@@ -58,139 +58,139 @@ summary of what is included by any of the above for the next\n commit by giving the same set of parameters (options and paths).\n \n If you make a commit and then find a mistake immediately after\n-that, you can recover from it with 'git reset'.\n+that, you can recover from it with `git reset`.\n \n :git-commit: 1\n \n OPTIONS\n -------\n--a::\n---all::\n-\tTell the command to automatically stage files that have\n+`-a`::\n+`--all`::\n+\tAutomatically stage files that have\n \tbeen modified and deleted, but new files you have not\n \ttold Git about are not affected.\n \n--p::\n---patch::\n+`-p`::\n+`--patch`::\n \tUse the interactive patch selection interface to choose\n \twhich changes to commit. See linkgit:git-add[1] for\n \tdetails.\n \n--C ::\n---reuse-message=::\n-\tTake an existing commit object, and reuse the log message\n+`-C `::\n+`--reuse-message=`::\n+\tTake an existing __ object, and reuse the log message\n \tand the authorship information (including the timestamp)\n \twhen creating the commit.\n \n--c ::\n---reedit-message=::\n-\tLike '-C', but with `-c` the editor is invoked, so that\n+`-c `::\n+`--reedit-message=`::\n+\tLike `-C`, but with `-c` the editor is invoked, so that\n \tthe user can further edit the commit message.\n \n---fixup=[(amend|reword):]::\n-\tCreate a new commit which \"fixes up\" `` when applied with\n+`--fixup=[(amend|reword):]`::\n+\tCreate a new commit which \"fixes up\" __ when applied with\n \t`git rebase --autosquash`. Plain `--fixup=` creates a\n-\t\"fixup!\" commit which changes the content of `` but leaves\n+\t\"fixup!\" commit which changes the content of __ but leaves\n \tits log message untouched. `--fixup=amend:` is similar but\n \tcreates an \"amend!\" commit which also replaces the log message of\n-\t`` with the log message of the \"amend!\" commit.\n+\t__ with the log message of the \"amend!\" commit.\n \t`--fixup=reword:` creates an \"amend!\" commit which\n-\treplaces the log message of `` with its own log message\n-\tbut makes no changes to the content of ``.\n+\treplaces the log message of __ with its own log message\n+\tbut makes no changes to the content of __.\n +\n The commit created by plain `--fixup=` has a subject\n-composed of \"fixup!\" followed by the subject line from ,\n+composed of \"fixup!\" followed by the subject line from __,\n and is recognized specially by `git rebase --autosquash`. The `-m`\n option may be used to supplement the log message of the created\n commit, but the additional commentary will be thrown away once the\n-\"fixup!\" commit is squashed into `` by\n+\"fixup!\" commit is squashed into __ by\n `git rebase --autosquash`.\n +\n The commit created by `--fixup=amend:` is similar but its\n subject is instead prefixed with \"amend!\". The log message of\n- is copied into the log message of the \"amend!\" commit and\n+__ is copied into the log message of the \"amend!\" commit and\n opened in an editor so it can be refined. When `git rebase\n---autosquash` squashes the \"amend!\" commit into ``, the\n-log message of `` is replaced by the refined log message\n+--autosquash` squashes the \"amend!\" commit into __, the\n+log message of __ is replaced by the refined log message\n from the \"amend!\" commit. It is an error for the \"amend!\" commit's\n log message to be empty unless `--allow-empty-message` is\n specified.\n +\n `--fixup=reword:` is shorthand for `--fixup=amend:\n---only`. It creates an \"amend!\" commit with only a log message\n+ --only`. It creates an \"amend!\" commit with only a log message\n (ignoring any changes staged in the index). When squashed by `git\n-rebase --autosquash`, it replaces the log message of ``\n+rebase --autosquash`, it replaces the log message of __\n without making any other changes.\n +\n Neither \"fixup!\" nor \"amend!\" commits change authorship of\n-`` when applied by `git rebase --autosquash`.\n+__ when applied by `git rebase --autosquash`.\n See linkgit:git-rebase[1] for details.\n \n---squash=::\n-\tConstruct a commit message for use with `rebase --autosquash`.\n+`--squash=`::\n+\tConstruct a commit message for use with `git rebase --autosquash`.\n \tThe commit message subject line is taken from the specified\n \tcommit with a prefix of \"squash! \". Can be used with additional\n \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n \tlinkgit:git-rebase[1] for details.\n \n---reset-author::\n-\tWhen used with -C/-c/--amend options, or when committing after a\n+`--reset-author`::\n+\tWhen used with `-C`/`-c`/`--amend` options, or when committing after a\n \tconflicting cherry-pick, declare that the authorship of the\n \tresulting commit now belongs to the committer. This also renews\n \tthe author timestamp.\n \n---short::\n+`--short`::\n \tWhen doing a dry-run, give the output in the short-format. See\n \tlinkgit:git-status[1] for details. Implies `--dry-run`.\n \n---branch::\n+`--branch`::\n \tShow the branch and tracking info even in short-format.\n \n---porcelain::\n+`--porcelain`::\n \tWhen doing a dry-run, give the output in a porcelain-ready\n \tformat. See linkgit:git-status[1] for details. Implies\n \t`--dry-run`.\n \n---long::\n+`--long`::\n \tWhen doing a dry-run, give the output in the long-format.\n \tImplies `--dry-run`.\n \n--z::\n---null::\n+`-z`::\n+`--null`::\n \tWhen showing `short` or `porcelain` status output, print the\n-\tfilename verbatim and terminate the entries with NUL, instead of LF.\n+\tfilename verbatim and terminate the entries with _NUL_, instead of _LF_.\n \tIf no format is given, implies the `--porcelain` output format.\n \tWithout the `-z` option, filenames with \"unusual\" characters are\n \tquoted as explained for the configuration variable `core.quotePath`\n \t(see linkgit:git-config[1]).\n \n--F ::\n---file=::\n-\tTake the commit message from the given file. Use '-' to\n+`-F `::\n+`--file=`::\n+\tTake the commit message from __. Use `-` to\n \tread the message from the standard input.\n \n---author=::\n+`--author=`::\n \tOverride the commit author. Specify an explicit author using the\n-\tstandard `A U Thor ` format. Otherwise \n+\tstandard `A U Thor ` format. Otherwise __\n \tis assumed to be a pattern and is used to search for an existing\n-\tcommit by that author (i.e. rev-list --all -i --author=);\n+\tcommit by that author (i.e. `git rev-list --all -i --author=`);\n \tthe commit author is then copied from the first such commit found.\n \n---date=::\n+`--date=`::\n \tOverride the author date used in the commit.\n \n--m ::\n---message=::\n-\tUse the given as the commit message.\n+`-m `::\n+`--message=`::\n+\tUse __ as the commit message.\n \tIf multiple `-m` options are given, their values are\n \tconcatenated as separate paragraphs.\n +\n The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n \n--t ::\n---template=::\n+`-t `::\n+`--template=`::\n \tWhen editing the commit message, start the editor with the\n-\tcontents in the given file. The `commit.template` configuration\n+\tcontents in __. The `commit.template` configuration\n \tvariable is often used to give this option implicitly to the\n \tcommand. This mechanism can be used by projects that want to\n \tguide participants with some hints on what to write in the message\n@@ -200,56 +200,55 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n \n include::signoff-option.txt[]\n \n---trailer [(=|:)]::\n-\tSpecify a (, ) pair that should be applied as a\n+`--trailer [(=|:)]`::\n+\tSpecify a (__, __) pair that should be applied as a\n \ttrailer. (e.g. `git commit --trailer \"Signed-off-by:C O Mitter \\\n \t\" --trailer \"Helped-by:C O Mitter \\\n-\t\"` will add the \"Signed-off-by\" trailer\n-\tand the \"Helped-by\" trailer to the commit message.)\n+\t\"` will add the `Signed-off-by` trailer\n+\tand the `Helped-by` trailer to the commit message.)\n \tThe `trailer.*` configuration variables\n \t(linkgit:git-interpret-trailers[1]) can be used to define if\n \ta duplicated trailer is omitted, where in the run of trailers\n \teach trailer would appear, and other details.\n \n--n::\n---[no-]verify::\n-\tBy default, the pre-commit and commit-msg hooks are run.\n-\tWhen any of `--no-verify` or `-n` is given, these are bypassed.\n+`-n`::\n+`--[no-]verify`::\n+\tBypass the `pre-commit` and `commit-msg` hooks.\n \tSee also linkgit:githooks[5].\n \n---allow-empty::\n+`--allow-empty`::\n \tUsually recording a commit that has the exact same tree as its\n \tsole parent commit is a mistake, and the command prevents you\n \tfrom making such a commit. This option bypasses the safety, and\n \tis primarily for use by foreign SCM interface scripts.\n \n---allow-empty-message::\n- Like --allow-empty this command is primarily for use by foreign\n+`--allow-empty-message`::\n+ Like `--allow-empty` this command is primarily for use by foreign\n SCM interface scripts. It allows you to create a commit with an\n empty commit message without using plumbing commands like\n linkgit:git-commit-tree[1].\n \n---cleanup=::\n-\tThis option determines how the supplied commit message should be\n+`--cleanup=`::\n+\tDetermine how the supplied commit message should be\n \tcleaned up before committing. The '' can be `strip`,\n \t`whitespace`, `verbatim`, `scissors` or `default`.\n +\n --\n-strip::\n+`strip`::\n \tStrip leading and trailing empty lines, trailing whitespace,\n \tcommentary and collapse consecutive empty lines.\n-whitespace::\n+`whitespace`::\n \tSame as `strip` except #commentary is not removed.\n-verbatim::\n+`verbatim`::\n \tDo not change the message at all.\n-scissors::\n+`scissors`::\n \tSame as `whitespace` except that everything from (and including)\n \tthe line found below is truncated, if the message is to be edited.\n-\t\"`#`\" can be customized with core.commentChar.\n+\t\"`#`\" can be customized with `core.commentChar`.\n \n \t\t# ------------------------ >8 ------------------------\n \n-default::\n+`default`::\n \tSame as `strip` if the message is to be edited.\n \tOtherwise `whitespace`.\n --\n@@ -257,19 +256,18 @@ default::\n The default can be changed by the `commit.cleanup` configuration\n variable (see linkgit:git-config[1]).\n \n--e::\n---edit::\n-\tThe message taken from file with `-F`, command line with\n-\t`-m`, and from commit object with `-C` are usually used as\n-\tthe commit log message unmodified. This option lets you\n-\tfurther edit the message taken from these sources.\n+`-e`::\n+`--edit`::\n+\tLet the user further edit the message taken from file\n+\twith `-F`, command line with `-m`, and from commit object\n+\twith `-C` are usually used as the commit log message unmodified.\n \n---no-edit::\n+`--no-edit`::\n \tUse the selected commit message without launching an editor.\n \tFor example, `git commit --amend --no-edit` amends a commit\n \twithout changing its commit message.\n \n---amend::\n+`--amend`::\n \tReplace the tip of the current branch by creating a new\n \tcommit. The recorded tree is prepared as usual (including\n \tthe effect of the `-i` and `-o` options and explicit\n@@ -295,23 +293,23 @@ You should understand the implications of rewriting history if you\n amend a commit that has already been published. (See the \"RECOVERING\n FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \n---no-post-rewrite::\n-\tBypass the post-rewrite hook.\n+`--no-post-rewrite`::\n+\tBypass the `post-rewrite` hook.\n \n--i::\n---include::\n+`-i`::\n+`--include`::\n \tBefore making a commit out of staged contents so far,\n \tstage the contents of paths given on the command line\n \tas well. This is usually not what you want unless you\n \tare concluding a conflicted merge.\n \n--o::\n---only::\n+`-o`::\n+`--only`::\n \tMake a commit by taking the updated working tree contents\n \tof the paths specified on the\n \tcommand line, disregarding any contents that have been\n \tstaged for other paths. This is the default mode of operation of\n-\t'git commit' if any paths are given on the command line,\n+\t`git commit` if any paths are given on the command line,\n \tin which case this option can be omitted.\n \tIf this option is specified together with `--amend`, then\n \tno paths need to be specified, which can be used to amend\n@@ -319,48 +317,48 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \talready been staged. If used together with `--allow-empty`\n \tpaths are also not required, and an empty commit will be created.\n \n---pathspec-from-file=::\n-\tPathspec is passed in `` instead of commandline args. If\n-\t`` is exactly `-` then standard input is used. Pathspec\n-\telements are separated by LF or CR/LF. Pathspec elements can be\n+`--pathspec-from-file=`::\n+\tPathspec is passed in __ instead of commandline args. If\n+\t__ is exactly `-` then standard input is used. Pathspec\n+\telements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be\n \tquoted as explained for the configuration variable `core.quotePath`\n \t(see linkgit:git-config[1]). See also `--pathspec-file-nul` and\n \tglobal `--literal-pathspecs`.\n \n---pathspec-file-nul::\n+`--pathspec-file-nul`::\n \tOnly meaningful with `--pathspec-from-file`. Pathspec elements are\n-\tseparated with NUL character and all other characters are taken\n+\tseparated with _NUL_ character and all other characters are taken\n \tliterally (including newlines and quotes).\n \n--u[]::\n---untracked-files[=]::\n+`-u[]`::\n+`--untracked-files[=]`::\n \tShow untracked files.\n +\n --\n-The mode parameter is optional (defaults to 'all'), and is used to\n-specify the handling of untracked files; when -u is not used, the\n-default is 'normal', i.e. show untracked files and directories.\n+The __ parameter is optional (defaults to `all`), and is used to\n+specify the handling of untracked files; when `-u` is not used, the\n+default is `normal`, i.e. show untracked files and directories.\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`:: Shows untracked files and directories\n+`all`:: Also shows individual files in untracked directories.\n \n All usual spellings for Boolean value `true` are taken as `normal`\n and `false` as `no`.\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--v::\n---verbose::\n-\tShow unified diff between the HEAD commit and what\n+`-v`::\n+`--verbose`::\n+\tShow unified diff between the `HEAD` commit and what\n \twould be committed at the bottom of the commit message\n \ttemplate to help the user describe the commit by reminding\n \twhat changes the commit has.\n \tNote that this diff output doesn't have its\n-\tlines prefixed with '#'. This diff will not be a part\n+\tlines prefixed with `#`. This diff will not be a part\n \tof the commit message. See the `commit.verbose` configuration\n \tvariable in linkgit:git-config[1].\n +\n@@ -368,40 +366,40 @@ If specified twice, show in addition the unified diff between\n what would be committed and the worktree files, i.e. the unstaged\n changes to tracked files.\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \tSuppress commit summary message.\n \n---dry-run::\n+`--dry-run`::\n \tDo not create a commit, but show a list of paths that are\n \tto be committed, paths with local changes that will be left\n \tuncommitted and paths that are untracked.\n \n---status::\n+`--status`::\n \tInclude the output of linkgit:git-status[1] in the commit\n \tmessage template when using an editor to prepare the commit\n \tmessage. Defaults to on, but can be used to override\n-\tconfiguration variable commit.status.\n+\tconfiguration variable `commit.status`.\n \n---no-status::\n+`--no-status`::\n \tDo not include the output of linkgit:git-status[1] in the\n \tcommit message template when using an editor to prepare the\n \tdefault commit message.\n \n--S[]::\n---gpg-sign[=]::\n---no-gpg-sign::\n-\tGPG-sign commits. The `keyid` argument is optional and\n+`-S[]`::\n+`--gpg-sign[=]`::\n+`--no-gpg-sign`::\n+\tGPG-sign commits. The __ is optional and\n \tdefaults to the committer identity; if specified, it must be\n \tstuck to the option without a space. `--no-gpg-sign` is useful to\n \tcountermand both `commit.gpgSign` configuration variable, and\n \tearlier `--gpg-sign`.\n \n-\\--::\n+`--`::\n \tDo not interpret any more arguments as options.\n \n-...::\n-\tWhen pathspec is given on the command line, commit the contents of\n+`...`::\n+\tWhen __ is given on the command line, commit the contents of\n \tthe files that match the pathspec without recording the changes\n \talready added to the index. The contents of these files are also\n \tstaged for the next commit on top of what have been staged before.\n@@ -412,10 +410,10 @@ EXAMPLES\n --------\n When recording your own work, the contents of modified files in\n your working tree are temporarily stored to a staging area\n-called the \"index\" with 'git add'. A file can be\n+called the \"index\" with `git add`. A file can be\n reverted back, only in the index but not in the working tree,\n to that of the last commit with `git restore --staged `,\n-which effectively reverts 'git add' and prevents the changes to\n+which effectively reverts `git add` and prevents the changes to\n this file from participating in the next commit. After building\n the state to be committed incrementally with these commands,\n `git commit` (without any pathname parameter) is used to record what\n@@ -443,7 +441,7 @@ $ git commit -a\n ------------\n \n The command `git commit -a` first looks at your working tree,\n-notices that you have modified hello.c and removed goodbye.c,\n+notices that you have modified `hello.c` and removed `goodbye.c`,\n and performs necessary `git add` and `git rm` for you.\n \n After staging changes to many files, you can alter the order the\n@@ -471,13 +469,13 @@ $ git commit\n this second commit would record the changes to `hello.c` and\n `hello.h` as expected.\n \n-After a merge (initiated by 'git merge' or 'git pull') stops\n+After a merge (initiated by `git merge` or `git pull`) stops\n because of conflicts, cleanly merged\n paths are already staged to be committed for you, and paths that\n conflicted are left in unmerged state. You would have to first\n-check which paths are conflicting with 'git status'\n+check which paths are conflicting with `git status`\n and after fixing them manually in your working tree, you would\n-stage the result as usual with 'git add':\n+stage the result as usual with `git add`:\n \n ------------\n $ git status | grep unmerged\n@@ -507,12 +505,12 @@ COMMIT INFORMATION\n Author and committer information is taken from the following environment\n variables, if set:\n \n-\tGIT_AUTHOR_NAME\n-\tGIT_AUTHOR_EMAIL\n-\tGIT_AUTHOR_DATE\n-\tGIT_COMMITTER_NAME\n-\tGIT_COMMITTER_EMAIL\n-\tGIT_COMMITTER_DATE\n+ * `GIT_AUTHOR_NAME`\n+ * `GIT_AUTHOR_EMAIL`\n+ * `GIT_AUTHOR_DATE`\n+ * `GIT_COMMITTER_NAME`\n+ * `GIT_COMMITTER_EMAIL`\n+ * `GIT_COMMITTER_DATE`\n \n (nb \"<\", \">\" and \"\\n\"s are stripped)\n \n@@ -524,7 +522,7 @@ that, see the `credential.username` variable in linkgit:git-config[1].\n \n In case (some of) these environment variables are not set, the information\n is taken from the configuration items `user.name` and `user.email`, or, if not\n-present, the environment variable EMAIL, or, if that is not set,\n+present, the environment variable `EMAIL`, or, if that is not set,\n system user name and the hostname used for outgoing mail (taken\n from `/etc/mailname` and falling back to the fully qualified hostname when\n that file does not exist).\n@@ -555,7 +553,7 @@ include::i18n.txt[]\n ENVIRONMENT AND CONFIGURATION VARIABLES\n ---------------------------------------\n The editor used to edit the commit log message will be chosen from the\n-`GIT_EDITOR` environment variable, the core.editor configuration variable, the\n+`GIT_EDITOR` environment variable, the `core.editor` configuration variable, the\n `VISUAL` environment variable, or the `EDITOR` environment variable (in that\n order). See linkgit:git-var[1] for details.\n \ndiff --git a/builtin/commit.c b/builtin/commit.c\nindex ef5e622c077..a7315ed67cc 100644\n--- a/builtin/commit.c\n+++ b/builtin/commit.c\n@@ -44,7 +44,7 @@\n #include \"trailer.h\"\n \n static const char * const builtin_commit_usage[] = {\n-\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\\n\"\n+\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\\n\"\n \t \" [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\\n\"\n \t \" [-F | -m ] [--reset-author] [--allow-empty]\\n\"\n \t \" [--allow-empty-message] [--no-verify] [-e] [--author=]\\n\"\n-- \ngitgitgadget\n\n"},{"id":"509850","messageId":"9f8d4e74b7be64584235a0c7159576e083f90888.1735912046.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.git.1735912046.gitgitgadget@gmail.com","subject":"[PATCH 3/3] doc: git-commit: migrate secondary files to new format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-03T13:47:26Z","receivedAt":"2025-01-03T13:47: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\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/i18n.txt | 4 ++--\n Documentation/signoff-option.txt | 8 ++++----\n 2 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\nindex 3a866af4a42..baff780a7e3 100644\n--- a/Documentation/i18n.txt\n+++ b/Documentation/i18n.txt\n@@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git\n does not forbid it. However, there are a few things to keep in\n mind.\n \n-. 'git commit' and 'git commit-tree' issue\n+. `git commit` and `git commit-tree` issue\n a warning if the commit log message given to it does not look\n like a valid UTF-8 string, unless you explicitly say your\n project uses a legacy encoding. The way to say this is to\n@@ -50,7 +50,7 @@ of `i18n.commitEncoding` in their `encoding` header. This is to\n help other people who look at them later. Lack of this header\n implies that the commit log message is encoded in UTF-8.\n \n-. 'git log', 'git show', 'git blame' and friends look at the\n+. `git log`, `git show`, `git blame` and friends look at the\n `encoding` header of a commit object, and try to re-code the\n log message into UTF-8 unless otherwise specified. You can\n specify the desired output encoding with\ndiff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt\nindex d98758f3cb7..cddfb225d1d 100644\n--- a/Documentation/signoff-option.txt\n+++ b/Documentation/signoff-option.txt\n@@ -1,8 +1,8 @@\n ifdef::git-commit[]\n--s::\n+`-s`::\n endif::git-commit[]\n---signoff::\n---no-signoff::\n+`--signoff`::\n+`--no-signoff`::\n \tAdd a `Signed-off-by` trailer by the committer at the end of the commit\n \tlog message. The meaning of a signoff depends on the project\n \tto which you're committing. For example, it may certify that\n@@ -14,5 +14,5 @@ endif::git-commit[]\n \tleadership of the project to which you're contributing to\n \tunderstand how the signoffs are used in that project.\n +\n-The --no-signoff option can be used to countermand an earlier --signoff\n+The `--no-signoff` option can be used to countermand an earlier `--signoff`\n option on the command line.\n-- \ngitgitgadget\n"},{"id":"509951","messageId":"Z3uIZA0bIXzaUxlH@pks.im","threadId":"62730","inReplyTo":"dfd907fc3147b438222bbfad9b0a7ca61df642a5.1735912046.git.gitgitgadget@gmail.com","subject":"Re: [PATCH 1/3] doc: git-commit: apply new documentation guidelines","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2025-01-06T07:38:19Z","receivedAt":"2025-01-06T07:38:23Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"On Fri, Jan 03, 2025 at 01:47:24PM +0000, Jean-Noël Avila via GitGitGadget wrote:\n> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n> \n> The documentation for git-commit has been updated to follow the new\n> documentation guidelines. The following changes have been applied to\n> the series of patches:\n> \n> - switching 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\n> descriptions`. The new rendering engine will apply synopsis rules to\n> these spans.\n> \n> Additionally, some option descriptions have been turned into\n> imperative mood to make them more consistent with the rest of the\n> documentation.\n\nSame comment here regarding the commit message as on the other two\nseries. We should use imperative mood for it, as well :)\n\n> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\n> index c822113c111..b08a398e31d 100644\n> --- a/Documentation/git-commit.txt\n> +++ b/Documentation/git-commit.txt\n> @@ -58,139 +58,139 @@ summary of what is included by any of the above for the next\n> --z::\n> ---null::\n> +`-z`::\n> +`--null`::\n> \tWhen showing `short` or `porcelain` status output, print the\n> -\tfilename verbatim and terminate the entries with NUL, instead of LF.\n> +\tfilename verbatim and terminate the entries with _NUL_, instead of _LF_.\n> \tIf no format is given, implies the `--porcelain` output format.\n> \tWithout the `-z` option, filenames with \"unusual\" characters are\n> \tquoted as explained for the configuration variable `core.quotePath`\n> \t(see linkgit:git-config[1]).\n> \n> --F ::\n> ---file=::\n> -\tTake the commit message from the given file. Use '-' to\n> +`-F `::\n> +`--file=`::\n> +\tTake the commit message from __. Use `-` to\n\nI think it would make sense to move changes like this, where the actual\nwording changes, into a separate commit. That'd make it way easier to\nspot the non-mechanical changes from those that may require some\ndiscussion.\n\n> @@ -257,19 +256,18 @@ default::\n> The default can be changed by the `commit.cleanup` configuration\n> variable (see linkgit:git-config[1]).\n> \n> --e::\n> ---edit::\n> -\tThe message taken from file with `-F`, command line with\n> -\t`-m`, and from commit object with `-C` are usually used as\n> -\tthe commit log message unmodified. This option lets you\n> -\tfurther edit the message taken from these sources.\n> +`-e`::\n> +`--edit`::\n> +\tLet the user further edit the message taken from file\n\nThere's a double space here. I was also wondering whether this should\nsay __ here to further clarify that this refers to the same\nplaceholder as the placeholder in `-F`. Might be confusing though, I\ndunno.\n\n> diff --git a/builtin/commit.c b/builtin/commit.c\n> index ef5e622c077..a7315ed67cc 100644\n> --- a/builtin/commit.c\n> +++ b/builtin/commit.c\n> @@ -44,7 +44,7 @@\n> #include \"trailer.h\"\n> \n> static const char * const builtin_commit_usage[] = {\n> -\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\\n\"\n> +\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\\n\"\n> \t \" [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\\n\"\n> \t \" [-F | -m ] [--reset-author] [--allow-empty]\\n\"\n> \t \" [--allow-empty-message] [--no-verify] [-e] [--author=]\\n\"\n\nI guess this change is required to make t0450 happy?\n\nPatrick\n"},{"id":"510122","messageId":"2353488.ElGaqSPkdT@cayenne","threadId":"62730","inReplyTo":"Z3uIZA0bIXzaUxlH@pks.im","subject":"Re: [PATCH 1/3] doc: git-commit: apply new documentation guidelines","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2025-01-07T21:14:14Z","receivedAt":"2025-01-07T21:21:57Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"Le lundi 6 janvier 2025, 08:38:19 CET Patrick Steinhardt a écrit :\n> On Fri, Jan 03, 2025 at 01:47:24PM +0000, Jean-Noël Avila via GitGitGadget \nwrote:\n> > From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n> > \n> > The documentation for git-commit has been updated to follow the new\n> > documentation guidelines. The following changes have been applied to\n> > the series of patches:\n> > \n> > - switching 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\n> > descriptions`. The new rendering engine will apply synopsis rules to\n> > these spans.\n> > \n> > Additionally, some option descriptions have been turned into\n> > imperative mood to make them more consistent with the rest of the\n> > documentation.\n> \n> Same comment here regarding the commit message as on the other two\n> series. We should use imperative mood for it, as well :)\n\nThanks for reviewing.\n\nBeing consistent with myself is imperative ;-)\n\n> \n> > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\n> > index c822113c111..b08a398e31d 100644\n> > --- a/Documentation/git-commit.txt\n> > +++ b/Documentation/git-commit.txt\n> > @@ -58,139 +58,139 @@ summary of what is included by any of the above for \nthe next\n> > --z::\n> > ---null::\n> > +`-z`::\n> > +`--null`::\n> > \tWhen showing `short` or `porcelain` status output, print the\n> > -\tfilename verbatim and terminate the entries with NUL, instead of \nLF.\n> > +\tfilename verbatim and terminate the entries with _NUL_, instead of \n_LF_.\n> > \tIf no format is given, implies the `--porcelain` output format.\n> > \tWithout the `-z` option, filenames with \"unusual\" characters are\n> > \tquoted as explained for the configuration variable \n`core.quotePath`\n> > \t(see linkgit:git-config[1]).\n> > \n> > --F ::\n> > ---file=::\n> > -\tTake the commit message from the given file. Use '-' to\n> > +`-F `::\n> > +`--file=`::\n> > +\tTake the commit message from __. Use `-` to\n> \n> I think it would make sense to move changes like this, where the actual\n> wording changes, into a separate commit. That'd make it way easier to\n> spot the non-mechanical changes from those that may require some\n> discussion.\n\nTrue. There are other parts where I introduced the place holder as an echo to \nthe option description. The idea is to be less verbose and more contextual.\n\n> \n> > @@ -257,19 +256,18 @@ default::\n> > The default can be changed by the `commit.cleanup` configuration\n> > variable (see linkgit:git-config[1]).\n> > \n> > --e::\n> > ---edit::\n> > -\tThe message taken from file with `-F`, command line with\n> > -\t`-m`, and from commit object with `-C` are usually used as\n> > -\tthe commit log message unmodified. This option lets you\n> > -\tfurther edit the message taken from these sources.\n> > +`-e`::\n> > +`--edit`::\n> > +\tLet the user further edit the message taken from file\n> \n> There's a double space here. I was also wondering whether this should\n> say __ here to further clarify that this refers to the same\n> placeholder as the placeholder in `-F`. Might be confusing though, I\n> dunno.\n\nThis would sound a bit repetitive, but it is still better than making the \nreader refer to the entries for each option, in which case I would also add \nthe placeholders when listing the options.\n\n> \n> > diff --git a/builtin/commit.c b/builtin/commit.c\n> > index ef5e622c077..a7315ed67cc 100644\n> > --- a/builtin/commit.c\n> > +++ b/builtin/commit.c\n> > @@ -44,7 +44,7 @@\n> > #include \"trailer.h\"\n> > \n> > static const char * const builtin_commit_usage[] = {\n> > -\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u] \n[--amend]\\n\"\n> > +\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-\nu[]] [--amend]\\n\"\n> > \t \" [--dry-run] [(-c | -C | --squash) | --\nfixup [(amend|reword):]]\\n\"\n> > \t \" [-F | -m ] [--reset-author] [--allow-\nempty]\\n\"\n> > \t \" [--allow-empty-message] [--no-verify] [-e] [--\nauthor=]\\n\"\n> \n> I guess this change is required to make t0450 happy?\n\n\nYes it is. To be honest, I was about to try to complete the synopsis for all \ncommands, but finally let this task for another round, because I'm not even \nclear on what is alternative and what can be combined.\n\n> \n> Patrick\n> \n> \n\n\n\n\n"},{"id":"510603","messageId":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.git.1735912046.gitgitgadget@gmail.com","subject":"[PATCH v2 0/5] Doc git commit","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:43Z","receivedAt":"2025-01-15T20:23:52Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This series continues the effort of rewriting the documentation with\nuniformization and better formatting of the man pages. This time, git-commit\nis processed, taking advantage of previous experiences.\n\nJean-Noël Avila (5):\n doc: apply new documentation guidelines to git commit\n doc: the mode param of -u of git commit is optional\n doc: make more direct explanations in git commit options\n doc: convert git commit config to new format\n doc: migrate git-commit manpage secondary files to new format\n\n Documentation/config/commit.txt | 25 +--\n Documentation/git-commit.txt | 281 +++++++++++++++----------------\n Documentation/i18n.txt | 4 +-\n Documentation/signoff-option.txt | 8 +-\n builtin/commit.c | 2 +-\n 5 files changed, 161 insertions(+), 159 deletions(-)\n\n\nbase-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1845%2Fjnavila%2Fdoc_git-commit-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1845/jnavila/doc_git-commit-v2\nPull-Request: https://github.com/gitgitgadget/git/pull/1845\n\nRange-diff vs v1:\n\n 1: dfd907fc314 ! 1: 91cff84b5f8 doc: git-commit: apply new documentation guidelines\n @@ Metadata\n Author: Jean-Noël Avila \n \n ## Commit message ##\n - doc: git-commit: apply new documentation guidelines\n + doc: apply new documentation guidelines to git commit\n \n - The documentation for git-commit has been updated to follow the new\n - documentation guidelines. The following changes have been applied to\n - the series of patches:\n -\n - - switching the synopsis to a synopsis block which will automatically\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\n descriptions`. The new rendering engine will apply synopsis rules to\n these spans.\n \n - Additionally, some option descriptions have been turned into\n - imperative mood to make them more consistent with the rest of the\n - documentation.\n -\n Signed-off-by: Jean-Noël Avila \n \n ## Documentation/git-commit.txt ##\n @@ Documentation/git-commit.txt: git-commit - Record changes to the repository\n -[verse]\n -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n +[synopsis]\n -+git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\n ++git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n \t [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n \t [-F | -m ] [--reset-author] [--allow-empty]\n \t [--allow-empty-message] [--no-verify] [-e] [--author=]\n @@ Documentation/git-commit.txt: summary of what is included by any of the above fo\n -------\n --a::\n ---all::\n --\tTell the command to automatically stage files that have\n +`-a`::\n +`--all`::\n -+\tAutomatically stage files that have\n + \tTell the command to automatically stage files that have\n \tbeen modified and deleted, but new files you have not\n \ttold Git about are not affected.\n \n @@ Documentation/git-commit.txt: summary of what is included by any of the above fo\n \n --F ::\n ---file=::\n --\tTake the commit message from the given file. Use '-' to\n +`-F `::\n +`--file=`::\n -+\tTake the commit message from __. Use `-` to\n + \tTake the commit message from the given file. Use '-' to\n \tread the message from the standard input.\n \n ---author=::\n @@ Documentation/git-commit.txt: summary of what is included by any of the above fo\n \n --m ::\n ---message=::\n --\tUse the given as the commit message.\n +`-m `::\n +`--message=`::\n -+\tUse __ as the commit message.\n + \tUse the given as the commit message.\n \tIf multiple `-m` options are given, their values are\n \tconcatenated as separate paragraphs.\n +\n @@ Documentation/git-commit.txt: summary of what is included by any of the above fo\n +`-t `::\n +`--template=`::\n \tWhen editing the commit message, start the editor with the\n --\tcontents in the given file. The `commit.template` configuration\n -+\tcontents in __. The `commit.template` configuration\n + \tcontents in the given file. The `commit.template` configuration\n \tvariable is often used to give this option implicitly to the\n - \tcommand. This mechanism can be used by projects that want to\n - \tguide participants with some hints on what to write in the message\n @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n \n include::signoff-option.txt[]\n @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, `\n \n --n::\n ---[no-]verify::\n --\tBy default, the pre-commit and commit-msg hooks are run.\n --\tWhen any of `--no-verify` or `-n` is given, these are bypassed.\n +`-n`::\n +`--[no-]verify`::\n -+\tBypass the `pre-commit` and `commit-msg` hooks.\n + \tBy default, the pre-commit and commit-msg hooks are run.\n + \tWhen any of `--no-verify` or `-n` is given, these are bypassed.\n \tSee also linkgit:githooks[5].\n \n ---allow-empty::\n @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, `\n linkgit:git-commit-tree[1].\n \n ---cleanup=::\n --\tThis option determines how the supplied commit message should be\n +`--cleanup=`::\n -+\tDetermine how the supplied commit message should be\n + \tThis option determines how the supplied commit message should be\n \tcleaned up before committing. The '' can be `strip`,\n \t`whitespace`, `verbatim`, `scissors` or `default`.\n +\n @@ Documentation/git-commit.txt: default::\n \n --e::\n ---edit::\n --\tThe message taken from file with `-F`, command line with\n --\t`-m`, and from commit object with `-C` are usually used as\n --\tthe commit log message unmodified. This option lets you\n --\tfurther edit the message taken from these sources.\n +`-e`::\n +`--edit`::\n -+\tLet the user further edit the message taken from file\n -+\twith `-F`, command line with `-m`, and from commit object\n -+\twith `-C` are usually used as the commit log message unmodified.\n + \tThe message taken from file with `-F`, command line with\n + \t`-m`, and from commit object with `-C` are usually used as\n + \tthe commit log message unmodified. This option lets you\n + \tfurther edit the message taken from these sources.\n \n ---no-edit::\n +`--no-edit`::\n @@ Documentation/git-commit.txt: include::i18n.txt[]\n `VISUAL` environment variable, or the `EDITOR` environment variable (in that\n order). See linkgit:git-var[1] for details.\n \n -\n - ## builtin/commit.c ##\n -@@\n - #include \"trailer.h\"\n - \n - static const char * const builtin_commit_usage[] = {\n --\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\\n\"\n -+\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\\n\"\n - \t \" [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\\n\"\n - \t \" [-F | -m ] [--reset-author] [--allow-empty]\\n\"\n - \t \" [--allow-empty-message] [--no-verify] [-e] [--author=]\\n\"\n -: ----------- > 2: d58526a9b39 doc: the mode param of -u of git commit is optional\n -: ----------- > 3: 39db87ff906 doc: make more direct explanations in git commit options\n 2: 9f518ec8f9d ! 4: 9216554bd70 doc: git-commit.txt: convert git commit config to new format\n @@ Metadata\n Author: Jean-Noël Avila \n \n ## Commit message ##\n - doc: git-commit.txt: convert git commit config to new format\n + doc: convert git commit config to new format\n \n Also prevent git-commit manpage to refer to itself in the config\n description by using a variable.\n 3: 9f8d4e74b7b ! 5: 28316a709da doc: git-commit: migrate secondary files to new format\n @@ Metadata\n Author: Jean-Noël Avila \n \n ## Commit message ##\n - doc: git-commit: migrate secondary files to new format\n + doc: migrate git-commit manpage secondary files to new format\n \n Signed-off-by: Jean-Noël Avila \n \n\n-- \ngitgitgadget\n"},{"id":"510605","messageId":"91cff84b5f8d9e1140e94dd96d259224ea905611.1736972628.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","subject":"[PATCH v2 1/5] doc: apply new documentation guidelines to git commit","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:44Z","receivedAt":"2025-01-15T20:23:53Z","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\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-commit.txt | 256 +++++++++++++++++------------------\n 1 file changed, 128 insertions(+), 128 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex c822113c111..e37c4a4987e 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -7,8 +7,8 @@ git-commit - Record changes to the repository\n \n SYNOPSIS\n --------\n-[verse]\n-'git commit' [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n+[synopsis]\n+git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n \t [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n \t [-F | -m ] [--reset-author] [--allow-empty]\n \t [--allow-empty-message] [--no-verify] [-e] [--author=]\n@@ -23,31 +23,31 @@ Create a new commit containing the current contents of the index and\n the given log message describing the changes. The new commit is a\n direct child of HEAD, usually the tip of the current branch, and the\n branch is updated to point to it (unless no branch is associated with\n-the working tree, in which case HEAD is \"detached\" as described in\n+the working tree, in which case `HEAD` is \"detached\" as described in\n linkgit:git-checkout[1]).\n \n The content to be committed can be specified in several ways:\n \n 1. by using linkgit:git-add[1] to incrementally \"add\" changes to the\n- index before using the 'commit' command (Note: even modified files\n+ index before using the `commit` command (Note: even modified files\n must be \"added\");\n \n 2. by using linkgit:git-rm[1] to remove files from the working tree\n- and the index, again before using the 'commit' command;\n+ and the index, again before using the `commit` command;\n \n-3. by listing files as arguments to the 'commit' command\n- (without --interactive or --patch switch), in which\n+3. by listing files as arguments to the `commit` command\n+ (without `--interactive` or `--patch` switch), in which\n case the commit will ignore changes staged in the index, and instead\n record the current content of the listed files (which must already\n be known to Git);\n \n-4. by using the -a switch with the 'commit' command to automatically\n+4. by using the `-a` switch with the `commit` command to automatically\n \"add\" changes from all known files (i.e. all files that are already\n listed in the index) and to automatically \"rm\" files in the index\n that have been removed from the working tree, and then perform the\n actual commit;\n \n-5. by using the --interactive or --patch switches with the 'commit' command\n+5. by using the `--interactive` or `--patch` switches with the `commit` command\n to decide one by one which files or hunks should be part of the commit\n in addition to contents in the index,\n before finalizing the operation. See the ``Interactive Mode'' section of\n@@ -58,137 +58,137 @@ summary of what is included by any of the above for the next\n commit by giving the same set of parameters (options and paths).\n \n If you make a commit and then find a mistake immediately after\n-that, you can recover from it with 'git reset'.\n+that, you can recover from it with `git reset`.\n \n :git-commit: 1\n \n OPTIONS\n -------\n--a::\n---all::\n+`-a`::\n+`--all`::\n \tTell the command to automatically stage files that have\n \tbeen modified and deleted, but new files you have not\n \ttold Git about are not affected.\n \n--p::\n---patch::\n+`-p`::\n+`--patch`::\n \tUse the interactive patch selection interface to choose\n \twhich changes to commit. See linkgit:git-add[1] for\n \tdetails.\n \n--C ::\n---reuse-message=::\n-\tTake an existing commit object, and reuse the log message\n+`-C `::\n+`--reuse-message=`::\n+\tTake an existing __ object, and reuse the log message\n \tand the authorship information (including the timestamp)\n \twhen creating the commit.\n \n--c ::\n---reedit-message=::\n-\tLike '-C', but with `-c` the editor is invoked, so that\n+`-c `::\n+`--reedit-message=`::\n+\tLike `-C`, but with `-c` the editor is invoked, so that\n \tthe user can further edit the commit message.\n \n---fixup=[(amend|reword):]::\n-\tCreate a new commit which \"fixes up\" `` when applied with\n+`--fixup=[(amend|reword):]`::\n+\tCreate a new commit which \"fixes up\" __ when applied with\n \t`git rebase --autosquash`. Plain `--fixup=` creates a\n-\t\"fixup!\" commit which changes the content of `` but leaves\n+\t\"fixup!\" commit which changes the content of __ but leaves\n \tits log message untouched. `--fixup=amend:` is similar but\n \tcreates an \"amend!\" commit which also replaces the log message of\n-\t`` with the log message of the \"amend!\" commit.\n+\t__ with the log message of the \"amend!\" commit.\n \t`--fixup=reword:` creates an \"amend!\" commit which\n-\treplaces the log message of `` with its own log message\n-\tbut makes no changes to the content of ``.\n+\treplaces the log message of __ with its own log message\n+\tbut makes no changes to the content of __.\n +\n The commit created by plain `--fixup=` has a subject\n-composed of \"fixup!\" followed by the subject line from ,\n+composed of \"fixup!\" followed by the subject line from __,\n and is recognized specially by `git rebase --autosquash`. The `-m`\n option may be used to supplement the log message of the created\n commit, but the additional commentary will be thrown away once the\n-\"fixup!\" commit is squashed into `` by\n+\"fixup!\" commit is squashed into __ by\n `git rebase --autosquash`.\n +\n The commit created by `--fixup=amend:` is similar but its\n subject is instead prefixed with \"amend!\". The log message of\n- is copied into the log message of the \"amend!\" commit and\n+__ is copied into the log message of the \"amend!\" commit and\n opened in an editor so it can be refined. When `git rebase\n---autosquash` squashes the \"amend!\" commit into ``, the\n-log message of `` is replaced by the refined log message\n+--autosquash` squashes the \"amend!\" commit into __, the\n+log message of __ is replaced by the refined log message\n from the \"amend!\" commit. It is an error for the \"amend!\" commit's\n log message to be empty unless `--allow-empty-message` is\n specified.\n +\n `--fixup=reword:` is shorthand for `--fixup=amend:\n---only`. It creates an \"amend!\" commit with only a log message\n+ --only`. It creates an \"amend!\" commit with only a log message\n (ignoring any changes staged in the index). When squashed by `git\n-rebase --autosquash`, it replaces the log message of ``\n+rebase --autosquash`, it replaces the log message of __\n without making any other changes.\n +\n Neither \"fixup!\" nor \"amend!\" commits change authorship of\n-`` when applied by `git rebase --autosquash`.\n+__ when applied by `git rebase --autosquash`.\n See linkgit:git-rebase[1] for details.\n \n---squash=::\n-\tConstruct a commit message for use with `rebase --autosquash`.\n+`--squash=`::\n+\tConstruct a commit message for use with `git rebase --autosquash`.\n \tThe commit message subject line is taken from the specified\n \tcommit with a prefix of \"squash! \". Can be used with additional\n \tcommit message options (`-m`/`-c`/`-C`/`-F`). See\n \tlinkgit:git-rebase[1] for details.\n \n---reset-author::\n-\tWhen used with -C/-c/--amend options, or when committing after a\n+`--reset-author`::\n+\tWhen used with `-C`/`-c`/`--amend` options, or when committing after a\n \tconflicting cherry-pick, declare that the authorship of the\n \tresulting commit now belongs to the committer. This also renews\n \tthe author timestamp.\n \n---short::\n+`--short`::\n \tWhen doing a dry-run, give the output in the short-format. See\n \tlinkgit:git-status[1] for details. Implies `--dry-run`.\n \n---branch::\n+`--branch`::\n \tShow the branch and tracking info even in short-format.\n \n---porcelain::\n+`--porcelain`::\n \tWhen doing a dry-run, give the output in a porcelain-ready\n \tformat. See linkgit:git-status[1] for details. Implies\n \t`--dry-run`.\n \n---long::\n+`--long`::\n \tWhen doing a dry-run, give the output in the long-format.\n \tImplies `--dry-run`.\n \n--z::\n---null::\n+`-z`::\n+`--null`::\n \tWhen showing `short` or `porcelain` status output, print the\n-\tfilename verbatim and terminate the entries with NUL, instead of LF.\n+\tfilename verbatim and terminate the entries with _NUL_, instead of _LF_.\n \tIf no format is given, implies the `--porcelain` output format.\n \tWithout the `-z` option, filenames with \"unusual\" characters are\n \tquoted as explained for the configuration variable `core.quotePath`\n \t(see linkgit:git-config[1]).\n \n--F ::\n---file=::\n+`-F `::\n+`--file=`::\n \tTake the commit message from the given file. Use '-' to\n \tread the message from the standard input.\n \n---author=::\n+`--author=`::\n \tOverride the commit author. Specify an explicit author using the\n-\tstandard `A U Thor ` format. Otherwise \n+\tstandard `A U Thor ` format. Otherwise __\n \tis assumed to be a pattern and is used to search for an existing\n-\tcommit by that author (i.e. rev-list --all -i --author=);\n+\tcommit by that author (i.e. `git rev-list --all -i --author=`);\n \tthe commit author is then copied from the first such commit found.\n \n---date=::\n+`--date=`::\n \tOverride the author date used in the commit.\n \n--m ::\n---message=::\n+`-m `::\n+`--message=`::\n \tUse the given as the commit message.\n \tIf multiple `-m` options are given, their values are\n \tconcatenated as separate paragraphs.\n +\n The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n \n--t ::\n---template=::\n+`-t `::\n+`--template=`::\n \tWhen editing the commit message, start the editor with the\n \tcontents in the given file. The `commit.template` configuration\n \tvariable is often used to give this option implicitly to the\n@@ -200,56 +200,56 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n \n include::signoff-option.txt[]\n \n---trailer [(=|:)]::\n-\tSpecify a (, ) pair that should be applied as a\n+`--trailer [(=|:)]`::\n+\tSpecify a (__, __) pair that should be applied as a\n \ttrailer. (e.g. `git commit --trailer \"Signed-off-by:C O Mitter \\\n \t\" --trailer \"Helped-by:C O Mitter \\\n-\t\"` will add the \"Signed-off-by\" trailer\n-\tand the \"Helped-by\" trailer to the commit message.)\n+\t\"` will add the `Signed-off-by` trailer\n+\tand the `Helped-by` trailer to the commit message.)\n \tThe `trailer.*` configuration variables\n \t(linkgit:git-interpret-trailers[1]) can be used to define if\n \ta duplicated trailer is omitted, where in the run of trailers\n \teach trailer would appear, and other details.\n \n--n::\n---[no-]verify::\n+`-n`::\n+`--[no-]verify`::\n \tBy default, the pre-commit and commit-msg hooks are run.\n \tWhen any of `--no-verify` or `-n` is given, these are bypassed.\n \tSee also linkgit:githooks[5].\n \n---allow-empty::\n+`--allow-empty`::\n \tUsually recording a commit that has the exact same tree as its\n \tsole parent commit is a mistake, and the command prevents you\n \tfrom making such a commit. This option bypasses the safety, and\n \tis primarily for use by foreign SCM interface scripts.\n \n---allow-empty-message::\n- Like --allow-empty this command is primarily for use by foreign\n+`--allow-empty-message`::\n+ Like `--allow-empty` this command is primarily for use by foreign\n SCM interface scripts. It allows you to create a commit with an\n empty commit message without using plumbing commands like\n linkgit:git-commit-tree[1].\n \n---cleanup=::\n+`--cleanup=`::\n \tThis option determines how the supplied commit message should be\n \tcleaned up before committing. The '' can be `strip`,\n \t`whitespace`, `verbatim`, `scissors` or `default`.\n +\n --\n-strip::\n+`strip`::\n \tStrip leading and trailing empty lines, trailing whitespace,\n \tcommentary and collapse consecutive empty lines.\n-whitespace::\n+`whitespace`::\n \tSame as `strip` except #commentary is not removed.\n-verbatim::\n+`verbatim`::\n \tDo not change the message at all.\n-scissors::\n+`scissors`::\n \tSame as `whitespace` except that everything from (and including)\n \tthe line found below is truncated, if the message is to be edited.\n-\t\"`#`\" can be customized with core.commentChar.\n+\t\"`#`\" can be customized with `core.commentChar`.\n \n \t\t# ------------------------ >8 ------------------------\n \n-default::\n+`default`::\n \tSame as `strip` if the message is to be edited.\n \tOtherwise `whitespace`.\n --\n@@ -257,19 +257,19 @@ default::\n The default can be changed by the `commit.cleanup` configuration\n variable (see linkgit:git-config[1]).\n \n--e::\n---edit::\n+`-e`::\n+`--edit`::\n \tThe message taken from file with `-F`, command line with\n \t`-m`, and from commit object with `-C` are usually used as\n \tthe commit log message unmodified. This option lets you\n \tfurther edit the message taken from these sources.\n \n---no-edit::\n+`--no-edit`::\n \tUse the selected commit message without launching an editor.\n \tFor example, `git commit --amend --no-edit` amends a commit\n \twithout changing its commit message.\n \n---amend::\n+`--amend`::\n \tReplace the tip of the current branch by creating a new\n \tcommit. The recorded tree is prepared as usual (including\n \tthe effect of the `-i` and `-o` options and explicit\n@@ -295,23 +295,23 @@ You should understand the implications of rewriting history if you\n amend a commit that has already been published. (See the \"RECOVERING\n FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \n---no-post-rewrite::\n-\tBypass the post-rewrite hook.\n+`--no-post-rewrite`::\n+\tBypass the `post-rewrite` hook.\n \n--i::\n---include::\n+`-i`::\n+`--include`::\n \tBefore making a commit out of staged contents so far,\n \tstage the contents of paths given on the command line\n \tas well. This is usually not what you want unless you\n \tare concluding a conflicted merge.\n \n--o::\n---only::\n+`-o`::\n+`--only`::\n \tMake a commit by taking the updated working tree contents\n \tof the paths specified on the\n \tcommand line, disregarding any contents that have been\n \tstaged for other paths. This is the default mode of operation of\n-\t'git commit' if any paths are given on the command line,\n+\t`git commit` if any paths are given on the command line,\n \tin which case this option can be omitted.\n \tIf this option is specified together with `--amend`, then\n \tno paths need to be specified, which can be used to amend\n@@ -319,48 +319,48 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \talready been staged. If used together with `--allow-empty`\n \tpaths are also not required, and an empty commit will be created.\n \n---pathspec-from-file=::\n-\tPathspec is passed in `` instead of commandline args. If\n-\t`` is exactly `-` then standard input is used. Pathspec\n-\telements are separated by LF or CR/LF. Pathspec elements can be\n+`--pathspec-from-file=`::\n+\tPathspec is passed in __ instead of commandline args. If\n+\t__ is exactly `-` then standard input is used. Pathspec\n+\telements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be\n \tquoted as explained for the configuration variable `core.quotePath`\n \t(see linkgit:git-config[1]). See also `--pathspec-file-nul` and\n \tglobal `--literal-pathspecs`.\n \n---pathspec-file-nul::\n+`--pathspec-file-nul`::\n \tOnly meaningful with `--pathspec-from-file`. Pathspec elements are\n-\tseparated with NUL character and all other characters are taken\n+\tseparated with _NUL_ character and all other characters are taken\n \tliterally (including newlines and quotes).\n \n--u[]::\n---untracked-files[=]::\n+`-u[]`::\n+`--untracked-files[=]`::\n \tShow untracked files.\n +\n --\n-The mode parameter is optional (defaults to 'all'), and is used to\n-specify the handling of untracked files; when -u is not used, the\n-default is 'normal', i.e. show untracked files and directories.\n+The __ parameter is optional (defaults to `all`), and is used to\n+specify the handling of untracked files; when `-u` is not used, the\n+default is `normal`, i.e. show untracked files and directories.\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`:: Shows untracked files and directories\n+`all`:: Also shows individual files in untracked directories.\n \n All usual spellings for Boolean value `true` are taken as `normal`\n and `false` as `no`.\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--v::\n---verbose::\n-\tShow unified diff between the HEAD commit and what\n+`-v`::\n+`--verbose`::\n+\tShow unified diff between the `HEAD` commit and what\n \twould be committed at the bottom of the commit message\n \ttemplate to help the user describe the commit by reminding\n \twhat changes the commit has.\n \tNote that this diff output doesn't have its\n-\tlines prefixed with '#'. This diff will not be a part\n+\tlines prefixed with `#`. This diff will not be a part\n \tof the commit message. See the `commit.verbose` configuration\n \tvariable in linkgit:git-config[1].\n +\n@@ -368,40 +368,40 @@ If specified twice, show in addition the unified diff between\n what would be committed and the worktree files, i.e. the unstaged\n changes to tracked files.\n \n--q::\n---quiet::\n+`-q`::\n+`--quiet`::\n \tSuppress commit summary message.\n \n---dry-run::\n+`--dry-run`::\n \tDo not create a commit, but show a list of paths that are\n \tto be committed, paths with local changes that will be left\n \tuncommitted and paths that are untracked.\n \n---status::\n+`--status`::\n \tInclude the output of linkgit:git-status[1] in the commit\n \tmessage template when using an editor to prepare the commit\n \tmessage. Defaults to on, but can be used to override\n-\tconfiguration variable commit.status.\n+\tconfiguration variable `commit.status`.\n \n---no-status::\n+`--no-status`::\n \tDo not include the output of linkgit:git-status[1] in the\n \tcommit message template when using an editor to prepare the\n \tdefault commit message.\n \n--S[]::\n---gpg-sign[=]::\n---no-gpg-sign::\n-\tGPG-sign commits. The `keyid` argument is optional and\n+`-S[]`::\n+`--gpg-sign[=]`::\n+`--no-gpg-sign`::\n+\tGPG-sign commits. The __ is optional and\n \tdefaults to the committer identity; if specified, it must be\n \tstuck to the option without a space. `--no-gpg-sign` is useful to\n \tcountermand both `commit.gpgSign` configuration variable, and\n \tearlier `--gpg-sign`.\n \n-\\--::\n+`--`::\n \tDo not interpret any more arguments as options.\n \n-...::\n-\tWhen pathspec is given on the command line, commit the contents of\n+`...`::\n+\tWhen __ is given on the command line, commit the contents of\n \tthe files that match the pathspec without recording the changes\n \talready added to the index. The contents of these files are also\n \tstaged for the next commit on top of what have been staged before.\n@@ -412,10 +412,10 @@ EXAMPLES\n --------\n When recording your own work, the contents of modified files in\n your working tree are temporarily stored to a staging area\n-called the \"index\" with 'git add'. A file can be\n+called the \"index\" with `git add`. A file can be\n reverted back, only in the index but not in the working tree,\n to that of the last commit with `git restore --staged `,\n-which effectively reverts 'git add' and prevents the changes to\n+which effectively reverts `git add` and prevents the changes to\n this file from participating in the next commit. After building\n the state to be committed incrementally with these commands,\n `git commit` (without any pathname parameter) is used to record what\n@@ -443,7 +443,7 @@ $ git commit -a\n ------------\n \n The command `git commit -a` first looks at your working tree,\n-notices that you have modified hello.c and removed goodbye.c,\n+notices that you have modified `hello.c` and removed `goodbye.c`,\n and performs necessary `git add` and `git rm` for you.\n \n After staging changes to many files, you can alter the order the\n@@ -471,13 +471,13 @@ $ git commit\n this second commit would record the changes to `hello.c` and\n `hello.h` as expected.\n \n-After a merge (initiated by 'git merge' or 'git pull') stops\n+After a merge (initiated by `git merge` or `git pull`) stops\n because of conflicts, cleanly merged\n paths are already staged to be committed for you, and paths that\n conflicted are left in unmerged state. You would have to first\n-check which paths are conflicting with 'git status'\n+check which paths are conflicting with `git status`\n and after fixing them manually in your working tree, you would\n-stage the result as usual with 'git add':\n+stage the result as usual with `git add`:\n \n ------------\n $ git status | grep unmerged\n@@ -507,12 +507,12 @@ COMMIT INFORMATION\n Author and committer information is taken from the following environment\n variables, if set:\n \n-\tGIT_AUTHOR_NAME\n-\tGIT_AUTHOR_EMAIL\n-\tGIT_AUTHOR_DATE\n-\tGIT_COMMITTER_NAME\n-\tGIT_COMMITTER_EMAIL\n-\tGIT_COMMITTER_DATE\n+ * `GIT_AUTHOR_NAME`\n+ * `GIT_AUTHOR_EMAIL`\n+ * `GIT_AUTHOR_DATE`\n+ * `GIT_COMMITTER_NAME`\n+ * `GIT_COMMITTER_EMAIL`\n+ * `GIT_COMMITTER_DATE`\n \n (nb \"<\", \">\" and \"\\n\"s are stripped)\n \n@@ -524,7 +524,7 @@ that, see the `credential.username` variable in linkgit:git-config[1].\n \n In case (some of) these environment variables are not set, the information\n is taken from the configuration items `user.name` and `user.email`, or, if not\n-present, the environment variable EMAIL, or, if that is not set,\n+present, the environment variable `EMAIL`, or, if that is not set,\n system user name and the hostname used for outgoing mail (taken\n from `/etc/mailname` and falling back to the fully qualified hostname when\n that file does not exist).\n@@ -555,7 +555,7 @@ include::i18n.txt[]\n ENVIRONMENT AND CONFIGURATION VARIABLES\n ---------------------------------------\n The editor used to edit the commit log message will be chosen from the\n-`GIT_EDITOR` environment variable, the core.editor configuration variable, the\n+`GIT_EDITOR` environment variable, the `core.editor` configuration variable, the\n `VISUAL` environment variable, or the `EDITOR` environment variable (in that\n order). See linkgit:git-var[1] for details.\n \n-- \ngitgitgadget\n\n"},{"id":"510604","messageId":"d58526a9b39571dc2dd2703f62082d20b7a82446.1736972628.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","subject":"[PATCH v2 2/5] doc: the mode param of -u of git commit is optional","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:45Z","receivedAt":"2025-01-15T20:23:54Z","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\nFix the synopsis to reflect the option description.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-commit.txt | 2 +-\n builtin/commit.c | 2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex e37c4a4987e..f5d702205d2 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -8,7 +8,7 @@ git-commit - Record changes to the repository\n SYNOPSIS\n --------\n [synopsis]\n-git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n+git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\n \t [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n \t [-F | -m ] [--reset-author] [--allow-empty]\n \t [--allow-empty-message] [--no-verify] [-e] [--author=]\ndiff --git a/builtin/commit.c b/builtin/commit.c\nindex ef5e622c077..a7315ed67cc 100644\n--- a/builtin/commit.c\n+++ b/builtin/commit.c\n@@ -44,7 +44,7 @@\n #include \"trailer.h\"\n \n static const char * const builtin_commit_usage[] = {\n-\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\\n\"\n+\tN_(\"git commit [-a | --interactive | --patch] [-s] [-v] [-u[]] [--amend]\\n\"\n \t \" [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\\n\"\n \t \" [-F | -m ] [--reset-author] [--allow-empty]\\n\"\n \t \" [--allow-empty-message] [--no-verify] [-e] [--author=]\\n\"\n-- \ngitgitgadget\n\n"},{"id":"510606","messageId":"39db87ff906744f45ef83d9d66fb914417c350a9.1736972628.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","subject":"[PATCH v2 3/5] doc: make more direct explanations in git commit options","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:46Z","receivedAt":"2025-01-15T20:23:55Z","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- Use imperative mood\n- make use of the placeholder format to simplify style\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-commit.txt | 29 +++++++++++++----------------\n 1 file changed, 13 insertions(+), 16 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex f5d702205d2..602e2f1200b 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -66,7 +66,7 @@ OPTIONS\n -------\n `-a`::\n `--all`::\n-\tTell the command to automatically stage files that have\n+\tAutomatically stage files that have\n \tbeen modified and deleted, but new files you have not\n \ttold Git about are not affected.\n \n@@ -166,7 +166,7 @@ See linkgit:git-rebase[1] for details.\n \n `-F `::\n `--file=`::\n-\tTake the commit message from the given file. Use '-' to\n+\tTake the commit message from __. Use '-' to\n \tread the message from the standard input.\n \n `--author=`::\n@@ -181,7 +181,7 @@ See linkgit:git-rebase[1] for details.\n \n `-m `::\n `--message=`::\n-\tUse the given as the commit message.\n+\tUse __ as the commit message.\n \tIf multiple `-m` options are given, their values are\n \tconcatenated as separate paragraphs.\n +\n@@ -190,7 +190,7 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.\n `-t `::\n `--template=`::\n \tWhen editing the commit message, start the editor with the\n-\tcontents in the given file. The `commit.template` configuration\n+\tcontents in __. The `commit.template` configuration\n \tvariable is often used to give this option implicitly to the\n \tcommand. This mechanism can be used by projects that want to\n \tguide participants with some hints on what to write in the message\n@@ -213,8 +213,7 @@ include::signoff-option.txt[]\n \n `-n`::\n `--[no-]verify`::\n-\tBy default, the pre-commit and commit-msg hooks are run.\n-\tWhen any of `--no-verify` or `-n` is given, these are bypassed.\n+\tBypass the `pre-commit` and `commit-msg` hooks.\n \tSee also linkgit:githooks[5].\n \n `--allow-empty`::\n@@ -224,13 +223,12 @@ include::signoff-option.txt[]\n \tis primarily for use by foreign SCM interface scripts.\n \n `--allow-empty-message`::\n- Like `--allow-empty` this command is primarily for use by foreign\n- SCM interface scripts. It allows you to create a commit with an\n- empty commit message without using plumbing commands like\n- linkgit:git-commit-tree[1].\n+\tCreate a commit with an empty commit message without using plumbing\n+\tcommands like linkgit:git-commit-tree[1]. Like `--allow-empty`, this\n+\tcommand is primarily for use by foreign SCM interface scripts.\n \n `--cleanup=`::\n-\tThis option determines how the supplied commit message should be\n+\tDetermine how the supplied commit message should be\n \tcleaned up before committing. The '' can be `strip`,\n \t`whitespace`, `verbatim`, `scissors` or `default`.\n +\n@@ -259,10 +257,9 @@ variable (see linkgit:git-config[1]).\n \n `-e`::\n `--edit`::\n-\tThe message taken from file with `-F`, command line with\n-\t`-m`, and from commit object with `-C` are usually used as\n-\tthe commit log message unmodified. This option lets you\n-\tfurther edit the message taken from these sources.\n+\tLet the user further edit the message taken from __\n+\twith `-F `, command line with `-m `, and\n+\tfrom __ with `-C `.\n \n `--no-edit`::\n \tUse the selected commit message without launching an editor.\n@@ -320,7 +317,7 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n \tpaths are also not required, and an empty commit will be created.\n \n `--pathspec-from-file=`::\n-\tPathspec is passed in __ instead of commandline args. If\n+\tPass pathspec in __ instead of commandline args. If\n \t__ is exactly `-` then standard input is used. Pathspec\n \telements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be\n \tquoted as explained for the configuration variable `core.quotePath`\n-- \ngitgitgadget\n\n"},{"id":"510607","messageId":"9216554bd7096f2543e987fc7fd20f5e64630187.1736972628.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","subject":"[PATCH v2 4/5] doc: convert git commit config to new format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:47Z","receivedAt":"2025-01-15T20:23:56Z","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 prevent git-commit manpage to refer to itself in the config\ndescription by using a variable.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/config/commit.txt | 25 +++++++++++++++----------\n 1 file changed, 15 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt\nindex 62f0d92fda5..d3f4624fd27 100644\n--- a/Documentation/config/commit.txt\n+++ b/Documentation/config/commit.txt\n@@ -1,29 +1,34 @@\n-commit.cleanup::\n+ifdef::git-commit[]\n+:see-git-commit:\n+endif::git-commit[]\n+ifndef::git-commit[]\n+:see-git-commit: See linkgit:git-commit[1] for details.\n+endif::git-commit[]\n+`commit.cleanup`::\n \tThis setting overrides the default of the `--cleanup` option in\n-\t`git commit`. See linkgit:git-commit[1] for details. Changing the\n-\tdefault can be useful when you always want to keep lines that begin\n+\t`git commit`. {see-git-commit} Changing the default can be useful\n+\twhen you always want to keep lines that begin\n \twith the comment character `#` in your log message, in which case you\n \twould do `git config commit.cleanup whitespace` (note that you will\n \thave to remove the help lines that begin with `#` in the commit log\n \ttemplate yourself, if you do this).\n \n-commit.gpgSign::\n-\n+`commit.gpgSign`::\n \tA boolean to specify whether all commits should be GPG signed.\n \tUse of this option when doing operations such as rebase can\n \tresult in a large number of commits being signed. It may be\n \tconvenient to use an agent to avoid typing your GPG passphrase\n \tseveral times.\n \n-commit.status::\n+`commit.status`::\n \tA boolean to enable/disable inclusion of status information in the\n \tcommit message template when using an editor to prepare the commit\n-\tmessage. Defaults to true.\n+\tmessage. Defaults to `true`.\n \n-commit.template::\n+`commit.template`::\n \tSpecify the pathname of a file to use as the template for\n \tnew commit messages.\n \n-commit.verbose::\n+`commit.verbose`::\n \tA boolean or int to specify the level of verbosity with `git commit`.\n-\tSee linkgit:git-commit[1].\n+\t{see-git-commit}\n-- \ngitgitgadget\n\n"},{"id":"510608","messageId":"28316a709da913c624873291d96ed5aeddc6fc90.1736972628.git.gitgitgadget@gmail.com","threadId":"62730","inReplyTo":"pull.1845.v2.git.1736972628.gitgitgadget@gmail.com","subject":"[PATCH v2 5/5] doc: migrate git-commit manpage secondary files to new format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-01-15T20:23:48Z","receivedAt":"2025-01-15T20:23:57Z","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/i18n.txt | 4 ++--\n Documentation/signoff-option.txt | 8 ++++----\n 2 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/i18n.txt b/Documentation/i18n.txt\nindex 3a866af4a42..baff780a7e3 100644\n--- a/Documentation/i18n.txt\n+++ b/Documentation/i18n.txt\n@@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git\n does not forbid it. However, there are a few things to keep in\n mind.\n \n-. 'git commit' and 'git commit-tree' issue\n+. `git commit` and `git commit-tree` issue\n a warning if the commit log message given to it does not look\n like a valid UTF-8 string, unless you explicitly say your\n project uses a legacy encoding. The way to say this is to\n@@ -50,7 +50,7 @@ of `i18n.commitEncoding` in their `encoding` header. This is to\n help other people who look at them later. Lack of this header\n implies that the commit log message is encoded in UTF-8.\n \n-. 'git log', 'git show', 'git blame' and friends look at the\n+. `git log`, `git show`, `git blame` and friends look at the\n `encoding` header of a commit object, and try to re-code the\n log message into UTF-8 unless otherwise specified. You can\n specify the desired output encoding with\ndiff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt\nindex d98758f3cb7..cddfb225d1d 100644\n--- a/Documentation/signoff-option.txt\n+++ b/Documentation/signoff-option.txt\n@@ -1,8 +1,8 @@\n ifdef::git-commit[]\n--s::\n+`-s`::\n endif::git-commit[]\n---signoff::\n---no-signoff::\n+`--signoff`::\n+`--no-signoff`::\n \tAdd a `Signed-off-by` trailer by the committer at the end of the commit\n \tlog message. The meaning of a signoff depends on the project\n \tto which you're committing. For example, it may certify that\n@@ -14,5 +14,5 @@ endif::git-commit[]\n \tleadership of the project to which you're contributing to\n \tunderstand how the signoffs are used in that project.\n +\n-The --no-signoff option can be used to countermand an earlier --signoff\n+The `--no-signoff` option can be used to countermand an earlier `--signoff`\n option on the command line.\n-- \ngitgitgadget\n"},{"id":"510621","messageId":"xmqqh65zvdw1.fsf@gitster.g","threadId":"62730","inReplyTo":"91cff84b5f8d9e1140e94dd96d259224ea905611.1736972628.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 1/5] doc: apply new documentation guidelines to git commit","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-01-15T23:46:54Z","receivedAt":"2025-01-15T23:46:57Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Jean-Noël Avila via GitGitGadget\" writes:\n\n> -[verse]\n> -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n> +[synopsis]\n> +git commit [-a | --interactive | --patch] [-s] [-v] [-u] [--amend]\n> \t [--dry-run] [(-c | -C | --squash) | --fixup [(amend|reword):]]\n> \t [-F | -m ] [--reset-author] [--allow-empty]\n> \t [--allow-empty-message] [--no-verify] [-e] [--author=]\n\nIt is already nice enough that with just writing [synopsis] we do\nnot have to worry about backquoting literals emphasising\n and other mark-up minutiae. And then ...\n\n> --C ::\n> ---reuse-message=::\n> -\tTake an existing commit object, and reuse the log message\n> +`-C `::\n> +`--reuse-message=`::\n\n... we also are freed from the same worry whenever we use `here are\nthings that are treated pretty much the same way as in [synopsis]\nsection` notation like here. Quite nice.\n\n> @@ -507,12 +507,12 @@ COMMIT INFORMATION\n> Author and committer information is taken from the following environment\n> variables, if set:\n> \n> -\tGIT_AUTHOR_NAME\n> -\tGIT_AUTHOR_EMAIL\n> -\tGIT_AUTHOR_DATE\n> -\tGIT_COMMITTER_NAME\n> -\tGIT_COMMITTER_EMAIL\n> -\tGIT_COMMITTER_DATE\n> + * `GIT_AUTHOR_NAME`\n> + * `GIT_AUTHOR_EMAIL`\n> + * `GIT_AUTHOR_DATE`\n> + * `GIT_COMMITTER_NAME`\n> + * `GIT_COMMITTER_EMAIL`\n> + * `GIT_COMMITTER_DATE`\n\nOK.\n"},{"id":"510622","messageId":"xmqqbjw7vdrs.fsf@gitster.g","threadId":"62730","inReplyTo":"9216554bd7096f2543e987fc7fd20f5e64630187.1736972628.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 4/5] doc: convert git commit config to new format","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2025-01-15T23:49:27Z","receivedAt":"2025-01-15T23:49:30Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Jean-Noël Avila via GitGitGadget\" writes:\n\n> +ifdef::git-commit[]\n> +:see-git-commit:\n> +endif::git-commit[]\n> +ifndef::git-commit[]\n> +:see-git-commit: See linkgit:git-commit[1] for details.\n> +endif::git-commit[]\n> +`commit.cleanup`::\n> \tThis setting overrides the default of the `--cleanup` option in\n> -\t`git commit`. See linkgit:git-commit[1] for details. Changing the\n> -\tdefault can be useful when you always want to keep lines that begin\n> +\t`git commit`. {see-git-commit} Changing the default can be useful\n> +\twhen you always want to keep lines that begin\n\nOK.\n"},{"id":"510671","messageId":"Z4jcrX_tH0xfGKPh@pks.im","threadId":"62730","inReplyTo":"28316a709da913c624873291d96ed5aeddc6fc90.1736972628.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 5/5] doc: migrate git-commit manpage secondary files to new format","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2025-01-16T10:17:17Z","receivedAt":"2025-01-16T10:17:24Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"On Wed, Jan 15, 2025 at 08:23:48PM +0000, Jean-Noël Avila via GitGitGadget wrote:\n> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\nI would've liked to see a small description of what this does and also\nprovide a bit more context in the other commit messages instead of the\nbulleted lists you have. They don't give the reader much of a sense of\nthe context we're operating in and why we think that those changes are\ngood.\n\nOther than that the patch series looks fine to me. Thanks!\n\nPatrick\n"}]}