* [PATCH 0/3] Doc git commit
@ 2025-01-03 13:47 Jean-Noël Avila via GitGitGadget
2025-01-03 13:47 ` [PATCH 1/3] doc: git-commit: apply new documentation guidelines Jean-Noël Avila via GitGitGadget
` (3 more replies)
0 siblings, 4 replies; 15+ messages in thread
From: Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 UTC (permalink / raw)
To: git; +Cc: Jean-Noël Avila
This series continues the effort of rewriting the documentation with
uniformization and better formatting of the man pages. This time, git-commit
is processed, taking advantage of previous experiences.
Jean-Noël Avila (3):
doc: git-commit: apply new documentation guidelines
doc: git-commit.txt: convert git commit config to new format
doc: git-commit: migrate secondary files to new format
Documentation/config/commit.txt | 25 +--
Documentation/git-commit.txt | 276 +++++++++++++++----------------
Documentation/i18n.txt | 4 +-
Documentation/signoff-option.txt | 8 +-
builtin/commit.c | 2 +-
5 files changed, 159 insertions(+), 156 deletions(-)
base-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1845%2Fjnavila%2Fdoc_git-commit-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1845/jnavila/doc_git-commit-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1845
--
gitgitgadget
^ permalink raw reply [flat|nested] 15+ messages in thread* [PATCH 1/3] doc: git-commit: apply new documentation guidelines 2025-01-03 13:47 [PATCH 0/3] Doc git commit Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 ` Jean-Noël Avila via GitGitGadget 2025-01-06 7:38 ` Patrick Steinhardt 2025-01-03 13:47 ` [PATCH 2/3] doc: git-commit.txt: convert git commit config to new format Jean-Noël Avila via GitGitGadget ` (2 subsequent siblings) 3 siblings, 1 reply; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 UTC (permalink / raw) To: git; +Cc: Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> The documentation for git-commit has been updated to follow the new documentation guidelines. The following changes have been applied to the series of patches: - switching the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - use _<placeholder>_ instead of <placeholder> in the description - use `backticks for keywords and more complex option descriptions`. The new rendering engine will apply synopsis rules to these spans. Additionally, some option descriptions have been turned into imperative mood to make them more consistent with the rest of the documentation. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/git-commit.txt | 276 +++++++++++++++++------------------ builtin/commit.c | 2 +- 2 files changed, 138 insertions(+), 140 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index c822113c111..b08a398e31d 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -7,8 +7,8 @@ git-commit - Record changes to the repository SYNOPSIS -------- -[verse] -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] +[synopsis] +git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend] [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>] [-F <file> | -m <msg>] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>] @@ -23,31 +23,31 @@ Create a new commit containing the current contents of the index and the given log message describing the changes. The new commit is a direct child of HEAD, usually the tip of the current branch, and the branch is updated to point to it (unless no branch is associated with -the working tree, in which case HEAD is "detached" as described in +the working tree, in which case `HEAD` is "detached" as described in linkgit:git-checkout[1]). The content to be committed can be specified in several ways: 1. by using linkgit:git-add[1] to incrementally "add" changes to the - index before using the 'commit' command (Note: even modified files + index before using the `commit` command (Note: even modified files must be "added"); 2. by using linkgit:git-rm[1] to remove files from the working tree - and the index, again before using the 'commit' command; + and the index, again before using the `commit` command; -3. by listing files as arguments to the 'commit' command - (without --interactive or --patch switch), in which +3. by listing files as arguments to the `commit` command + (without `--interactive` or `--patch` switch), in which case the commit will ignore changes staged in the index, and instead record the current content of the listed files (which must already be known to Git); -4. by using the -a switch with the 'commit' command to automatically +4. by using the `-a` switch with the `commit` command to automatically "add" changes from all known files (i.e. all files that are already listed in the index) and to automatically "rm" files in the index that have been removed from the working tree, and then perform the actual commit; -5. by using the --interactive or --patch switches with the 'commit' command +5. by using the `--interactive` or `--patch` switches with the `commit` command to decide one by one which files or hunks should be part of the commit in addition to contents in the index, before finalizing the operation. See the ``Interactive Mode'' section of @@ -58,139 +58,139 @@ summary of what is included by any of the above for the next commit by giving the same set of parameters (options and paths). If you make a commit and then find a mistake immediately after -that, you can recover from it with 'git reset'. +that, you can recover from it with `git reset`. :git-commit: 1 OPTIONS ------- --a:: ---all:: - Tell the command to automatically stage files that have +`-a`:: +`--all`:: + Automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. --p:: ---patch:: +`-p`:: +`--patch`:: Use the interactive patch selection interface to choose which changes to commit. See linkgit:git-add[1] for details. --C <commit>:: ---reuse-message=<commit>:: - Take an existing commit object, and reuse the log message +`-C <commit>`:: +`--reuse-message=<commit>`:: + Take an existing _<commit>_ object, and reuse the log message and the authorship information (including the timestamp) when creating the commit. --c <commit>:: ---reedit-message=<commit>:: - Like '-C', but with `-c` the editor is invoked, so that +`-c <commit>`:: +`--reedit-message=<commit>`:: + Like `-C`, but with `-c` the editor is invoked, so that the user can further edit the commit message. ---fixup=[(amend|reword):]<commit>:: - Create a new commit which "fixes up" `<commit>` when applied with +`--fixup=[(amend|reword):]<commit>`:: + Create a new commit which "fixes up" _<commit>_ when applied with `git rebase --autosquash`. Plain `--fixup=<commit>` creates a - "fixup!" commit which changes the content of `<commit>` but leaves + "fixup!" commit which changes the content of _<commit>_ but leaves its log message untouched. `--fixup=amend:<commit>` is similar but creates an "amend!" commit which also replaces the log message of - `<commit>` with the log message of the "amend!" commit. + _<commit>_ with the log message of the "amend!" commit. `--fixup=reword:<commit>` creates an "amend!" commit which - replaces the log message of `<commit>` with its own log message - but makes no changes to the content of `<commit>`. + replaces the log message of _<commit>_ with its own log message + but makes no changes to the content of _<commit>_. + The commit created by plain `--fixup=<commit>` has a subject -composed of "fixup!" followed by the subject line from <commit>, +composed of "fixup!" followed by the subject line from _<commit>_, and is recognized specially by `git rebase --autosquash`. The `-m` option may be used to supplement the log message of the created commit, but the additional commentary will be thrown away once the -"fixup!" commit is squashed into `<commit>` by +"fixup!" commit is squashed into _<commit>_ by `git rebase --autosquash`. + The commit created by `--fixup=amend:<commit>` is similar but its subject is instead prefixed with "amend!". The log message of -<commit> is copied into the log message of the "amend!" commit and +_<commit>_ is copied into the log message of the "amend!" commit and opened in an editor so it can be refined. When `git rebase ---autosquash` squashes the "amend!" commit into `<commit>`, the -log message of `<commit>` is replaced by the refined log message +--autosquash` squashes the "amend!" commit into _<commit>_, the +log message of _<commit>_ is replaced by the refined log message from the "amend!" commit. It is an error for the "amend!" commit's log message to be empty unless `--allow-empty-message` is specified. + `--fixup=reword:<commit>` is shorthand for `--fixup=amend:<commit> ---only`. It creates an "amend!" commit with only a log message + --only`. It creates an "amend!" commit with only a log message (ignoring any changes staged in the index). When squashed by `git -rebase --autosquash`, it replaces the log message of `<commit>` +rebase --autosquash`, it replaces the log message of _<commit>_ without making any other changes. + Neither "fixup!" nor "amend!" commits change authorship of -`<commit>` when applied by `git rebase --autosquash`. +_<commit>_ when applied by `git rebase --autosquash`. See linkgit:git-rebase[1] for details. ---squash=<commit>:: - Construct a commit message for use with `rebase --autosquash`. +`--squash=<commit>`:: + Construct a commit message for use with `git rebase --autosquash`. The commit message subject line is taken from the specified commit with a prefix of "squash! ". Can be used with additional commit message options (`-m`/`-c`/`-C`/`-F`). See linkgit:git-rebase[1] for details. ---reset-author:: - When used with -C/-c/--amend options, or when committing after a +`--reset-author`:: + When used with `-C`/`-c`/`--amend` options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer. This also renews the author timestamp. ---short:: +`--short`:: When doing a dry-run, give the output in the short-format. See linkgit:git-status[1] for details. Implies `--dry-run`. ---branch:: +`--branch`:: Show the branch and tracking info even in short-format. ---porcelain:: +`--porcelain`:: When doing a dry-run, give the output in a porcelain-ready format. See linkgit:git-status[1] for details. Implies `--dry-run`. ---long:: +`--long`:: When doing a dry-run, give the output in the long-format. Implies `--dry-run`. --z:: ---null:: +`-z`:: +`--null`:: When showing `short` or `porcelain` status output, print the - filename verbatim and terminate the entries with NUL, instead of LF. + filename verbatim and terminate the entries with _NUL_, instead of _LF_. If no format is given, implies the `--porcelain` output format. Without the `-z` option, filenames with "unusual" characters are quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). --F <file>:: ---file=<file>:: - Take the commit message from the given file. Use '-' to +`-F <file>`:: +`--file=<file>`:: + Take the commit message from _<file>_. Use `-` to read the message from the standard input. ---author=<author>:: +`--author=<author>`:: Override the commit author. Specify an explicit author using the - standard `A U Thor <author@example.com>` format. Otherwise <author> + standard `A U Thor <author@example.com>` format. Otherwise _<author>_ is assumed to be a pattern and is used to search for an existing - commit by that author (i.e. rev-list --all -i --author=<author>); + commit by that author (i.e. `git rev-list --all -i --author=<author>`); the commit author is then copied from the first such commit found. ---date=<date>:: +`--date=<date>`:: Override the author date used in the commit. --m <msg>:: ---message=<msg>:: - Use the given <msg> as the commit message. +`-m <msg>`:: +`--message=<msg>`:: + Use _<msg>_ as the commit message. If multiple `-m` options are given, their values are concatenated as separate paragraphs. + The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. --t <file>:: ---template=<file>:: +`-t <file>`:: +`--template=<file>`:: When editing the commit message, start the editor with the - contents in the given file. The `commit.template` configuration + contents in _<file>_. The `commit.template` configuration variable is often used to give this option implicitly to the command. This mechanism can be used by projects that want to guide participants with some hints on what to write in the message @@ -200,56 +200,55 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. include::signoff-option.txt[] ---trailer <token>[(=|:)<value>]:: - Specify a (<token>, <value>) pair that should be applied as a +`--trailer <token>[(=|:)<value>]`:: + Specify a (_<token>_, _<value>_) pair that should be applied as a trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \ <committer@example.com>" --trailer "Helped-by:C O Mitter \ - <committer@example.com>"` will add the "Signed-off-by" trailer - and the "Helped-by" trailer to the commit message.) + <committer@example.com>"` will add the `Signed-off-by` trailer + and the `Helped-by` trailer to the commit message.) The `trailer.*` configuration variables (linkgit:git-interpret-trailers[1]) can be used to define if a duplicated trailer is omitted, where in the run of trailers each trailer would appear, and other details. --n:: ---[no-]verify:: - By default, the pre-commit and commit-msg hooks are run. - When any of `--no-verify` or `-n` is given, these are bypassed. +`-n`:: +`--[no-]verify`:: + Bypass the `pre-commit` and `commit-msg` hooks. See also linkgit:githooks[5]. ---allow-empty:: +`--allow-empty`:: Usually recording a commit that has the exact same tree as its sole parent commit is a mistake, and the command prevents you from making such a commit. This option bypasses the safety, and is primarily for use by foreign SCM interface scripts. ---allow-empty-message:: - Like --allow-empty this command is primarily for use by foreign +`--allow-empty-message`:: + Like `--allow-empty` this command is primarily for use by foreign SCM interface scripts. It allows you to create a commit with an empty commit message without using plumbing commands like linkgit:git-commit-tree[1]. ---cleanup=<mode>:: - This option determines how the supplied commit message should be +`--cleanup=<mode>`:: + Determine how the supplied commit message should be cleaned up before committing. The '<mode>' can be `strip`, `whitespace`, `verbatim`, `scissors` or `default`. + -- -strip:: +`strip`:: Strip leading and trailing empty lines, trailing whitespace, commentary and collapse consecutive empty lines. -whitespace:: +`whitespace`:: Same as `strip` except #commentary is not removed. -verbatim:: +`verbatim`:: Do not change the message at all. -scissors:: +`scissors`:: Same as `whitespace` except that everything from (and including) the line found below is truncated, if the message is to be edited. - "`#`" can be customized with core.commentChar. + "`#`" can be customized with `core.commentChar`. # ------------------------ >8 ------------------------ -default:: +`default`:: Same as `strip` if the message is to be edited. Otherwise `whitespace`. -- @@ -257,19 +256,18 @@ default:: The default can be changed by the `commit.cleanup` configuration variable (see linkgit:git-config[1]). --e:: ---edit:: - The message taken from file with `-F`, command line with - `-m`, and from commit object with `-C` are usually used as - the commit log message unmodified. This option lets you - further edit the message taken from these sources. +`-e`:: +`--edit`:: + Let the user further edit the message taken from file + with `-F`, command line with `-m`, and from commit object + with `-C` are usually used as the commit log message unmodified. ---no-edit:: +`--no-edit`:: Use the selected commit message without launching an editor. For example, `git commit --amend --no-edit` amends a commit without changing its commit message. ---amend:: +`--amend`:: Replace the tip of the current branch by creating a new commit. The recorded tree is prepared as usual (including the effect of the `-i` and `-o` options and explicit @@ -295,23 +293,23 @@ You should understand the implications of rewriting history if you amend a commit that has already been published. (See the "RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) ---no-post-rewrite:: - Bypass the post-rewrite hook. +`--no-post-rewrite`:: + Bypass the `post-rewrite` hook. --i:: ---include:: +`-i`:: +`--include`:: Before making a commit out of staged contents so far, stage the contents of paths given on the command line as well. This is usually not what you want unless you are concluding a conflicted merge. --o:: ---only:: +`-o`:: +`--only`:: Make a commit by taking the updated working tree contents of the paths specified on the command line, disregarding any contents that have been staged for other paths. This is the default mode of operation of - 'git commit' if any paths are given on the command line, + `git commit` if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with `--amend`, then no paths need to be specified, which can be used to amend @@ -319,48 +317,48 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) already been staged. If used together with `--allow-empty` paths are also not required, and an empty commit will be created. ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` then standard input is used. Pathspec + elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). See also `--pathspec-file-nul` and global `--literal-pathspecs`. ---pathspec-file-nul:: +`--pathspec-file-nul`:: Only meaningful with `--pathspec-from-file`. Pathspec elements are - separated with NUL character and all other characters are taken + separated with _NUL_ character and all other characters are taken literally (including newlines and quotes). --u[<mode>]:: ---untracked-files[=<mode>]:: +`-u[<mode>]`:: +`--untracked-files[=<mode>]`:: Show untracked files. + -- -The mode parameter is optional (defaults to 'all'), and is used to -specify the handling of untracked files; when -u is not used, the -default is 'normal', i.e. show untracked files and directories. +The _<mode>_ parameter is optional (defaults to `all`), and is used to +specify the handling of untracked files; when `-u` is not used, the +default is `normal`, i.e. show untracked files and directories. The possible options are: - - 'no' - Show no untracked files - - 'normal' - Shows untracked files and directories - - 'all' - Also shows individual files in untracked directories. +`no`:: Show no untracked files +`normal`:: Shows untracked files and directories +`all`:: Also shows individual files in untracked directories. All usual spellings for Boolean value `true` are taken as `normal` and `false` as `no`. -The default can be changed using the status.showUntrackedFiles +The default can be changed using the `status.showUntrackedFiles` configuration variable documented in linkgit:git-config[1]. -- --v:: ---verbose:: - Show unified diff between the HEAD commit and what +`-v`:: +`--verbose`:: + Show unified diff between the `HEAD` commit and what would be committed at the bottom of the commit message template to help the user describe the commit by reminding what changes the commit has. Note that this diff output doesn't have its - lines prefixed with '#'. This diff will not be a part + lines prefixed with `#`. This diff will not be a part of the commit message. See the `commit.verbose` configuration variable in linkgit:git-config[1]. + @@ -368,40 +366,40 @@ If specified twice, show in addition the unified diff between what would be committed and the worktree files, i.e. the unstaged changes to tracked files. --q:: ---quiet:: +`-q`:: +`--quiet`:: Suppress commit summary message. ---dry-run:: +`--dry-run`:: Do not create a commit, but show a list of paths that are to be committed, paths with local changes that will be left uncommitted and paths that are untracked. ---status:: +`--status`:: Include the output of linkgit:git-status[1] in the commit message template when using an editor to prepare the commit message. Defaults to on, but can be used to override - configuration variable commit.status. + configuration variable `commit.status`. ---no-status:: +`--no-status`:: Do not include the output of linkgit:git-status[1] in the commit message template when using an editor to prepare the default commit message. --S[<keyid>]:: ---gpg-sign[=<keyid>]:: ---no-gpg-sign:: - GPG-sign commits. The `keyid` argument is optional and +`-S[<key-id>]`:: +`--gpg-sign[=<key-id>]`:: +`--no-gpg-sign`:: + GPG-sign commits. The _<key-id>_ is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. `--no-gpg-sign` is useful to countermand both `commit.gpgSign` configuration variable, and earlier `--gpg-sign`. -\--:: +`--`:: Do not interpret any more arguments as options. -<pathspec>...:: - When pathspec is given on the command line, commit the contents of +`<pathspec>...`:: + When _<pathspec>_ is given on the command line, commit the contents of the files that match the pathspec without recording the changes already added to the index. The contents of these files are also staged for the next commit on top of what have been staged before. @@ -412,10 +410,10 @@ EXAMPLES -------- When recording your own work, the contents of modified files in your working tree are temporarily stored to a staging area -called the "index" with 'git add'. A file can be +called the "index" with `git add`. A file can be reverted back, only in the index but not in the working tree, to that of the last commit with `git restore --staged <file>`, -which effectively reverts 'git add' and prevents the changes to +which effectively reverts `git add` and prevents the changes to this file from participating in the next commit. After building the state to be committed incrementally with these commands, `git commit` (without any pathname parameter) is used to record what @@ -443,7 +441,7 @@ $ git commit -a ------------ The command `git commit -a` first looks at your working tree, -notices that you have modified hello.c and removed goodbye.c, +notices that you have modified `hello.c` and removed `goodbye.c`, and performs necessary `git add` and `git rm` for you. After staging changes to many files, you can alter the order the @@ -471,13 +469,13 @@ $ git commit this second commit would record the changes to `hello.c` and `hello.h` as expected. -After a merge (initiated by 'git merge' or 'git pull') stops +After a merge (initiated by `git merge` or `git pull`) stops because of conflicts, cleanly merged paths are already staged to be committed for you, and paths that conflicted are left in unmerged state. You would have to first -check which paths are conflicting with 'git status' +check which paths are conflicting with `git status` and after fixing them manually in your working tree, you would -stage the result as usual with 'git add': +stage the result as usual with `git add`: ------------ $ git status | grep unmerged @@ -507,12 +505,12 @@ COMMIT INFORMATION Author and committer information is taken from the following environment variables, if set: - GIT_AUTHOR_NAME - GIT_AUTHOR_EMAIL - GIT_AUTHOR_DATE - GIT_COMMITTER_NAME - GIT_COMMITTER_EMAIL - GIT_COMMITTER_DATE + * `GIT_AUTHOR_NAME` + * `GIT_AUTHOR_EMAIL` + * `GIT_AUTHOR_DATE` + * `GIT_COMMITTER_NAME` + * `GIT_COMMITTER_EMAIL` + * `GIT_COMMITTER_DATE` (nb "<", ">" and "\n"s are stripped) @@ -524,7 +522,7 @@ that, see the `credential.username` variable in linkgit:git-config[1]. In case (some of) these environment variables are not set, the information is taken from the configuration items `user.name` and `user.email`, or, if not -present, the environment variable EMAIL, or, if that is not set, +present, the environment variable `EMAIL`, or, if that is not set, system user name and the hostname used for outgoing mail (taken from `/etc/mailname` and falling back to the fully qualified hostname when that file does not exist). @@ -555,7 +553,7 @@ include::i18n.txt[] ENVIRONMENT AND CONFIGURATION VARIABLES --------------------------------------- The editor used to edit the commit log message will be chosen from the -`GIT_EDITOR` environment variable, the core.editor configuration variable, the +`GIT_EDITOR` environment variable, the `core.editor` configuration variable, the `VISUAL` environment variable, or the `EDITOR` environment variable (in that order). See linkgit:git-var[1] for details. diff --git a/builtin/commit.c b/builtin/commit.c index ef5e622c077..a7315ed67cc 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -44,7 +44,7 @@ #include "trailer.h" static const char * const builtin_commit_usage[] = { - N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n" + N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n" " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n" " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n" " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n" -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH 1/3] doc: git-commit: apply new documentation guidelines 2025-01-03 13:47 ` [PATCH 1/3] doc: git-commit: apply new documentation guidelines Jean-Noël Avila via GitGitGadget @ 2025-01-06 7:38 ` Patrick Steinhardt 2025-01-07 21:14 ` Jean-Noël AVILA 0 siblings, 1 reply; 15+ messages in thread From: Patrick Steinhardt @ 2025-01-06 7:38 UTC (permalink / raw) To: Jean-Noël Avila via GitGitGadget; +Cc: git, Jean-Noël Avila On Fri, Jan 03, 2025 at 01:47:24PM +0000, Jean-Noël Avila via GitGitGadget wrote: > From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> > > The documentation for git-commit has been updated to follow the new > documentation guidelines. The following changes have been applied to > the series of patches: > > - switching the synopsis to a synopsis block which will automatically > format placeholders in italics and keywords in monospace > - use _<placeholder>_ instead of <placeholder> in the description > - use `backticks for keywords and more complex option > descriptions`. The new rendering engine will apply synopsis rules to > these spans. > > Additionally, some option descriptions have been turned into > imperative mood to make them more consistent with the rest of the > documentation. Same comment here regarding the commit message as on the other two series. We should use imperative mood for it, as well :) > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt > index c822113c111..b08a398e31d 100644 > --- a/Documentation/git-commit.txt > +++ b/Documentation/git-commit.txt > @@ -58,139 +58,139 @@ summary of what is included by any of the above for the next > --z:: > ---null:: > +`-z`:: > +`--null`:: > When showing `short` or `porcelain` status output, print the > - filename verbatim and terminate the entries with NUL, instead of LF. > + filename verbatim and terminate the entries with _NUL_, instead of _LF_. > If no format is given, implies the `--porcelain` output format. > Without the `-z` option, filenames with "unusual" characters are > quoted as explained for the configuration variable `core.quotePath` > (see linkgit:git-config[1]). > > --F <file>:: > ---file=<file>:: > - Take the commit message from the given file. Use '-' to > +`-F <file>`:: > +`--file=<file>`:: > + Take the commit message from _<file>_. Use `-` to I think it would make sense to move changes like this, where the actual wording changes, into a separate commit. That'd make it way easier to spot the non-mechanical changes from those that may require some discussion. > @@ -257,19 +256,18 @@ default:: > The default can be changed by the `commit.cleanup` configuration > variable (see linkgit:git-config[1]). > > --e:: > ---edit:: > - The message taken from file with `-F`, command line with > - `-m`, and from commit object with `-C` are usually used as > - the commit log message unmodified. This option lets you > - further edit the message taken from these sources. > +`-e`:: > +`--edit`:: > + Let the user further edit the message taken from file There's a double space here. I was also wondering whether this should say _<file>_ here to further clarify that this refers to the same placeholder as the placeholder in `-F`. Might be confusing though, I dunno. > diff --git a/builtin/commit.c b/builtin/commit.c > index ef5e622c077..a7315ed67cc 100644 > --- a/builtin/commit.c > +++ b/builtin/commit.c > @@ -44,7 +44,7 @@ > #include "trailer.h" > > static const char * const builtin_commit_usage[] = { > - N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n" > + N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n" > " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n" > " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n" > " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n" I guess this change is required to make t0450 happy? Patrick ^ permalink raw reply [flat|nested] 15+ messages in thread
* Re: [PATCH 1/3] doc: git-commit: apply new documentation guidelines 2025-01-06 7:38 ` Patrick Steinhardt @ 2025-01-07 21:14 ` Jean-Noël AVILA 0 siblings, 0 replies; 15+ messages in thread From: Jean-Noël AVILA @ 2025-01-07 21:14 UTC (permalink / raw) To: Jean-Noël Avila via GitGitGadget, Patrick Steinhardt; +Cc: git Le lundi 6 janvier 2025, 08:38:19 CET Patrick Steinhardt a écrit : > On Fri, Jan 03, 2025 at 01:47:24PM +0000, Jean-Noël Avila via GitGitGadget wrote: > > From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> > > > > The documentation for git-commit has been updated to follow the new > > documentation guidelines. The following changes have been applied to > > the series of patches: > > > > - switching the synopsis to a synopsis block which will automatically > > format placeholders in italics and keywords in monospace > > - use _<placeholder>_ instead of <placeholder> in the description > > - use `backticks for keywords and more complex option > > descriptions`. The new rendering engine will apply synopsis rules to > > these spans. > > > > Additionally, some option descriptions have been turned into > > imperative mood to make them more consistent with the rest of the > > documentation. > > Same comment here regarding the commit message as on the other two > series. We should use imperative mood for it, as well :) Thanks for reviewing. Being consistent with myself is imperative ;-) > > > diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt > > index c822113c111..b08a398e31d 100644 > > --- a/Documentation/git-commit.txt > > +++ b/Documentation/git-commit.txt > > @@ -58,139 +58,139 @@ summary of what is included by any of the above for the next > > --z:: > > ---null:: > > +`-z`:: > > +`--null`:: > > When showing `short` or `porcelain` status output, print the > > - filename verbatim and terminate the entries with NUL, instead of LF. > > + filename verbatim and terminate the entries with _NUL_, instead of _LF_. > > If no format is given, implies the `--porcelain` output format. > > Without the `-z` option, filenames with "unusual" characters are > > quoted as explained for the configuration variable `core.quotePath` > > (see linkgit:git-config[1]). > > > > --F <file>:: > > ---file=<file>:: > > - Take the commit message from the given file. Use '-' to > > +`-F <file>`:: > > +`--file=<file>`:: > > + Take the commit message from _<file>_. Use `-` to > > I think it would make sense to move changes like this, where the actual > wording changes, into a separate commit. That'd make it way easier to > spot the non-mechanical changes from those that may require some > discussion. True. There are other parts where I introduced the place holder as an echo to the option description. The idea is to be less verbose and more contextual. > > > @@ -257,19 +256,18 @@ default:: > > The default can be changed by the `commit.cleanup` configuration > > variable (see linkgit:git-config[1]). > > > > --e:: > > ---edit:: > > - The message taken from file with `-F`, command line with > > - `-m`, and from commit object with `-C` are usually used as > > - the commit log message unmodified. This option lets you > > - further edit the message taken from these sources. > > +`-e`:: > > +`--edit`:: > > + Let the user further edit the message taken from file > > There's a double space here. I was also wondering whether this should > say _<file>_ here to further clarify that this refers to the same > placeholder as the placeholder in `-F`. Might be confusing though, I > dunno. This would sound a bit repetitive, but it is still better than making the reader refer to the entries for each option, in which case I would also add the placeholders when listing the options. > > > diff --git a/builtin/commit.c b/builtin/commit.c > > index ef5e622c077..a7315ed67cc 100644 > > --- a/builtin/commit.c > > +++ b/builtin/commit.c > > @@ -44,7 +44,7 @@ > > #include "trailer.h" > > > > static const char * const builtin_commit_usage[] = { > > - N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n" > > + N_("git commit [-a | --interactive | --patch] [-s] [-v] [- u[<mode>]] [--amend]\n" > > " [--dry-run] [(-c | -C | --squash) <commit> | -- fixup [(amend|reword):]<commit>]\n" > > " [-F <file> | -m <msg>] [--reset-author] [--allow- empty]\n" > > " [--allow-empty-message] [--no-verify] [-e] [-- author=<author>]\n" > > I guess this change is required to make t0450 happy? Yes it is. To be honest, I was about to try to complete the synopsis for all commands, but finally let this task for another round, because I'm not even clear on what is alternative and what can be combined. > > Patrick > > ^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH 2/3] doc: git-commit.txt: convert git commit config to new format 2025-01-03 13:47 [PATCH 0/3] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 1/3] doc: git-commit: apply new documentation guidelines Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 ` Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 3/3] doc: git-commit: migrate secondary files " Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget 3 siblings, 0 replies; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 UTC (permalink / raw) To: git; +Cc: Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> Also prevent git-commit manpage to refer to itself in the config description by using a variable. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/config/commit.txt | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index 62f0d92fda5..d3f4624fd27 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt @@ -1,29 +1,34 @@ -commit.cleanup:: +ifdef::git-commit[] +:see-git-commit: +endif::git-commit[] +ifndef::git-commit[] +:see-git-commit: See linkgit:git-commit[1] for details. +endif::git-commit[] +`commit.cleanup`:: This setting overrides the default of the `--cleanup` option in - `git commit`. See linkgit:git-commit[1] for details. Changing the - default can be useful when you always want to keep lines that begin + `git commit`. {see-git-commit} Changing the default can be useful + when you always want to keep lines that begin with the comment character `#` in your log message, in which case you would do `git config commit.cleanup whitespace` (note that you will have to remove the help lines that begin with `#` in the commit log template yourself, if you do this). -commit.gpgSign:: - +`commit.gpgSign`:: A boolean to specify whether all commits should be GPG signed. Use of this option when doing operations such as rebase can result in a large number of commits being signed. It may be convenient to use an agent to avoid typing your GPG passphrase several times. -commit.status:: +`commit.status`:: A boolean to enable/disable inclusion of status information in the commit message template when using an editor to prepare the commit - message. Defaults to true. + message. Defaults to `true`. -commit.template:: +`commit.template`:: Specify the pathname of a file to use as the template for new commit messages. -commit.verbose:: +`commit.verbose`:: A boolean or int to specify the level of verbosity with `git commit`. - See linkgit:git-commit[1]. + {see-git-commit} -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH 3/3] doc: git-commit: migrate secondary files to new format 2025-01-03 13:47 [PATCH 0/3] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 1/3] doc: git-commit: apply new documentation guidelines Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 2/3] doc: git-commit.txt: convert git commit config to new format Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 ` Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget 3 siblings, 0 replies; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-03 13:47 UTC (permalink / raw) To: git; +Cc: Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/i18n.txt | 4 ++-- Documentation/signoff-option.txt | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index 3a866af4a42..baff780a7e3 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git does not forbid it. However, there are a few things to keep in mind. -. 'git commit' and 'git commit-tree' issue +. `git commit` and `git commit-tree` issue a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to @@ -50,7 +50,7 @@ of `i18n.commitEncoding` in their `encoding` header. This is to help other people who look at them later. Lack of this header implies that the commit log message is encoded in UTF-8. -. 'git log', 'git show', 'git blame' and friends look at the +. `git log`, `git show`, `git blame` and friends look at the `encoding` header of a commit object, and try to re-code the log message into UTF-8 unless otherwise specified. You can specify the desired output encoding with diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt index d98758f3cb7..cddfb225d1d 100644 --- a/Documentation/signoff-option.txt +++ b/Documentation/signoff-option.txt @@ -1,8 +1,8 @@ ifdef::git-commit[] --s:: +`-s`:: endif::git-commit[] ---signoff:: ---no-signoff:: +`--signoff`:: +`--no-signoff`:: Add a `Signed-off-by` trailer by the committer at the end of the commit log message. The meaning of a signoff depends on the project to which you're committing. For example, it may certify that @@ -14,5 +14,5 @@ endif::git-commit[] leadership of the project to which you're contributing to understand how the signoffs are used in that project. + -The --no-signoff option can be used to countermand an earlier --signoff +The `--no-signoff` option can be used to countermand an earlier `--signoff` option on the command line. -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 0/5] Doc git commit 2025-01-03 13:47 [PATCH 0/3] Doc git commit Jean-Noël Avila via GitGitGadget ` (2 preceding siblings ...) 2025-01-03 13:47 ` [PATCH 3/3] doc: git-commit: migrate secondary files " Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 1/5] doc: apply new documentation guidelines to " Jean-Noël Avila via GitGitGadget ` (4 more replies) 3 siblings, 5 replies; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila This series continues the effort of rewriting the documentation with uniformization and better formatting of the man pages. This time, git-commit is processed, taking advantage of previous experiences. Jean-Noël Avila (5): doc: apply new documentation guidelines to git commit doc: the mode param of -u of git commit is optional doc: make more direct explanations in git commit options doc: convert git commit config to new format doc: migrate git-commit manpage secondary files to new format Documentation/config/commit.txt | 25 +-- Documentation/git-commit.txt | 281 +++++++++++++++---------------- Documentation/i18n.txt | 4 +- Documentation/signoff-option.txt | 8 +- builtin/commit.c | 2 +- 5 files changed, 161 insertions(+), 159 deletions(-) base-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1845%2Fjnavila%2Fdoc_git-commit-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1845/jnavila/doc_git-commit-v2 Pull-Request: https://github.com/gitgitgadget/git/pull/1845 Range-diff vs v1: 1: dfd907fc314 ! 1: 91cff84b5f8 doc: git-commit: apply new documentation guidelines @@ Metadata Author: Jean-Noël Avila <jn.avila@free.fr> ## Commit message ## - doc: git-commit: apply new documentation guidelines + doc: apply new documentation guidelines to git commit - The documentation for git-commit has been updated to follow the new - documentation guidelines. The following changes have been applied to - the series of patches: - - - switching the synopsis to a synopsis block which will automatically + - switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - use _<placeholder>_ instead of <placeholder> in the description - use `backticks for keywords and more complex option descriptions`. The new rendering engine will apply synopsis rules to these spans. - Additionally, some option descriptions have been turned into - imperative mood to make them more consistent with the rest of the - documentation. - Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> ## Documentation/git-commit.txt ## @@ Documentation/git-commit.txt: git-commit - Record changes to the repository -[verse] -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] +[synopsis] -+git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend] ++git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>] [-F <file> | -m <msg>] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>] @@ Documentation/git-commit.txt: summary of what is included by any of the above fo ------- --a:: ---all:: -- Tell the command to automatically stage files that have +`-a`:: +`--all`:: -+ Automatically stage files that have + Tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. @@ Documentation/git-commit.txt: summary of what is included by any of the above fo --F <file>:: ---file=<file>:: -- Take the commit message from the given file. Use '-' to +`-F <file>`:: +`--file=<file>`:: -+ Take the commit message from _<file>_. Use `-` to + Take the commit message from the given file. Use '-' to read the message from the standard input. ---author=<author>:: @@ Documentation/git-commit.txt: summary of what is included by any of the above fo --m <msg>:: ---message=<msg>:: -- Use the given <msg> as the commit message. +`-m <msg>`:: +`--message=<msg>`:: -+ Use _<msg>_ as the commit message. + Use the given <msg> as the commit message. If multiple `-m` options are given, their values are concatenated as separate paragraphs. + @@ Documentation/git-commit.txt: summary of what is included by any of the above fo +`-t <file>`:: +`--template=<file>`:: When editing the commit message, start the editor with the -- contents in the given file. The `commit.template` configuration -+ contents in _<file>_. The `commit.template` configuration + contents in the given file. The `commit.template` configuration variable is often used to give this option implicitly to the - command. This mechanism can be used by projects that want to - guide participants with some hints on what to write in the message @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. include::signoff-option.txt[] @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, ` --n:: ---[no-]verify:: -- By default, the pre-commit and commit-msg hooks are run. -- When any of `--no-verify` or `-n` is given, these are bypassed. +`-n`:: +`--[no-]verify`:: -+ Bypass the `pre-commit` and `commit-msg` hooks. + By default, the pre-commit and commit-msg hooks are run. + When any of `--no-verify` or `-n` is given, these are bypassed. See also linkgit:githooks[5]. ---allow-empty:: @@ Documentation/git-commit.txt: The `-m` option is mutually exclusive with `-c`, ` linkgit:git-commit-tree[1]. ---cleanup=<mode>:: -- This option determines how the supplied commit message should be +`--cleanup=<mode>`:: -+ Determine how the supplied commit message should be + This option determines how the supplied commit message should be cleaned up before committing. The '<mode>' can be `strip`, `whitespace`, `verbatim`, `scissors` or `default`. + @@ Documentation/git-commit.txt: default:: --e:: ---edit:: -- The message taken from file with `-F`, command line with -- `-m`, and from commit object with `-C` are usually used as -- the commit log message unmodified. This option lets you -- further edit the message taken from these sources. +`-e`:: +`--edit`:: -+ Let the user further edit the message taken from file -+ with `-F`, command line with `-m`, and from commit object -+ with `-C` are usually used as the commit log message unmodified. + The message taken from file with `-F`, command line with + `-m`, and from commit object with `-C` are usually used as + the commit log message unmodified. This option lets you + further edit the message taken from these sources. ---no-edit:: +`--no-edit`:: @@ Documentation/git-commit.txt: include::i18n.txt[] `VISUAL` environment variable, or the `EDITOR` environment variable (in that order). See linkgit:git-var[1] for details. - - ## builtin/commit.c ## -@@ - #include "trailer.h" - - static const char * const builtin_commit_usage[] = { -- N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n" -+ N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n" - " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n" - " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n" - " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n" -: ----------- > 2: d58526a9b39 doc: the mode param of -u of git commit is optional -: ----------- > 3: 39db87ff906 doc: make more direct explanations in git commit options 2: 9f518ec8f9d ! 4: 9216554bd70 doc: git-commit.txt: convert git commit config to new format @@ Metadata Author: Jean-Noël Avila <jn.avila@free.fr> ## Commit message ## - doc: git-commit.txt: convert git commit config to new format + doc: convert git commit config to new format Also prevent git-commit manpage to refer to itself in the config description by using a variable. 3: 9f8d4e74b7b ! 5: 28316a709da doc: git-commit: migrate secondary files to new format @@ Metadata Author: Jean-Noël Avila <jn.avila@free.fr> ## Commit message ## - doc: git-commit: migrate secondary files to new format + doc: migrate git-commit manpage secondary files to new format Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> -- gitgitgadget ^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v2 1/5] doc: apply new documentation guidelines to git commit 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-15 23:46 ` Junio C Hamano 2025-01-15 20:23 ` [PATCH v2 2/5] doc: the mode param of -u of git commit is optional Jean-Noël Avila via GitGitGadget ` (3 subsequent siblings) 4 siblings, 1 reply; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> - switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - use _<placeholder>_ instead of <placeholder> in the description - use `backticks for keywords and more complex option descriptions`. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/git-commit.txt | 256 +++++++++++++++++------------------ 1 file changed, 128 insertions(+), 128 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index c822113c111..e37c4a4987e 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -7,8 +7,8 @@ git-commit - Record changes to the repository SYNOPSIS -------- -[verse] -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] +[synopsis] +git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>] [-F <file> | -m <msg>] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>] @@ -23,31 +23,31 @@ Create a new commit containing the current contents of the index and the given log message describing the changes. The new commit is a direct child of HEAD, usually the tip of the current branch, and the branch is updated to point to it (unless no branch is associated with -the working tree, in which case HEAD is "detached" as described in +the working tree, in which case `HEAD` is "detached" as described in linkgit:git-checkout[1]). The content to be committed can be specified in several ways: 1. by using linkgit:git-add[1] to incrementally "add" changes to the - index before using the 'commit' command (Note: even modified files + index before using the `commit` command (Note: even modified files must be "added"); 2. by using linkgit:git-rm[1] to remove files from the working tree - and the index, again before using the 'commit' command; + and the index, again before using the `commit` command; -3. by listing files as arguments to the 'commit' command - (without --interactive or --patch switch), in which +3. by listing files as arguments to the `commit` command + (without `--interactive` or `--patch` switch), in which case the commit will ignore changes staged in the index, and instead record the current content of the listed files (which must already be known to Git); -4. by using the -a switch with the 'commit' command to automatically +4. by using the `-a` switch with the `commit` command to automatically "add" changes from all known files (i.e. all files that are already listed in the index) and to automatically "rm" files in the index that have been removed from the working tree, and then perform the actual commit; -5. by using the --interactive or --patch switches with the 'commit' command +5. by using the `--interactive` or `--patch` switches with the `commit` command to decide one by one which files or hunks should be part of the commit in addition to contents in the index, before finalizing the operation. See the ``Interactive Mode'' section of @@ -58,137 +58,137 @@ summary of what is included by any of the above for the next commit by giving the same set of parameters (options and paths). If you make a commit and then find a mistake immediately after -that, you can recover from it with 'git reset'. +that, you can recover from it with `git reset`. :git-commit: 1 OPTIONS ------- --a:: ---all:: +`-a`:: +`--all`:: Tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. --p:: ---patch:: +`-p`:: +`--patch`:: Use the interactive patch selection interface to choose which changes to commit. See linkgit:git-add[1] for details. --C <commit>:: ---reuse-message=<commit>:: - Take an existing commit object, and reuse the log message +`-C <commit>`:: +`--reuse-message=<commit>`:: + Take an existing _<commit>_ object, and reuse the log message and the authorship information (including the timestamp) when creating the commit. --c <commit>:: ---reedit-message=<commit>:: - Like '-C', but with `-c` the editor is invoked, so that +`-c <commit>`:: +`--reedit-message=<commit>`:: + Like `-C`, but with `-c` the editor is invoked, so that the user can further edit the commit message. ---fixup=[(amend|reword):]<commit>:: - Create a new commit which "fixes up" `<commit>` when applied with +`--fixup=[(amend|reword):]<commit>`:: + Create a new commit which "fixes up" _<commit>_ when applied with `git rebase --autosquash`. Plain `--fixup=<commit>` creates a - "fixup!" commit which changes the content of `<commit>` but leaves + "fixup!" commit which changes the content of _<commit>_ but leaves its log message untouched. `--fixup=amend:<commit>` is similar but creates an "amend!" commit which also replaces the log message of - `<commit>` with the log message of the "amend!" commit. + _<commit>_ with the log message of the "amend!" commit. `--fixup=reword:<commit>` creates an "amend!" commit which - replaces the log message of `<commit>` with its own log message - but makes no changes to the content of `<commit>`. + replaces the log message of _<commit>_ with its own log message + but makes no changes to the content of _<commit>_. + The commit created by plain `--fixup=<commit>` has a subject -composed of "fixup!" followed by the subject line from <commit>, +composed of "fixup!" followed by the subject line from _<commit>_, and is recognized specially by `git rebase --autosquash`. The `-m` option may be used to supplement the log message of the created commit, but the additional commentary will be thrown away once the -"fixup!" commit is squashed into `<commit>` by +"fixup!" commit is squashed into _<commit>_ by `git rebase --autosquash`. + The commit created by `--fixup=amend:<commit>` is similar but its subject is instead prefixed with "amend!". The log message of -<commit> is copied into the log message of the "amend!" commit and +_<commit>_ is copied into the log message of the "amend!" commit and opened in an editor so it can be refined. When `git rebase ---autosquash` squashes the "amend!" commit into `<commit>`, the -log message of `<commit>` is replaced by the refined log message +--autosquash` squashes the "amend!" commit into _<commit>_, the +log message of _<commit>_ is replaced by the refined log message from the "amend!" commit. It is an error for the "amend!" commit's log message to be empty unless `--allow-empty-message` is specified. + `--fixup=reword:<commit>` is shorthand for `--fixup=amend:<commit> ---only`. It creates an "amend!" commit with only a log message + --only`. It creates an "amend!" commit with only a log message (ignoring any changes staged in the index). When squashed by `git -rebase --autosquash`, it replaces the log message of `<commit>` +rebase --autosquash`, it replaces the log message of _<commit>_ without making any other changes. + Neither "fixup!" nor "amend!" commits change authorship of -`<commit>` when applied by `git rebase --autosquash`. +_<commit>_ when applied by `git rebase --autosquash`. See linkgit:git-rebase[1] for details. ---squash=<commit>:: - Construct a commit message for use with `rebase --autosquash`. +`--squash=<commit>`:: + Construct a commit message for use with `git rebase --autosquash`. The commit message subject line is taken from the specified commit with a prefix of "squash! ". Can be used with additional commit message options (`-m`/`-c`/`-C`/`-F`). See linkgit:git-rebase[1] for details. ---reset-author:: - When used with -C/-c/--amend options, or when committing after a +`--reset-author`:: + When used with `-C`/`-c`/`--amend` options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer. This also renews the author timestamp. ---short:: +`--short`:: When doing a dry-run, give the output in the short-format. See linkgit:git-status[1] for details. Implies `--dry-run`. ---branch:: +`--branch`:: Show the branch and tracking info even in short-format. ---porcelain:: +`--porcelain`:: When doing a dry-run, give the output in a porcelain-ready format. See linkgit:git-status[1] for details. Implies `--dry-run`. ---long:: +`--long`:: When doing a dry-run, give the output in the long-format. Implies `--dry-run`. --z:: ---null:: +`-z`:: +`--null`:: When showing `short` or `porcelain` status output, print the - filename verbatim and terminate the entries with NUL, instead of LF. + filename verbatim and terminate the entries with _NUL_, instead of _LF_. If no format is given, implies the `--porcelain` output format. Without the `-z` option, filenames with "unusual" characters are quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). --F <file>:: ---file=<file>:: +`-F <file>`:: +`--file=<file>`:: Take the commit message from the given file. Use '-' to read the message from the standard input. ---author=<author>:: +`--author=<author>`:: Override the commit author. Specify an explicit author using the - standard `A U Thor <author@example.com>` format. Otherwise <author> + standard `A U Thor <author@example.com>` format. Otherwise _<author>_ is assumed to be a pattern and is used to search for an existing - commit by that author (i.e. rev-list --all -i --author=<author>); + commit by that author (i.e. `git rev-list --all -i --author=<author>`); the commit author is then copied from the first such commit found. ---date=<date>:: +`--date=<date>`:: Override the author date used in the commit. --m <msg>:: ---message=<msg>:: +`-m <msg>`:: +`--message=<msg>`:: Use the given <msg> as the commit message. If multiple `-m` options are given, their values are concatenated as separate paragraphs. + The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. --t <file>:: ---template=<file>:: +`-t <file>`:: +`--template=<file>`:: When editing the commit message, start the editor with the contents in the given file. The `commit.template` configuration variable is often used to give this option implicitly to the @@ -200,56 +200,56 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. include::signoff-option.txt[] ---trailer <token>[(=|:)<value>]:: - Specify a (<token>, <value>) pair that should be applied as a +`--trailer <token>[(=|:)<value>]`:: + Specify a (_<token>_, _<value>_) pair that should be applied as a trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \ <committer@example.com>" --trailer "Helped-by:C O Mitter \ - <committer@example.com>"` will add the "Signed-off-by" trailer - and the "Helped-by" trailer to the commit message.) + <committer@example.com>"` will add the `Signed-off-by` trailer + and the `Helped-by` trailer to the commit message.) The `trailer.*` configuration variables (linkgit:git-interpret-trailers[1]) can be used to define if a duplicated trailer is omitted, where in the run of trailers each trailer would appear, and other details. --n:: ---[no-]verify:: +`-n`:: +`--[no-]verify`:: By default, the pre-commit and commit-msg hooks are run. When any of `--no-verify` or `-n` is given, these are bypassed. See also linkgit:githooks[5]. ---allow-empty:: +`--allow-empty`:: Usually recording a commit that has the exact same tree as its sole parent commit is a mistake, and the command prevents you from making such a commit. This option bypasses the safety, and is primarily for use by foreign SCM interface scripts. ---allow-empty-message:: - Like --allow-empty this command is primarily for use by foreign +`--allow-empty-message`:: + Like `--allow-empty` this command is primarily for use by foreign SCM interface scripts. It allows you to create a commit with an empty commit message without using plumbing commands like linkgit:git-commit-tree[1]. ---cleanup=<mode>:: +`--cleanup=<mode>`:: This option determines how the supplied commit message should be cleaned up before committing. The '<mode>' can be `strip`, `whitespace`, `verbatim`, `scissors` or `default`. + -- -strip:: +`strip`:: Strip leading and trailing empty lines, trailing whitespace, commentary and collapse consecutive empty lines. -whitespace:: +`whitespace`:: Same as `strip` except #commentary is not removed. -verbatim:: +`verbatim`:: Do not change the message at all. -scissors:: +`scissors`:: Same as `whitespace` except that everything from (and including) the line found below is truncated, if the message is to be edited. - "`#`" can be customized with core.commentChar. + "`#`" can be customized with `core.commentChar`. # ------------------------ >8 ------------------------ -default:: +`default`:: Same as `strip` if the message is to be edited. Otherwise `whitespace`. -- @@ -257,19 +257,19 @@ default:: The default can be changed by the `commit.cleanup` configuration variable (see linkgit:git-config[1]). --e:: ---edit:: +`-e`:: +`--edit`:: The message taken from file with `-F`, command line with `-m`, and from commit object with `-C` are usually used as the commit log message unmodified. This option lets you further edit the message taken from these sources. ---no-edit:: +`--no-edit`:: Use the selected commit message without launching an editor. For example, `git commit --amend --no-edit` amends a commit without changing its commit message. ---amend:: +`--amend`:: Replace the tip of the current branch by creating a new commit. The recorded tree is prepared as usual (including the effect of the `-i` and `-o` options and explicit @@ -295,23 +295,23 @@ You should understand the implications of rewriting history if you amend a commit that has already been published. (See the "RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) ---no-post-rewrite:: - Bypass the post-rewrite hook. +`--no-post-rewrite`:: + Bypass the `post-rewrite` hook. --i:: ---include:: +`-i`:: +`--include`:: Before making a commit out of staged contents so far, stage the contents of paths given on the command line as well. This is usually not what you want unless you are concluding a conflicted merge. --o:: ---only:: +`-o`:: +`--only`:: Make a commit by taking the updated working tree contents of the paths specified on the command line, disregarding any contents that have been staged for other paths. This is the default mode of operation of - 'git commit' if any paths are given on the command line, + `git commit` if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with `--amend`, then no paths need to be specified, which can be used to amend @@ -319,48 +319,48 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) already been staged. If used together with `--allow-empty` paths are also not required, and an empty commit will be created. ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` then standard input is used. Pathspec + elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). See also `--pathspec-file-nul` and global `--literal-pathspecs`. ---pathspec-file-nul:: +`--pathspec-file-nul`:: Only meaningful with `--pathspec-from-file`. Pathspec elements are - separated with NUL character and all other characters are taken + separated with _NUL_ character and all other characters are taken literally (including newlines and quotes). --u[<mode>]:: ---untracked-files[=<mode>]:: +`-u[<mode>]`:: +`--untracked-files[=<mode>]`:: Show untracked files. + -- -The mode parameter is optional (defaults to 'all'), and is used to -specify the handling of untracked files; when -u is not used, the -default is 'normal', i.e. show untracked files and directories. +The _<mode>_ parameter is optional (defaults to `all`), and is used to +specify the handling of untracked files; when `-u` is not used, the +default is `normal`, i.e. show untracked files and directories. The possible options are: - - 'no' - Show no untracked files - - 'normal' - Shows untracked files and directories - - 'all' - Also shows individual files in untracked directories. +`no`:: Show no untracked files +`normal`:: Shows untracked files and directories +`all`:: Also shows individual files in untracked directories. All usual spellings for Boolean value `true` are taken as `normal` and `false` as `no`. -The default can be changed using the status.showUntrackedFiles +The default can be changed using the `status.showUntrackedFiles` configuration variable documented in linkgit:git-config[1]. -- --v:: ---verbose:: - Show unified diff between the HEAD commit and what +`-v`:: +`--verbose`:: + Show unified diff between the `HEAD` commit and what would be committed at the bottom of the commit message template to help the user describe the commit by reminding what changes the commit has. Note that this diff output doesn't have its - lines prefixed with '#'. This diff will not be a part + lines prefixed with `#`. This diff will not be a part of the commit message. See the `commit.verbose` configuration variable in linkgit:git-config[1]. + @@ -368,40 +368,40 @@ If specified twice, show in addition the unified diff between what would be committed and the worktree files, i.e. the unstaged changes to tracked files. --q:: ---quiet:: +`-q`:: +`--quiet`:: Suppress commit summary message. ---dry-run:: +`--dry-run`:: Do not create a commit, but show a list of paths that are to be committed, paths with local changes that will be left uncommitted and paths that are untracked. ---status:: +`--status`:: Include the output of linkgit:git-status[1] in the commit message template when using an editor to prepare the commit message. Defaults to on, but can be used to override - configuration variable commit.status. + configuration variable `commit.status`. ---no-status:: +`--no-status`:: Do not include the output of linkgit:git-status[1] in the commit message template when using an editor to prepare the default commit message. --S[<keyid>]:: ---gpg-sign[=<keyid>]:: ---no-gpg-sign:: - GPG-sign commits. The `keyid` argument is optional and +`-S[<key-id>]`:: +`--gpg-sign[=<key-id>]`:: +`--no-gpg-sign`:: + GPG-sign commits. The _<key-id>_ is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. `--no-gpg-sign` is useful to countermand both `commit.gpgSign` configuration variable, and earlier `--gpg-sign`. -\--:: +`--`:: Do not interpret any more arguments as options. -<pathspec>...:: - When pathspec is given on the command line, commit the contents of +`<pathspec>...`:: + When _<pathspec>_ is given on the command line, commit the contents of the files that match the pathspec without recording the changes already added to the index. The contents of these files are also staged for the next commit on top of what have been staged before. @@ -412,10 +412,10 @@ EXAMPLES -------- When recording your own work, the contents of modified files in your working tree are temporarily stored to a staging area -called the "index" with 'git add'. A file can be +called the "index" with `git add`. A file can be reverted back, only in the index but not in the working tree, to that of the last commit with `git restore --staged <file>`, -which effectively reverts 'git add' and prevents the changes to +which effectively reverts `git add` and prevents the changes to this file from participating in the next commit. After building the state to be committed incrementally with these commands, `git commit` (without any pathname parameter) is used to record what @@ -443,7 +443,7 @@ $ git commit -a ------------ The command `git commit -a` first looks at your working tree, -notices that you have modified hello.c and removed goodbye.c, +notices that you have modified `hello.c` and removed `goodbye.c`, and performs necessary `git add` and `git rm` for you. After staging changes to many files, you can alter the order the @@ -471,13 +471,13 @@ $ git commit this second commit would record the changes to `hello.c` and `hello.h` as expected. -After a merge (initiated by 'git merge' or 'git pull') stops +After a merge (initiated by `git merge` or `git pull`) stops because of conflicts, cleanly merged paths are already staged to be committed for you, and paths that conflicted are left in unmerged state. You would have to first -check which paths are conflicting with 'git status' +check which paths are conflicting with `git status` and after fixing them manually in your working tree, you would -stage the result as usual with 'git add': +stage the result as usual with `git add`: ------------ $ git status | grep unmerged @@ -507,12 +507,12 @@ COMMIT INFORMATION Author and committer information is taken from the following environment variables, if set: - GIT_AUTHOR_NAME - GIT_AUTHOR_EMAIL - GIT_AUTHOR_DATE - GIT_COMMITTER_NAME - GIT_COMMITTER_EMAIL - GIT_COMMITTER_DATE + * `GIT_AUTHOR_NAME` + * `GIT_AUTHOR_EMAIL` + * `GIT_AUTHOR_DATE` + * `GIT_COMMITTER_NAME` + * `GIT_COMMITTER_EMAIL` + * `GIT_COMMITTER_DATE` (nb "<", ">" and "\n"s are stripped) @@ -524,7 +524,7 @@ that, see the `credential.username` variable in linkgit:git-config[1]. In case (some of) these environment variables are not set, the information is taken from the configuration items `user.name` and `user.email`, or, if not -present, the environment variable EMAIL, or, if that is not set, +present, the environment variable `EMAIL`, or, if that is not set, system user name and the hostname used for outgoing mail (taken from `/etc/mailname` and falling back to the fully qualified hostname when that file does not exist). @@ -555,7 +555,7 @@ include::i18n.txt[] ENVIRONMENT AND CONFIGURATION VARIABLES --------------------------------------- The editor used to edit the commit log message will be chosen from the -`GIT_EDITOR` environment variable, the core.editor configuration variable, the +`GIT_EDITOR` environment variable, the `core.editor` configuration variable, the `VISUAL` environment variable, or the `EDITOR` environment variable (in that order). See linkgit:git-var[1] for details. -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v2 1/5] doc: apply new documentation guidelines to git commit 2025-01-15 20:23 ` [PATCH v2 1/5] doc: apply new documentation guidelines to " Jean-Noël Avila via GitGitGadget @ 2025-01-15 23:46 ` Junio C Hamano 0 siblings, 0 replies; 15+ messages in thread From: Junio C Hamano @ 2025-01-15 23:46 UTC (permalink / raw) To: Jean-Noël Avila via GitGitGadget Cc: git, Patrick Steinhardt, Jean-Noël Avila "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes: > -[verse] > -'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] > +[synopsis] > +git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] > [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>] > [-F <file> | -m <msg>] [--reset-author] [--allow-empty] > [--allow-empty-message] [--no-verify] [-e] [--author=<author>] It is already nice enough that with just writing [synopsis] we do not have to worry about backquoting literals emphasising <placeholders> and other mark-up minutiae. And then ... > --C <commit>:: > ---reuse-message=<commit>:: > - Take an existing commit object, and reuse the log message > +`-C <commit>`:: > +`--reuse-message=<commit>`:: ... we also are freed from the same worry whenever we use `here are things that are treated pretty much the same way as in [synopsis] section` notation like here. Quite nice. > @@ -507,12 +507,12 @@ COMMIT INFORMATION > Author and committer information is taken from the following environment > variables, if set: > > - GIT_AUTHOR_NAME > - GIT_AUTHOR_EMAIL > - GIT_AUTHOR_DATE > - GIT_COMMITTER_NAME > - GIT_COMMITTER_EMAIL > - GIT_COMMITTER_DATE > + * `GIT_AUTHOR_NAME` > + * `GIT_AUTHOR_EMAIL` > + * `GIT_AUTHOR_DATE` > + * `GIT_COMMITTER_NAME` > + * `GIT_COMMITTER_EMAIL` > + * `GIT_COMMITTER_DATE` OK. ^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v2 2/5] doc: the mode param of -u of git commit is optional 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 1/5] doc: apply new documentation guidelines to " Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 3/5] doc: make more direct explanations in git commit options Jean-Noël Avila via GitGitGadget ` (2 subsequent siblings) 4 siblings, 0 replies; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> Fix the synopsis to reflect the option description. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/git-commit.txt | 2 +- builtin/commit.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index e37c4a4987e..f5d702205d2 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -8,7 +8,7 @@ git-commit - Record changes to the repository SYNOPSIS -------- [synopsis] -git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] +git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend] [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>] [-F <file> | -m <msg>] [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify] [-e] [--author=<author>] diff --git a/builtin/commit.c b/builtin/commit.c index ef5e622c077..a7315ed67cc 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -44,7 +44,7 @@ #include "trailer.h" static const char * const builtin_commit_usage[] = { - N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n" + N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n" " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n" " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n" " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n" -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 3/5] doc: make more direct explanations in git commit options 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 1/5] doc: apply new documentation guidelines to " Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 2/5] doc: the mode param of -u of git commit is optional Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 4/5] doc: convert git commit config to new format Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 5/5] doc: migrate git-commit manpage secondary files " Jean-Noël Avila via GitGitGadget 4 siblings, 0 replies; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> - Use imperative mood - make use of the placeholder format to simplify style Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/git-commit.txt | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index f5d702205d2..602e2f1200b 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -66,7 +66,7 @@ OPTIONS ------- `-a`:: `--all`:: - Tell the command to automatically stage files that have + Automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected. @@ -166,7 +166,7 @@ See linkgit:git-rebase[1] for details. `-F <file>`:: `--file=<file>`:: - Take the commit message from the given file. Use '-' to + Take the commit message from _<file>_. Use '-' to read the message from the standard input. `--author=<author>`:: @@ -181,7 +181,7 @@ See linkgit:git-rebase[1] for details. `-m <msg>`:: `--message=<msg>`:: - Use the given <msg> as the commit message. + Use _<msg>_ as the commit message. If multiple `-m` options are given, their values are concatenated as separate paragraphs. + @@ -190,7 +190,7 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. `-t <file>`:: `--template=<file>`:: When editing the commit message, start the editor with the - contents in the given file. The `commit.template` configuration + contents in _<file>_. The `commit.template` configuration variable is often used to give this option implicitly to the command. This mechanism can be used by projects that want to guide participants with some hints on what to write in the message @@ -213,8 +213,7 @@ include::signoff-option.txt[] `-n`:: `--[no-]verify`:: - By default, the pre-commit and commit-msg hooks are run. - When any of `--no-verify` or `-n` is given, these are bypassed. + Bypass the `pre-commit` and `commit-msg` hooks. See also linkgit:githooks[5]. `--allow-empty`:: @@ -224,13 +223,12 @@ include::signoff-option.txt[] is primarily for use by foreign SCM interface scripts. `--allow-empty-message`:: - Like `--allow-empty` this command is primarily for use by foreign - SCM interface scripts. It allows you to create a commit with an - empty commit message without using plumbing commands like - linkgit:git-commit-tree[1]. + Create a commit with an empty commit message without using plumbing + commands like linkgit:git-commit-tree[1]. Like `--allow-empty`, this + command is primarily for use by foreign SCM interface scripts. `--cleanup=<mode>`:: - This option determines how the supplied commit message should be + Determine how the supplied commit message should be cleaned up before committing. The '<mode>' can be `strip`, `whitespace`, `verbatim`, `scissors` or `default`. + @@ -259,10 +257,9 @@ variable (see linkgit:git-config[1]). `-e`:: `--edit`:: - The message taken from file with `-F`, command line with - `-m`, and from commit object with `-C` are usually used as - the commit log message unmodified. This option lets you - further edit the message taken from these sources. + Let the user further edit the message taken from _<file>_ + with `-F <file>`, command line with `-m <message>`, and + from _<commit>_ with `-C <commit>`. `--no-edit`:: Use the selected commit message without launching an editor. @@ -320,7 +317,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) paths are also not required, and an empty commit will be created. `--pathspec-from-file=<file>`:: - Pathspec is passed in _<file>_ instead of commandline args. If + Pass pathspec in _<file>_ instead of commandline args. If _<file>_ is exactly `-` then standard input is used. Pathspec elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be quoted as explained for the configuration variable `core.quotePath` -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* [PATCH v2 4/5] doc: convert git commit config to new format 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget ` (2 preceding siblings ...) 2025-01-15 20:23 ` [PATCH v2 3/5] doc: make more direct explanations in git commit options Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-15 23:49 ` Junio C Hamano 2025-01-15 20:23 ` [PATCH v2 5/5] doc: migrate git-commit manpage secondary files " Jean-Noël Avila via GitGitGadget 4 siblings, 1 reply; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> Also prevent git-commit manpage to refer to itself in the config description by using a variable. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/config/commit.txt | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.txt index 62f0d92fda5..d3f4624fd27 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.txt @@ -1,29 +1,34 @@ -commit.cleanup:: +ifdef::git-commit[] +:see-git-commit: +endif::git-commit[] +ifndef::git-commit[] +:see-git-commit: See linkgit:git-commit[1] for details. +endif::git-commit[] +`commit.cleanup`:: This setting overrides the default of the `--cleanup` option in - `git commit`. See linkgit:git-commit[1] for details. Changing the - default can be useful when you always want to keep lines that begin + `git commit`. {see-git-commit} Changing the default can be useful + when you always want to keep lines that begin with the comment character `#` in your log message, in which case you would do `git config commit.cleanup whitespace` (note that you will have to remove the help lines that begin with `#` in the commit log template yourself, if you do this). -commit.gpgSign:: - +`commit.gpgSign`:: A boolean to specify whether all commits should be GPG signed. Use of this option when doing operations such as rebase can result in a large number of commits being signed. It may be convenient to use an agent to avoid typing your GPG passphrase several times. -commit.status:: +`commit.status`:: A boolean to enable/disable inclusion of status information in the commit message template when using an editor to prepare the commit - message. Defaults to true. + message. Defaults to `true`. -commit.template:: +`commit.template`:: Specify the pathname of a file to use as the template for new commit messages. -commit.verbose:: +`commit.verbose`:: A boolean or int to specify the level of verbosity with `git commit`. - See linkgit:git-commit[1]. + {see-git-commit} -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v2 4/5] doc: convert git commit config to new format 2025-01-15 20:23 ` [PATCH v2 4/5] doc: convert git commit config to new format Jean-Noël Avila via GitGitGadget @ 2025-01-15 23:49 ` Junio C Hamano 0 siblings, 0 replies; 15+ messages in thread From: Junio C Hamano @ 2025-01-15 23:49 UTC (permalink / raw) To: Jean-Noël Avila via GitGitGadget Cc: git, Patrick Steinhardt, Jean-Noël Avila "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes: > +ifdef::git-commit[] > +:see-git-commit: > +endif::git-commit[] > +ifndef::git-commit[] > +:see-git-commit: See linkgit:git-commit[1] for details. > +endif::git-commit[] > +`commit.cleanup`:: > This setting overrides the default of the `--cleanup` option in > - `git commit`. See linkgit:git-commit[1] for details. Changing the > - default can be useful when you always want to keep lines that begin > + `git commit`. {see-git-commit} Changing the default can be useful > + when you always want to keep lines that begin OK. ^ permalink raw reply [flat|nested] 15+ messages in thread
* [PATCH v2 5/5] doc: migrate git-commit manpage secondary files to new format 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget ` (3 preceding siblings ...) 2025-01-15 20:23 ` [PATCH v2 4/5] doc: convert git commit config to new format Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 ` Jean-Noël Avila via GitGitGadget 2025-01-16 10:17 ` Patrick Steinhardt 4 siblings, 1 reply; 15+ messages in thread From: Jean-Noël Avila via GitGitGadget @ 2025-01-15 20:23 UTC (permalink / raw) To: git; +Cc: Patrick Steinhardt, Jean-Noël Avila, Jean-Noël Avila From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> --- Documentation/i18n.txt | 4 ++-- Documentation/signoff-option.txt | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index 3a866af4a42..baff780a7e3 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git does not forbid it. However, there are a few things to keep in mind. -. 'git commit' and 'git commit-tree' issue +. `git commit` and `git commit-tree` issue a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to @@ -50,7 +50,7 @@ of `i18n.commitEncoding` in their `encoding` header. This is to help other people who look at them later. Lack of this header implies that the commit log message is encoded in UTF-8. -. 'git log', 'git show', 'git blame' and friends look at the +. `git log`, `git show`, `git blame` and friends look at the `encoding` header of a commit object, and try to re-code the log message into UTF-8 unless otherwise specified. You can specify the desired output encoding with diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt index d98758f3cb7..cddfb225d1d 100644 --- a/Documentation/signoff-option.txt +++ b/Documentation/signoff-option.txt @@ -1,8 +1,8 @@ ifdef::git-commit[] --s:: +`-s`:: endif::git-commit[] ---signoff:: ---no-signoff:: +`--signoff`:: +`--no-signoff`:: Add a `Signed-off-by` trailer by the committer at the end of the commit log message. The meaning of a signoff depends on the project to which you're committing. For example, it may certify that @@ -14,5 +14,5 @@ endif::git-commit[] leadership of the project to which you're contributing to understand how the signoffs are used in that project. + -The --no-signoff option can be used to countermand an earlier --signoff +The `--no-signoff` option can be used to countermand an earlier `--signoff` option on the command line. -- gitgitgadget ^ permalink raw reply related [flat|nested] 15+ messages in thread
* Re: [PATCH v2 5/5] doc: migrate git-commit manpage secondary files to new format 2025-01-15 20:23 ` [PATCH v2 5/5] doc: migrate git-commit manpage secondary files " Jean-Noël Avila via GitGitGadget @ 2025-01-16 10:17 ` Patrick Steinhardt 0 siblings, 0 replies; 15+ messages in thread From: Patrick Steinhardt @ 2025-01-16 10:17 UTC (permalink / raw) To: Jean-Noël Avila via GitGitGadget; +Cc: git, Jean-Noël Avila On Wed, Jan 15, 2025 at 08:23:48PM +0000, Jean-Noël Avila via GitGitGadget wrote: > From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr> I would've liked to see a small description of what this does and also provide a bit more context in the other commit messages instead of the bulleted lists you have. They don't give the reader much of a sense of the context we're operating in and why we think that those changes are good. Other than that the patch series looks fine to me. Thanks! Patrick ^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2025-01-16 10:17 UTC | newest] Thread overview: 15+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2025-01-03 13:47 [PATCH 0/3] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 1/3] doc: git-commit: apply new documentation guidelines Jean-Noël Avila via GitGitGadget 2025-01-06 7:38 ` Patrick Steinhardt 2025-01-07 21:14 ` Jean-Noël AVILA 2025-01-03 13:47 ` [PATCH 2/3] doc: git-commit.txt: convert git commit config to new format Jean-Noël Avila via GitGitGadget 2025-01-03 13:47 ` [PATCH 3/3] doc: git-commit: migrate secondary files " Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 0/5] Doc git commit Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 1/5] doc: apply new documentation guidelines to " Jean-Noël Avila via GitGitGadget 2025-01-15 23:46 ` Junio C Hamano 2025-01-15 20:23 ` [PATCH v2 2/5] doc: the mode param of -u of git commit is optional Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 3/5] doc: make more direct explanations in git commit options Jean-Noël Avila via GitGitGadget 2025-01-15 20:23 ` [PATCH v2 4/5] doc: convert git commit config to new format Jean-Noël Avila via GitGitGadget 2025-01-15 23:49 ` Junio C Hamano 2025-01-15 20:23 ` [PATCH v2 5/5] doc: migrate git-commit manpage secondary files " Jean-Noël Avila via GitGitGadget 2025-01-16 10:17 ` Patrick Steinhardt
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).