Mercurial > hg

comparison tests/test-notify.out @ 9104:c9c5aa12a46e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
notify: cleanup module docstring
author Martin Geisler <mg@lazybytes.net>
date Thu, 09 Jul 2009 22:42:43 +0200
parents 27a41250a9ce
children 6188f2cc4a37
comparison
equal deleted inserted replaced
9103:9c7a5d70e72f 9104:c9c5aa12a46e
1 notify extension - hooks for sending email notifications at commit/push time 1 notify extension - hooks for sending email notifications at commit/push time
2 2
3 Subscriptions can be managed through hgrc. Default mode is to print messages 3 Subscriptions can be managed through a hgrc file. Default mode is to print
4 to stdout, for testing and configuring. 4 messages to stdout, for testing and configuring.
5 5
6 To use, configure notify extension and enable in hgrc like this: 6 To use, configure the notify extension and enable it in hgrc like this:
7 7
8 [extensions] 8 [extensions]
9 hgext.notify = 9 hgext.notify =
10 10
11 [hooks] 11 [hooks]
13 incoming.notify = python:hgext.notify.hook 13 incoming.notify = python:hgext.notify.hook
14 # batch emails when many changesets incoming at one time 14 # batch emails when many changesets incoming at one time
15 changegroup.notify = python:hgext.notify.hook 15 changegroup.notify = python:hgext.notify.hook
16 16
17 [notify] 17 [notify]
18 # config items go in here 18 # config items go here
19 19
20 config items: 20 Required configuration items:
21 21
22 REQUIRED:
23 config = /path/to/file # file containing subscriptions 22 config = /path/to/file # file containing subscriptions
24 23
25 OPTIONAL: 24 Optional configuration items:
25
26 test = True # print messages to stdout for testing 26 test = True # print messages to stdout for testing
27 strip = 3 # number of slashes to strip for url paths 27 strip = 3 # number of slashes to strip for url paths
28 domain = example.com # domain to use if committer missing domain 28 domain = example.com # domain to use if committer missing domain
29 style = ... # style file to use when formatting email 29 style = ... # style file to use when formatting email
30 template = ... # template to use when formatting email 30 template = ... # template to use when formatting email
38 [email] 38 [email]
39 from = user@host.com # email address to send as if none given 39 from = user@host.com # email address to send as if none given
40 [web] 40 [web]
41 baseurl = http://hgserver/... # root of hg web site for browsing commits 41 baseurl = http://hgserver/... # root of hg web site for browsing commits
42 42
43 notify config file has same format as regular hgrc. it has two sections so 43 The notify config file has same format as a regular hgrc file. It has two
44 you can express subscriptions in whatever way is handier for you. 44 sections so you can express subscriptions in whatever way is handier for you.
45 45
46 [usersubs] 46 [usersubs]
47 # key is subscriber email, value is ","-separated list of glob patterns 47 # key is subscriber email, value is ","-separated list of glob patterns
48 user@host = pattern 48 user@host = pattern
49 49
50 [reposubs] 50 [reposubs]
51 # key is glob pattern, value is ","-separated list of subscriber emails 51 # key is glob pattern, value is ","-separated list of subscriber emails
52 pattern = user@host 52 pattern = user@host
53 53
54 glob patterns are matched against path to repository root. 54 Glob patterns are matched against path to repository root.
55 55
56 if you like, you can put notify config file in repository that users can push 56 If you like, you can put notify config file in repository that users can push
57 changes to, they can manage their own subscriptions. 57 changes to, they can manage their own subscriptions.
58 58
59 no commands defined 59 no commands defined
60 % commit 60 % commit
61 adding a 61 adding a