git-gc: do not run git-prune by default.
[gitweb.git] / Documentation / git-commit.txt
index b4528d72ba376bb0444002698196afa89f781fc1..532703a674167c225fef88c7235a59d2d6d151b3 100644 (file)
@@ -3,7 +3,7 @@ git-commit(1)
 
 NAME
 ----
-git-commit - Record your changes
+git-commit - Record changes to the repository
 
 SYNOPSIS
 --------
@@ -111,7 +111,7 @@ but can be used to amend a merge commit.
        are concluding a conflicted merge.
 
 -q|--quiet::
-       Supress commit summary message.
+       Suppress commit summary message.
 
 \--::
        Do not interpret any more arguments as options.
@@ -142,11 +142,6 @@ $ git add hello.c
 $ 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
@@ -223,6 +218,12 @@ refuses to run when given pathnames (but see `-i` option).
 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