Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc git commit #1845

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Doc git commit #1845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91cff84
doc: apply new documentation guidelines to git commit
jnavila Jan 15, 2025
d58526a
doc: the mode param of -u of git commit is optional
jnavila Jan 15, 2025
39db87f
doc: make more direct explanations in git commit options
jnavila Jan 15, 2025
9216554
doc: convert git commit config to new format
jnavila Jan 2, 2025
28316a7
doc: migrate git-commit manpage secondary files to new format
jnavila Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions Documentation/config/commit.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
commit.cleanup::
ifdef::git-commit[]
:see-git-commit:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Jean-Noël Avila via GitGitGadget" <[email protected]> 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.

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}
Loading
Loading