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