##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

notify: cleanup module docstring
Martin Geisler -
r9104:c9c5aa12 default
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -7,10 +7,10 b''
7
7
8 '''hooks for sending email notifications at commit/push time
8 '''hooks for sending email notifications at commit/push time
9
9
10 Subscriptions can be managed through hgrc. Default mode is to print messages
10 Subscriptions can be managed through a hgrc file. Default mode is to print
11 to stdout, for testing and configuring.
11 messages to stdout, for testing and configuring.
12
12
13 To use, configure notify extension and enable in hgrc like this:
13 To use, configure the notify extension and enable it in hgrc like this:
14
14
15 [extensions]
15 [extensions]
16 hgext.notify =
16 hgext.notify =
@@ -22,14 +22,14 b' To use, configure notify extension and e'
22 changegroup.notify = python:hgext.notify.hook
22 changegroup.notify = python:hgext.notify.hook
23
23
24 [notify]
24 [notify]
25 # config items go in here
25 # config items go here
26
26
27 config items:
27 Required configuration items:
28
28
29 REQUIRED:
30 config = /path/to/file # file containing subscriptions
29 config = /path/to/file # file containing subscriptions
31
30
32 OPTIONAL:
31 Optional configuration items:
32
33 test = True # print messages to stdout for testing
33 test = True # print messages to stdout for testing
34 strip = 3 # number of slashes to strip for url paths
34 strip = 3 # number of slashes to strip for url paths
35 domain = example.com # domain to use if committer missing domain
35 domain = example.com # domain to use if committer missing domain
@@ -47,8 +47,8 b' To use, configure notify extension and e'
47 [web]
47 [web]
48 baseurl = http://hgserver/... # root of hg web site for browsing commits
48 baseurl = http://hgserver/... # root of hg web site for browsing commits
49
49
50 notify config file has same format as regular hgrc. it has two sections so
50 The notify config file has same format as a regular hgrc file. It has two
51 you can express subscriptions in whatever way is handier for you.
51 sections so you can express subscriptions in whatever way is handier for you.
52
52
53 [usersubs]
53 [usersubs]
54 # key is subscriber email, value is ","-separated list of glob patterns
54 # key is subscriber email, value is ","-separated list of glob patterns
@@ -58,9 +58,9 b' To use, configure notify extension and e'
58 # key is glob pattern, value is ","-separated list of subscriber emails
58 # key is glob pattern, value is ","-separated list of subscriber emails
59 pattern = user@host
59 pattern = user@host
60
60
61 glob patterns are matched against path to repository root.
61 Glob patterns are matched against path to repository root.
62
62
63 if you like, you can put notify config file in repository that users can push
63 If you like, you can put notify config file in repository that users can push
64 changes to, they can manage their own subscriptions.
64 changes to, they can manage their own subscriptions.
65 '''
65 '''
66
66
Show file before | Show file after | Hide comments
@@ -1,9 +1,9 b''
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 =
@@ -15,14 +15,14 b' To use, configure notify extension and e'
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
@@ -40,8 +40,8 b' To use, configure notify extension and e'
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
@@ -51,9 +51,9 b' To use, configure notify extension and e'
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
General Comments 0
You need to be logged in to leave comments. Login now