diff options
| author | brian m. carlson <sandals@crustytoothpaste.net> | 2025-01-20 01:56:02 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-01-21 12:56:06 -0800 |
| commit | 1f010d6bdf756129db13d1367c888aa4153f6d87 (patch) | |
| tree | 715708841b4980198157a60e72028e25a0059177 /Documentation/config/commit.adoc | |
| parent | gitattributes: mark AsciiDoc files as LF-only (diff) | |
| download | git-1f010d6bdf756129db13d1367c888aa4153f6d87.tar.gz git-1f010d6bdf756129db13d1367c888aa4153f6d87.zip | |
doc: use .adoc extension for AsciiDoc files
We presently use the ".txt" extension for our AsciiDoc files. While not
wrong, most editors do not associate this extension with AsciiDoc,
meaning that contributors don't get automatic editor functionality that
could be useful, such as syntax highlighting and prose linting.
It is much more common to use the ".adoc" extension for AsciiDoc files,
since this helps editors automatically detect files and also allows
various forges to provide rich (HTML-like) rendering. Let's do that
here, renaming all of the files and updating the includes where
relevant. Adjust the various build scripts and makefiles to use the new
extension as well.
Note that this should not result in any user-visible changes to the
documentation.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/commit.adoc')
| -rw-r--r-- | Documentation/config/commit.adoc | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/Documentation/config/commit.adoc b/Documentation/config/commit.adoc new file mode 100644 index 0000000000..62f0d92fda --- /dev/null +++ b/Documentation/config/commit.adoc @@ -0,0 +1,29 @@ +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 + 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 linkgit:git-commit[1]. |