Skip to content

Commit 01b9465

Browse files
jnavilagitster
authored andcommitted
doc: make more direct explanations in git commit options
- Use imperative mood - make use of the placeholder format to simplify style Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d533c10 commit 01b9465

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

Documentation/git-commit.txt

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ OPTIONS
6666
-------
6767
`-a`::
6868
`--all`::
69-
Tell the command to automatically stage files that have
69+
Automatically stage files that have
7070
been modified and deleted, but new files you have not
7171
told Git about are not affected.
7272

@@ -166,7 +166,7 @@ See linkgit:git-rebase[1] for details.
166166

167167
`-F <file>`::
168168
`--file=<file>`::
169-
Take the commit message from the given file. Use '-' to
169+
Take the commit message from _<file>_. Use '-' to
170170
read the message from the standard input.
171171

172172
`--author=<author>`::
@@ -181,7 +181,7 @@ See linkgit:git-rebase[1] for details.
181181

182182
`-m <msg>`::
183183
`--message=<msg>`::
184-
Use the given <msg> as the commit message.
184+
Use _<msg>_ as the commit message.
185185
If multiple `-m` options are given, their values are
186186
concatenated as separate paragraphs.
187187
+
@@ -190,7 +190,7 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
190190
`-t <file>`::
191191
`--template=<file>`::
192192
When editing the commit message, start the editor with the
193-
contents in the given file. The `commit.template` configuration
193+
contents in _<file>_. The `commit.template` configuration
194194
variable is often used to give this option implicitly to the
195195
command. This mechanism can be used by projects that want to
196196
guide participants with some hints on what to write in the message
@@ -213,8 +213,7 @@ include::signoff-option.txt[]
213213

214214
`-n`::
215215
`--[no-]verify`::
216-
By default, the pre-commit and commit-msg hooks are run.
217-
When any of `--no-verify` or `-n` is given, these are bypassed.
216+
Bypass the `pre-commit` and `commit-msg` hooks.
218217
See also linkgit:githooks[5].
219218

220219
`--allow-empty`::
@@ -224,13 +223,12 @@ include::signoff-option.txt[]
224223
is primarily for use by foreign SCM interface scripts.
225224

226225
`--allow-empty-message`::
227-
Like `--allow-empty` this command is primarily for use by foreign
228-
SCM interface scripts. It allows you to create a commit with an
229-
empty commit message without using plumbing commands like
230-
linkgit:git-commit-tree[1].
226+
Create a commit with an empty commit message without using plumbing
227+
commands like linkgit:git-commit-tree[1]. Like `--allow-empty`, this
228+
command is primarily for use by foreign SCM interface scripts.
231229

232230
`--cleanup=<mode>`::
233-
This option determines how the supplied commit message should be
231+
Determine how the supplied commit message should be
234232
cleaned up before committing. The '<mode>' can be `strip`,
235233
`whitespace`, `verbatim`, `scissors` or `default`.
236234
+
@@ -259,10 +257,9 @@ variable (see linkgit:git-config[1]).
259257

260258
`-e`::
261259
`--edit`::
262-
The message taken from file with `-F`, command line with
263-
`-m`, and from commit object with `-C` are usually used as
264-
the commit log message unmodified. This option lets you
265-
further edit the message taken from these sources.
260+
Let the user further edit the message taken from _<file>_
261+
with `-F <file>`, command line with `-m <message>`, and
262+
from _<commit>_ with `-C <commit>`.
266263

267264
`--no-edit`::
268265
Use the selected commit message without launching an editor.
@@ -320,7 +317,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
320317
paths are also not required, and an empty commit will be created.
321318

322319
`--pathspec-from-file=<file>`::
323-
Pathspec is passed in _<file>_ instead of commandline args. If
320+
Pass pathspec in _<file>_ instead of commandline args. If
324321
_<file>_ is exactly `-` then standard input is used. Pathspec
325322
elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be
326323
quoted as explained for the configuration variable `core.quotePath`

0 commit comments

Comments
 (0)