aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2009-08-15 01:58:37 -0700
committerJunio C Hamano <gitster@pobox.com>2009-08-15 01:58:37 -0700
commit60c2993c92fa1aa7f4d4aab7de6d8769052ced6f (patch)
tree97e71d73bd5099de29156fa1b3f8afc39d2c6982 /Documentation/git-commit.txt
parent7637868362ab64fe22521c645006ba70c4ef83a9 (diff)
downloadgit-60c2993c92fa1aa7f4d4aab7de6d8769052ced6f.tar.gz
git-60c2993c92fa1aa7f4d4aab7de6d8769052ced6f.tar.xz
Documentation/git-commit.txt: describe --dry-run
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt13
1 files changed, 9 insertions, 4 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index d01ff5ada..64f94cfe1 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
- [(-c | -C) <commit>] [-F <file> | -m <msg>]
+ [(-c | -C) <commit>] [-F <file> | -m <msg>] [--dry-run]
[--allow-empty] [--no-verify] [-e] [--author=<author>]
[--cleanup=<mode>] [--] [[-i | -o ]<file>...]
@@ -42,10 +42,9 @@ The content to be added can be specified in several ways:
by one which files should be part of the commit, before finalizing the
operation. Currently, this is done by invoking 'git-add --interactive'.
-The 'git-status' command can be used to obtain a
+The `--dry-run` option can be used to obtain a
summary of what is included by any of the above for the next
-commit by giving the same set of parameters you would give to
-this command.
+commit by giving the same set of parameters (options and paths).
If you make a commit and then find a mistake immediately after
that, you can recover from it with 'git-reset'.
@@ -70,6 +69,12 @@ OPTIONS
Like '-C', but with '-c' the editor is invoked, so that
the user can further edit the commit message.
+--dry-run::
+ Do not actually make a commit, but show the list of paths
+ with updates in the index, paths with changes in the work tree,
+ and paths that are untracked, similar to the one that is given
+ in the commit log editor.
+
-F <file>::
--file=<file>::
Take the commit message from the given file. Use '-' to