From: Jeff King <peff@peff.net>
Date: Wed, 28 May 2008 22:38:58 GMT
Subject: Re: cherry picking changesets instead of commits
Message-ID: <20080528223858.GA15107@sigill.intra.peff.net>
In-Reply-To: <7f9d599f0805281414x6b97070ag7a1cc36f5d3c5a36@mail.gmail.com>

On Wed, May 28, 2008 at 02:14:59PM -0700, Geoffrey Irving wrote:

> > In manual pages, "SEE ALSO" section is a more appropriate place to do this
> > kind of thing.
> 
> Here's an improved patch.

The usual way to include a cover letter in a patch is either:

  Subject: [PATCH] commit message subject

  commit message

  ---
  your cover letter

  diffstat + diff

or (and I often use this in a reply where it makes sense to read the
cover letter first):

  Subject: Re: your mail

  cover letter

  -- >8 -- (any visual separator that is _not_ "---")
  commit message subject

  commit message

  ---
  diffstat + diff

In the second case, I believe Junio just manually deletes everything
above the separator.

> +See Also
> +--------
> +'git-patch-id(1)'::
> +       The mechanism git-cherry uses to compare changesets.
> +

This should be

  linkgit:git-patch-id[1]::

which will turn it into the text you wrote for a manpage, or a link in
the HTML version. Looks like we already have a few of the style you used
that should probably be fixed, though.

-Peff