Skip to content

Commit de56e1d

Browse files
committed
Merge branch 'ja/doc-commit-markup-updates'
Doc updates. * ja/doc-commit-markup-updates: doc: migrate git-commit manpage secondary files to new format doc: convert git commit config to new format doc: make more direct explanations in git commit options doc: the mode param of -u of git commit is optional doc: apply new documentation guidelines to git commit
2 parents f046ab2 + 2a13745 commit de56e1d

File tree

5 files changed

+161
-159
lines changed

5 files changed

+161
-159
lines changed

Documentation/config/commit.txt

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
1-
commit.cleanup::
1+
ifdef::git-commit[]
2+
:see-git-commit:
3+
endif::git-commit[]
4+
ifndef::git-commit[]
5+
:see-git-commit: See linkgit:git-commit[1] for details.
6+
endif::git-commit[]
7+
`commit.cleanup`::
28
This setting overrides the default of the `--cleanup` option in
3-
`git commit`. See linkgit:git-commit[1] for details. Changing the
4-
default can be useful when you always want to keep lines that begin
9+
`git commit`. {see-git-commit} Changing the default can be useful
10+
when you always want to keep lines that begin
511
with the comment character `#` in your log message, in which case you
612
would do `git config commit.cleanup whitespace` (note that you will
713
have to remove the help lines that begin with `#` in the commit log
814
template yourself, if you do this).
915

10-
commit.gpgSign::
11-
16+
`commit.gpgSign`::
1217
A boolean to specify whether all commits should be GPG signed.
1318
Use of this option when doing operations such as rebase can
1419
result in a large number of commits being signed. It may be
1520
convenient to use an agent to avoid typing your GPG passphrase
1621
several times.
1722

18-
commit.status::
23+
`commit.status`::
1924
A boolean to enable/disable inclusion of status information in the
2025
commit message template when using an editor to prepare the commit
21-
message. Defaults to true.
26+
message. Defaults to `true`.
2227

23-
commit.template::
28+
`commit.template`::
2429
Specify the pathname of a file to use as the template for
2530
new commit messages.
2631

27-
commit.verbose::
32+
`commit.verbose`::
2833
A boolean or int to specify the level of verbosity with `git commit`.
29-
See linkgit:git-commit[1].
34+
{see-git-commit}

0 commit comments

Comments
 (0)