##// END OF EJS Templates
bugzilla: word-wrap help texts at 70 characters
Martin Geisler -
r7985:0edca606 default
parent child Browse files
Show More
@@ -8,69 +8,76 b''
8 '''Bugzilla integration
8 '''Bugzilla integration
9
9
10 This hook extension adds comments on bugs in Bugzilla when changesets
10 This hook extension adds comments on bugs in Bugzilla when changesets
11 that refer to bugs by Bugzilla ID are seen. The hook does not change bug
11 that refer to bugs by Bugzilla ID are seen. The hook does not change
12 status.
12 bug status.
13
13
14 The hook updates the Bugzilla database directly. Only Bugzilla installations
14 The hook updates the Bugzilla database directly. Only Bugzilla
15 using MySQL are supported.
15 installations using MySQL are supported.
16
16
17 The hook relies on a Bugzilla script to send bug change notification emails.
17 The hook relies on a Bugzilla script to send bug change notification
18 That script changes between Bugzilla versions; the 'processmail' script used
18 emails. That script changes between Bugzilla versions; the
19 prior to 2.18 is replaced in 2.18 and subsequent versions by
19 'processmail' script used prior to 2.18 is replaced in 2.18 and
20 'config/sendbugmail.pl'. Note that these will be run by Mercurial as the user
20 subsequent versions by 'config/sendbugmail.pl'. Note that these will
21 pushing the change; you will need to ensure the Bugzilla install file
21 be run by Mercurial as the user pushing the change; you will need to
22 permissions are set appropriately.
22 ensure the Bugzilla install file permissions are set appropriately.
23
23
24 Configuring the extension:
24 Configuring the extension:
25
25
26 [bugzilla]
26 [bugzilla]
27 host Hostname of the MySQL server holding the Bugzilla database.
27
28 host Hostname of the MySQL server holding the Bugzilla
29 database.
28 db Name of the Bugzilla database in MySQL. Default 'bugs'.
30 db Name of the Bugzilla database in MySQL. Default 'bugs'.
29 user Username to use to access MySQL server. Default 'bugs'.
31 user Username to use to access MySQL server. Default 'bugs'.
30 password Password to use to access MySQL server.
32 password Password to use to access MySQL server.
31 timeout Database connection timeout (seconds). Default 5.
33 timeout Database connection timeout (seconds). Default 5.
32 version Bugzilla version. Specify '3.0' for Bugzilla versions 3.0 and
34 version Bugzilla version. Specify '3.0' for Bugzilla versions
33 later, '2.18' for Bugzilla versions from 2.18 and '2.16' for
35 3.0 and later, '2.18' for Bugzilla versions from 2.18
34 versions prior to 2.18.
36 and '2.16' for versions prior to 2.18.
35 bzuser Fallback Bugzilla user name to record comments with, if
37 bzuser Fallback Bugzilla user name to record comments with, if
36 changeset committer cannot be found as a Bugzilla user.
38 changeset committer cannot be found as a Bugzilla user.
37 bzdir Bugzilla install directory. Used by default notify.
39 bzdir Bugzilla install directory. Used by default notify.
38 Default '/var/www/html/bugzilla'.
40 Default '/var/www/html/bugzilla'.
39 notify The command to run to get Bugzilla to send bug change
41 notify The command to run to get Bugzilla to send bug change
40 notification emails. Substitutes from a map with 3 keys,
42 notification emails. Substitutes from a map with 3
41 'bzdir', 'id' (bug id) and 'user' (committer bugzilla email).
43 keys, 'bzdir', 'id' (bug id) and 'user' (committer
42 Default depends on version; from 2.18 it is
44 bugzilla email). Default depends on version; from 2.18
43 "cd %(bzdir)s && perl -T contrib/sendbugmail.pl %(id)s %(user)s".
45 it is "cd %(bzdir)s && perl -T contrib/sendbugmail.pl
44 regexp Regular expression to match bug IDs in changeset commit message.
46 %(id)s %(user)s".
45 Must contain one "()" group. The default expression matches
47 regexp Regular expression to match bug IDs in changeset commit
46 'Bug 1234', 'Bug no. 1234', 'Bug number 1234',
48 message. Must contain one "()" group. The default
47 'Bugs 1234,5678', 'Bug 1234 and 5678' and variations thereof.
49 expression matches 'Bug 1234', 'Bug no. 1234', 'Bug
48 Matching is case insensitive.
50 number 1234', 'Bugs 1234,5678', 'Bug 1234 and 5678' and
51 variations thereof. Matching is case insensitive.
49 style The style file to use when formatting comments.
52 style The style file to use when formatting comments.
50 template Template to use when formatting comments. Overrides
53 template Template to use when formatting comments. Overrides
51 style if specified. In addition to the usual Mercurial
54 style if specified. In addition to the usual Mercurial
52 keywords, the extension specifies:
55 keywords, the extension specifies:
53 {bug} The Bugzilla bug ID.
56 {bug} The Bugzilla bug ID.
54 {root} The full pathname of the Mercurial repository.
57 {root} The full pathname of the Mercurial
55 {webroot} Stripped pathname of the Mercurial repository.
58 repository.
56 {hgweb} Base URL for browsing Mercurial repositories.
59 {webroot} Stripped pathname of the Mercurial
60 repository.
61 {hgweb} Base URL for browsing Mercurial
62 repositories.
57 Default 'changeset {node|short} in repo {root} refers '
63 Default 'changeset {node|short} in repo {root} refers '
58 'to bug {bug}.\\ndetails:\\n\\t{desc|tabindent}'
64 'to bug {bug}.\\ndetails:\\n\\t{desc|tabindent}'
59 strip The number of slashes to strip from the front of {root}
65 strip The number of slashes to strip from the front of {root}
60 to produce {webroot}. Default 0.
66 to produce {webroot}. Default 0.
61 usermap Path of file containing Mercurial committer ID to Bugzilla user
67 usermap Path of file containing Mercurial committer ID to
62 ID mappings. If specified, the file should contain one mapping
68 Bugzilla user ID mappings. If specified, the file
63 per line, "committer"="Bugzilla user". See also the
69 should contain one mapping per line,
64 [usermap] section.
70 "committer"="Bugzilla user". See also the [usermap]
71 section.
65
72
66 [usermap]
73 [usermap]
67 Any entries in this section specify mappings of Mercurial committer ID
74 Any entries in this section specify mappings of Mercurial
68 to Bugzilla user ID. See also [bugzilla].usermap.
75 committer ID to Bugzilla user ID. See also [bugzilla].usermap.
69 "committer"="Bugzilla user"
76 "committer"="Bugzilla user"
70
77
71 [web]
78 [web]
72 baseurl Base URL for browsing Mercurial repositories. Reference from
79 baseurl Base URL for browsing Mercurial repositories. Reference
73 templates as {hgweb}.
80 from templates as {hgweb}.
74
81
75 Activating the extension:
82 Activating the extension:
76
83
@@ -83,9 +90,9 b' Activating the extension:'
83
90
84 Example configuration:
91 Example configuration:
85
92
86 This example configuration is for a collection of Mercurial repositories
93 This example configuration is for a collection of Mercurial
87 in /var/local/hg/repos/ used with a local Bugzilla 3.2 installation in
94 repositories in /var/local/hg/repos/ used with a local Bugzilla 3.2
88 /opt/bugzilla-3.2.
95 installation in /opt/bugzilla-3.2.
89
96
90 [bugzilla]
97 [bugzilla]
91 host=localhost
98 host=localhost
General Comments 0
You need to be logged in to leave comments. Login now