aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/config/commit.adoc
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2025-02-14 17:53:47 -0800
committerJunio C Hamano <gitster@pobox.com>2025-02-14 17:53:47 -0800
commit0cc13007e5d50b096c95047680ace56749c18789 (patch)
tree878436cfc6ab29459a5666cb51ba4ae8ea8a486c /Documentation/config/commit.adoc
parentThe tenth batch (diff)
parentRemove obsolete ".txt" extensions for AsciiDoc files (diff)
downloadgit-0cc13007e5d50b096c95047680ace56749c18789.tar.gz
git-0cc13007e5d50b096c95047680ace56749c18789.zip
Merge branch 'bc/doc-adoc-not-txt'
All the documentation .txt files have been renamed to .adoc to help content aware editors. * bc/doc-adoc-not-txt: Remove obsolete ".txt" extensions for AsciiDoc files doc: use .adoc extension for AsciiDoc files gitattributes: mark AsciiDoc files as LF-only editorconfig: add .adoc extension doc: update gitignore for .adoc extension
Diffstat (limited to 'Documentation/config/commit.adoc')
-rw-r--r--Documentation/config/commit.adoc34
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/config/commit.adoc b/Documentation/config/commit.adoc
new file mode 100644
index 0000000000..d3f4624fd2
--- /dev/null
+++ b/Documentation/config/commit.adoc
@@ -0,0 +1,34 @@
+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-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`::
+ 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`::
+ 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`.
+
+`commit.template`::
+ Specify the pathname of a file to use as the template for
+ new commit messages.
+
+`commit.verbose`::
+ A boolean or int to specify the level of verbosity with `git commit`.
+ {see-git-commit}