[PATCH 3 of 3] Improve documentation for patchbomb and email

Alexis S. L. Carvalho alexis at cecm.usp.br
Tue Mar 27 00:22:11 UTC 2007


Thus spake John Goerzen:
> Improve documentation for patchbomb and email

I've pushed this to crew.

Minor comments:

> diff -r 4a25b21718d9 -r 300b64b1aef1 hgext/patchbomb.py
> --- a/hgext/patchbomb.py	Thu Mar 22 13:52:20 2007 -0500
> +++ b/hgext/patchbomb.py	Thu Mar 22 14:02:39 2007 -0500
> @@ -79,7 +79,7 @@ def patchbomb(ui, repo, *revs, **opts):
>  def patchbomb(ui, repo, *revs, **opts):
>      '''send changesets as a series of patch emails

This short description is not very accurate right now.  Maybe "send
changesets by email" or something like that, changing the text below
slightly to keep things making sense.

> -    The series starts with a "[PATCH 0 of N]" introduction, which
> +    By default, 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
> @@ -90,8 +90,32 @@ def patchbomb(ui, repo, *revs, **opts):
>      Finally, the patch itself, as generated by "hg export".
>  
>      With --outgoing, emails will be generated for patches not
> -    found in the target repository (or only those which are
> +    found in the destination repository (or only those which are
>      ancestors of the specified revisions if any are provided)
> +
> +    With --bundle, changesets are selected as for --outgoing,
> +    but a single email containing a binary Mercurial bundle as an
> +    attachment will be sent.
> +
> +    Examples:
> +
> +    hg email -r 3000          # send patch 3000 only
> +    hg email -r 3000 -r 3001  # send patches 3000 and 3001
> +    hg email -r 3000:3005     # send patches 3000 through 3005
> +    hg email 3000             # send patch 3000 (deprecated)
> +
> +    hg email -o               # send all patches not in default
> +    hg email -o DEST          # send all patches not in DEST
> +    hg email -o -r 3000       # send all ancestors of 3000 not in default
> +    hg email -o -r 3000 DEST  # send all ancestors of 3000 not in DEST
> +
> +    hg email -b               # send bundle of all patches not in default
> +    hg email -b DEST          # send bundle of all patches not in DEST
> +    hg email -b -r 3000       # bundle of all ancestors of 3000 not in default
> +    hg email -b -r 3000 DEST  # bundle of all ancestors of 3000 not in DEST
> +
> +    Before using this command, you will need to enable email in your hgrc.
> +    See hgrc(5) for details.

What do you mean by "enable email"?  Configure hg to send email?  In
this case, a pointer directly to the email.method variable in hgrc(5)
would probably be nice.

Thanks

Alexis



More information about the Mercurial-devel mailing list