Documentation/git-commit.txt: describe --dry-run
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Aug 15, 2009 at 01:58 UTC
60c2993c92fa1aa7f4d4aab7de6d8769052ced6f
1 file changed
+9
-4
Documentation/git-commit.txt
+9
-4
@@ -9,7 +9,7 @@ SYNOPSIS
9
--------
10
[verse]
11
'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]
13
[--allow-empty] [--no-verify] [-e] [--author=<author>]
14
[--cleanup=<mode>] [--] [[-i | -o ]<file>...]
15
@@ -42,10 +42,9 @@ The content to be added can be specified in several ways:
42
by one which files should be part of the commit, before finalizing the
43
operation. Currently, this is done by invoking 'git-add --interactive'.
44
45
-The 'git-status' command can be used to obtain a
45
+The `--dry-run` option can be used to obtain a
46
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).
48
49
If you make a commit and then find a mistake immediately after
50
that, you can recover from it with 'git-reset'.
@@ -70,6 +69,12 @@ OPTIONS
69
Like '-C', but with '-c' the editor is invoked, so that
70
the user can further edit the commit message.
71
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
+
78
-F <file>::
79
--file=<file>::
80
Take the commit message from the given file. Use '-' to