comparison hgext/notify.py @ 9104:c9c5aa12a46e

notify: cleanup module docstring

9103:9c7a5d70e72f

# This software may be used and distributed according to the terms of the
# GNU General Public License version 2, incorporated herein by reference.

'''hooks for sending email notifications at commit/push time

Subscriptions can be managed through hgrc. Default mode is to print messages
to stdout, for testing and configuring.

To use, configure notify extension and enable in hgrc like this:

   [extensions]
   hgext.notify =

   [hooks]

   incoming.notify = python:hgext.notify.hook
   # batch emails when many changesets incoming at one time
   changegroup.notify = python:hgext.notify.hook

   [notify]
   # config items go in here

 config items:

 REQUIRED:
   config = /path/to/file # file containing subscriptions

 OPTIONAL:
   test = True            # print messages to stdout for testing
   strip = 3              # number of slashes to strip for url paths
   domain = example.com   # domain to use if committer missing domain
   style = ...            # style file to use when formatting email
   template = ...         # template to use when formatting email

   [email]
   from = [e-mail]   # email address to send as if none given
   [web]
   baseurl = http://hgserver/... # root of hg web site for browsing commits

 notify config file has same format as regular hgrc. it has two sections so
 you can express subscriptions in whatever way is handier for you.

   [usersubs]
   # key is subscriber email, value is ","-separated list of glob patterns
   user@host = pattern

   [reposubs]
   # key is glob pattern, value is ","-separated list of subscriber emails
   pattern = user@host

 glob patterns are matched against path to repository root.

 if you like, you can put notify config file in repository that users can push
 changes to, they can manage their own subscriptions.
'''

from mercurial.i18n import _
from mercurial import patch, cmdutil, templater, util, mail

9104:c9c5aa12a46e

# This software may be used and distributed according to the terms of the
# GNU General Public License version 2, incorporated herein by reference.

'''hooks for sending email notifications at commit/push time

Subscriptions can be managed through a hgrc file. Default mode is to print
messages to stdout, for testing and configuring.

To use, configure the notify extension and enable it in hgrc like this:

   [extensions]
   hgext.notify =

   [hooks]

   incoming.notify = python:hgext.notify.hook
   # batch emails when many changesets incoming at one time
   changegroup.notify = python:hgext.notify.hook

   [notify]
   # config items go here

 Required configuration items:

   config = /path/to/file # file containing subscriptions

 Optional configuration items:

   test = True            # print messages to stdout for testing
   strip = 3              # number of slashes to strip for url paths
   domain = example.com   # domain to use if committer missing domain
   style = ...            # style file to use when formatting email
   template = ...         # template to use when formatting email

   [email]
   from = [e-mail]   # email address to send as if none given
   [web]
   baseurl = http://hgserver/... # root of hg web site for browsing commits

 The notify config file has same format as a regular hgrc file. It has two
 sections so you can express subscriptions in whatever way is handier for you.

   [usersubs]
   # key is subscriber email, value is ","-separated list of glob patterns
   user@host = pattern

   [reposubs]
   # key is glob pattern, value is ","-separated list of subscriber emails
   pattern = user@host

 Glob patterns are matched against path to repository root.

 If you like, you can put notify config file in repository that users can push
 changes to, they can manage their own subscriptions.
'''

from mercurial.i18n import _
from mercurial import patch, cmdutil, templater, util, mail