Re: [PATCH v2 0/7] clarify 'git merge' documentation

From: Thomas Rast <trast@student.ethz.ch>
Date: Jan 24, 2010, 13:25 UTC
Message-ID: <201001241425.07027.trast@student.ethz.ch>
In-Reply-To: <20100123092551.GA7571@progeny.tock>

On Saturday 23 January 2010 10:25:51 Jonathan Nieder wrote:

Show 8 quoted lines

> Jonathan Nieder (7):
>   Documentation: merge: move configuration section to end
>   Documentation: suggest `reset --merge` in How Merge Works section
>   Documentation: merge: move merge strategy list to end
>   Documentation: merge: add an overview
>   Documentation: emphasize when git merge terminates early
>   Documentation: merge: add a section about fast-forward
>   Documentation: simplify How Merge Works

[and in the other thread]

> Jonathan Nieder (1):
>   Documentation: merge: use MERGE_HEAD to refer to the remote branch

Thanks Jonathan!  Ack on all of them.

I still had the following patches in my little documentation queue:

  Jonathan Nieder (2):
    Documentation: git gc packs refs by default now
    Documentation: tiny git config manual tweaks

  Thomas Rast (2):
    Documentation: show-files is now called git-ls-files
    Documentation: emphasise 'git shortlog' in its synopsis

I actually forgot to post the last one, which I'll do shortly, but it's trivial so I just included it at the bottom.

Junio, I gathered all of the above patches and pushed them again to

  git://repo.or.cz/git/trast.git doc-style/for-next

If that's ok and you merge it, I'll declare this the end of this little topic. Admittedly it grew a bit outside the original area of style fixes into a half-rewrite of git-merge(1).

-- 8< --
Subject: [PATCH] Documentation: emphasise 'git shortlog' in its synopsis

The accepted style in the SYNOPSIS section is for a command to be 'emphasised'. Do so for the git-shortlog(1) manpage.

Signed-off-by: Thomas Rast <trast@student.ethz.ch>

diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index ecf9e27..dfd4d0c 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
-git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
+'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] [<committish>...]
 
 DESCRIPTION
 -----------

-- 
Thomas Rast
trast@{inf,student}.ethz.ch