[PATCH] Misc doc improvements

[PATCH] Misc doc improvements

[Jonas Fonseca]

Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
---
 Documentation/git-apply.txt    |    2 +-
 Documentation/git-shortlog.txt |   19 ++++++++++++++++---
 Documentation/glossary.txt     |    7 +++++++
 3 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 9cc7c74..2ff7494 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -76,7 +76,7 @@ OPTIONS
 -C<n>::
 	Ensure at least <n> lines of surrounding context match before
 	and after each change.  When fewer lines of surrounding
-	context exist they all most match.  By default no context is
+	context exist they all must match.  By default no context is
 	ever ignored.
 
 --apply::
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index 54fb922..0dbd3b2 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -5,7 +5,6 @@ NAME
 ----
 git-shortlog - Summarize 'git log' output
 
-
 SYNOPSIS
 --------
 git-log --pretty=short | 'git-shortlog'
@@ -13,8 +12,22 @@ git-log --pretty=short | 'git-shortlog'
 DESCRIPTION
 -----------
 Summarizes 'git log' output in a format suitable for inclusion
-in release announcements.
-
+in release announcements. Each commit will be grouped by author
+the first line of the commit message will be shown.
+
+Additionally, "[PATCH]" will be stripped from the commit description.
+
+FILES
+-----
+'.mailcap'::
+	If this file exists, it will be used for mapping author email
+	addresses to a real author name. One mapping per line, first
+	the author name followed by the email address enclosed by
+	'<' and '>'. Use hash '#' for comments. Example:
+
+		# Keep alphabetized
+		Adam Morrow <adam@localhost.localdomain>
+		Eve Jones <eve@laptop.(none)>
 
 Author
 ------
diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt
index 39c90ad..879c708 100644
--- a/Documentation/glossary.txt
+++ b/Documentation/glossary.txt
@@ -109,6 +109,13 @@ file system::
 git archive::
 	Synonym for repository (for arch people).
 
+grafts::
+	Grafts enables two otherwise different lines of development to be
+	joined together by recording fake ancestry information for commits.
+	This way you can make git pretend the set of parents a commit
+	has is different from what was recorded when the commit was created.
+	Configured via the `.git/info/grafts` file.
+
 hash::
 	In git's context, synonym to object name.
 
-- 
1.4.0.rc1.gfd4c-dirty
-- 
Jonas Fonseca

Re: [PATCH] Misc doc improvements

[Jakub Narebski]

Jonas Fonseca wrote:

> +grafts::
> +     Grafts enables two otherwise different lines of development to be
> +     joined together by recording fake ancestry information for commits.
> +     This way you can make git pretend the set of parents a commit
> +     has is different from what was recorded when the commit was created.
> +     Configured via the `.git/info/grafts` file.

Actually, grafts are used to "fake" (or change) parents (ancestry) of an
existing commit. It can be used both to add parents (e.g. joining roots of
"current" repository with historical one), or remove parents (e.g. to
shorten (cauterize) history like in the "shalllow clone" idea).

-- 
Jakub Narebski
Warsaw, Poland

Re: [PATCH] Misc doc improvements

[Francis Daly]

Jonas Fonseca wrote:

> +FILES
> +-----
> +'.mailcap'::

s/cap/map/

.mailcap is for something else.

	f
-- 
Francis Daly        francis@daoine.org