Mercurial > hg > gitweb
changeset 2926:13cd2cdeff6a
hgext: more patchbomb documentation
+ Add a description of how to enable this extension
+ Note which command it provides (it's not very easy to guess
that "hgext.patchbomb" enables the "email" command, unless one
can read Python sources)
+ Expand the descriptions of the -n and -m options of "hg email".
+ Mention that formail is (commonly) part of the procmail package.
| author | Giorgos Keramidas <keramida@ceid.upatras.gr> |
|---|---|
| date | Tue, 15 Aug 2006 23:37:37 +0300 |
| parents | 14b4ad613dd8 |
| children | 27da6dddd0ee 439fd013360d |
| files | hgext/patchbomb.py |
| diffstat | 1 files changed, 34 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/patchbomb.py Wed Aug 16 10:53:01 2006 -0700 +++ b/hgext/patchbomb.py Tue Aug 15 23:37:37 2006 +0300 @@ -23,22 +23,45 @@ # the changeset summary, so you can be sure you are sending the right # changes. # -# It is best to run this script with the "-n" (test only) flag before -# firing it up "for real", in which case it will use your pager to -# display each of the messages that it would send. +# To enable this extension: # -# The "-m" (mbox) option will create an mbox file instead of sending -# the messages directly. This can be reviewed e.g. with "mutt -R -f mbox", -# and finally sent with "formail -s sendmail -bm -t < mbox". +# [extensions] +# hgext.patchbomb = # # To configure other defaults, add a section like this to your hgrc # file: # -# [email] -# from = My Name <my@email> -# to = recipient1, recipient2, ... -# cc = cc1, cc2, ... -# bcc = bcc1, bcc2, ... +# [email] +# from = My Name <my@email> +# to = recipient1, recipient2, ... +# cc = cc1, cc2, ... +# bcc = bcc1, bcc2, ... +# +# Then you can use the "hg email" command to mail a series of changesets +# as a patchbomb. +# +# To avoid sending patches prematurely, it is a good idea to first run +# the "email" command with the "-n" option (test only). You will be +# prompted for an email recipient address, a subject an an introductory +# message describing the patches of your patchbomb. Then when all is +# done, your pager will be fired up once for each patchbomb message, so +# you can verify everything is alright. +# +# The "-m" (mbox) option is also very useful. Instead of previewing +# each patchbomb message in a pager or sending the messages directly, +# it will create a UNIX mailbox file with the patch emails. This +# mailbox file can be previewed with any mail user agent which supports +# UNIX mbox files, i.e. with mutt: +# +# % mutt -R -f mbox +# +# When you are previewing the patchbomb messages, you can use `formail' +# (a utility that is commonly installed as part of the procmail package), +# to send each message out: +# +# % formail -s sendmail -bm -t < mbox +# +# That should be all. Now your patchbomb is on its way out. from mercurial.demandload import * demandload(globals(), '''email.MIMEMultipart email.MIMEText email.Utils