Mercurial > hg-stable
changeset 1672:07f931af5f40
add documentation for email command.
author | Vadim Gelfer <vadim.gelfer@gmail.com> |
---|---|
date | Tue, 31 Jan 2006 08:14:23 -0800 |
parents | fe19c54ee403 |
children | bd53710c7780 |
files | hgext/patchbomb.py |
diffstat | 1 files changed, 12 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/patchbomb.py Tue Jan 31 08:08:43 2006 -0800 +++ b/hgext/patchbomb.py Tue Jan 31 08:14:23 2006 -0800 @@ -50,6 +50,7 @@ from mercurial import commands from mercurial import hg from mercurial import ui +from mercurial.i18n import gettext as _ import os import popen2 import smtplib @@ -86,7 +87,17 @@ except: pass def patchbomb(ui, repo, *revs, **opts): - '''send changesets as a series of patch emails''' + '''send changesets as a series of patch emails + + The series starts with a "[PATCH 0 of N]" introduction, which + describes the series as a whole. + + Each patch email has a Subject line of "[PATCH M of N] ...", using + the first line of the changeset description as the subject text. + The message contains two or three body parts. First, the rest of + the changeset description. Next, (optionally) if the diffstat + program is installed, the result of running diffstat on the patch. + Finally, the patch itself, as generated by "hg export".''' def prompt(prompt, default = None, rest = ': ', empty_ok = False): if default: prompt += ' [%s]' % default prompt += rest