Skip to content

Commit 60c2993

Browse files
committed
Documentation/git-commit.txt: describe --dry-run
Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7637868 commit 60c2993

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Documentation/git-commit.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
12-
[(-c | -C) <commit>] [-F <file> | -m <msg>]
12+
[(-c | -C) <commit>] [-F <file> | -m <msg>] [--dry-run]
1313
[--allow-empty] [--no-verify] [-e] [--author=<author>]
1414
[--cleanup=<mode>] [--] [[-i | -o ]<file>...]
1515

@@ -42,10 +42,9 @@ The content to be added can be specified in several ways:
4242
by one which files should be part of the commit, before finalizing the
4343
operation. Currently, this is done by invoking 'git-add --interactive'.
4444

45-
The 'git-status' command can be used to obtain a
45+
The `--dry-run` option can be used to obtain a
4646
summary of what is included by any of the above for the next
47-
commit by giving the same set of parameters you would give to
48-
this command.
47+
commit by giving the same set of parameters (options and paths).
4948

5049
If you make a commit and then find a mistake immediately after
5150
that, you can recover from it with 'git-reset'.
@@ -70,6 +69,12 @@ OPTIONS
7069
Like '-C', but with '-c' the editor is invoked, so that
7170
the user can further edit the commit message.
7271

72+
--dry-run::
73+
Do not actually make a commit, but show the list of paths
74+
with updates in the index, paths with changes in the work tree,
75+
and paths that are untracked, similar to the one that is given
76+
in the commit log editor.
77+
7378
-F <file>::
7479
--file=<file>::
7580
Take the commit message from the given file. Use '-' to

0 commit comments

Comments
 (0)