Add a configuration option to control diffstat after merge

[git.git] / Documentation / git-commit.txt

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index b4528d72ba376bb0444002698196afa89f781fc1..53a7bb0895036e4d66086b8c656e74588c82c38c 100644 (file)
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -3,13 +3,14 @@ git-commit(1)
 
 NAME
 ----
 
 NAME
 ----

-git-commit - Record your changes
+git-commit - Record changes to the repository

 
 SYNOPSIS
 --------
 [verse]
 
 SYNOPSIS
 --------
 [verse]

-'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>]
-          [--no-verify] [--amend] [-e] [--author <author>]
+'git-commit' [-a | --interactive] [-s] [-v]
+          [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
+          [--no-verify] [-e] [--author <author>]

           [--] [[-i | -o ]<file>...]
 
 DESCRIPTION
           [--] [[-i | -o ]<file>...]
 
 DESCRIPTION


@@ -35,6 +36,10 @@ methods:
    before, and to automatically "rm" files that have been
    removed from the working tree, and perform the actual commit.
 
    before, and to automatically "rm" files that have been
    removed from the working tree, and perform the actual commit.
 

+5. by using the --interactive switch with the 'commit' command to decide one
+   by one which files should be part of the commit, before finalizing the
+   operation.  Currently, this is done by invoking `git-add --interactive`.
+

 The gitlink:git-status[1] command 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
 The gitlink:git-status[1] command 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


@@ -111,7 +116,7 @@ but can be used to amend a merge commit.
        are concluding a conflicted merge.
 
 -q|--quiet::
        are concluding a conflicted merge.
 
 -q|--quiet::

-       Supress commit summary message.
+       Suppress commit summary message.

 
 \--::
        Do not interpret any more arguments as options.
 
 \--::
        Do not interpret any more arguments as options.


@@ -142,11 +147,6 @@ $ git add hello.c
 $ git commit
 ------------
 
 $ git commit
 ------------
 

-////////////
-We should fix 'git rm' to remove goodbye.c from both index and
-working tree for the above example.
-////////////
-

 Instead of staging files after each individual change, you can
 tell `git commit` to notice the changes to the files whose
 contents are tracked in
 Instead of staging files after each individual change, you can
 tell `git commit` to notice the changes to the files whose
 contents are tracked in


@@ -223,6 +223,12 @@ refuses to run when given pathnames (but see `-i` option).
 DISCUSSION
 ----------
 
 DISCUSSION
 ----------
 

+Though not required, it's a good idea to begin the commit message
+with a single short (less than 50 character) line summarizing the
+change, followed by a blank line and then a more thorough description.
+Tools that turn commits into email, for example, use the first line
+on the Subject: line and the rest of the commit in the body.
+

 include::i18n.txt[]
 
 ENVIRONMENT VARIABLES
 include::i18n.txt[]
 
 ENVIRONMENT VARIABLES