Mercurial: hgext/bugzilla.py comparison

comparison hgext/bugzilla.py @ 13841:367805c848e5

bugzilla: markup literal text as such

author	Martin Geisler <mg@aragost.com>
date	Fri, 01 Apr 2011 12:27:12 +0200
parents	22f20d0fe2d3
children	4cffce61bd92

comparison

equal deleted inserted replaced

-:80664e245f84
+:367805c848e5
 2.18         MySQL access, Bugzilla 2.18 and up to but not including 3.0.
 2.16         MySQL access, Bugzilla 2.16 and up to but not including 2.18.
 bugzilla.regexp
 Regular expression to match bug IDs in changeset commit message.
-Must contain one "()" group. The default expression matches 'Bug
+Must contain one "()" group. The default expression matches ``Bug
-1234', 'Bug no. 1234', 'Bug number 1234', 'Bugs 1234,5678', 'Bug
+1234``, ``Bug no. 1234``, ``Bug number 1234``, ``Bugs 1234,5678``,
-1234 and 5678' and variations thereof. Matching is case insensitive.
+``Bug 1234 and 5678`` and variations thereof. Matching is case
+insensitive.
 bugzilla.style
 The style file to use when formatting comments.
 bugzilla.template
 Default 'changeset {node|short} in repo {root} refers '
 'to bug {bug}.\\ndetails:\\n\\t{desc|tabindent}'
 bugzilla.strip
-The number of path separator characters to strip from the front of the
+The number of path separator characters to strip from the front of
-Mercurial repository path ('{root}' in templates) to produce '{webroot}'.
+the Mercurial repository path (``{root}`` in templates) to produce
-For example, a repository with '{root}' '/var/local/my-project' with a
+``{webroot}``. For example, a repository with ``{root}``
-strip of 2 gives a value for '{webroot}' of 'my-project'. Default 0.
+``/var/local/my-project`` with a strip of 2 gives a value for
+``{webroot}`` of ``my-project``. Default 0.
 web.baseurl
 Base URL for browsing Mercurial repositories. Referenced from
 templates as {hgweb}.
 XMLRPC access mode configuration:
 bugzilla.bzurl
 The base URL for the Bugzilla installation.
-Default 'http://localhost/bugzilla'.
+Default ``http://localhost/bugzilla``.
 bugzilla.user
-The username to use to log into Bugzilla via XMLRPC. Default 'bugs'.
+The username to use to log into Bugzilla via XMLRPC. Default
+``bugs``.
 bugzilla.password
 The password for Bugzilla login.
 XMLRPC+email access mode uses the XMLRPC access mode configuration items,
 MySQL access mode configuration:
 bugzilla.host
 Hostname of the MySQL server holding the Bugzilla database.
-Default 'localhost'.
+Default ``localhost``.
 bugzilla.db
-Name of the Bugzilla database in MySQL. Default 'bugs'.
+Name of the Bugzilla database in MySQL. Default ``bugs``.
 bugzilla.user
-Username to use to access MySQL server. Default 'bugs'.
+Username to use to access MySQL server. Default ``bugs``.
 bugzilla.password
 Password to use to access MySQL server.
 bugzilla.timeout
 Fallback Bugzilla user name to record comments with, if changeset
 committer cannot be found as a Bugzilla user.
 bugzilla.bzdir
 Bugzilla install directory. Used by default notify. Default
-'/var/www/html/bugzilla'.
+``/var/www/html/bugzilla``.
 bugzilla.notify
 The command to run to get Bugzilla to send bug change notification
-emails. Substitutes from a map with 3 keys, 'bzdir', 'id' (bug id)
+emails. Substitutes from a map with 3 keys, ``bzdir``, ``id`` (bug
-and 'user' (committer bugzilla email). Default depends on version;
+id) and ``user`` (committer bugzilla email). Default depends on
-from 2.18 it is "cd %(bzdir)s && perl -T contrib/sendbugmail.pl
+version; from 2.18 it is "cd %(bzdir)s && perl -T
-%(id)s %(user)s".
+contrib/sendbugmail.pl %(id)s %(user)s".
 Activating the extension::
 [extensions]
 bugzilla =
 incoming.bugzilla = python:hgext.bugzilla.hook
 Example configurations:
 XMLRPC example configuration. This uses the Bugzilla at
-'http://my-project.org/bugzilla', logging in as user 'bugmail@my-project.org'
+``http://my-project.org/bugzilla``, logging in as user
-wityh password 'plugh'. It is used with a collection of Mercurial
+``bugmail@my-project.org`` with password ``plugh``. It is used with a
-repositories in '/var/local/hg/repos/'. ::
+collection of Mercurial repositories in ``/var/local/hg/repos/``. ::
 [bugzilla]
 bzurl=http://my-project.org/bugzilla
 user=bugmail@my-project.org
 password=plugh
 [web]
 baseurl=http://my-project.org/hg
 XMLRPC+email example configuration. This uses the Bugzilla at
-'http://my-project.org/bugzilla', logging in as user 'bugmail@my-project.org'
+``http://my-project.org/bugzilla``, logging in as user
-wityh password 'plugh'. It is used with a collection of Mercurial
+``bugmail@my-project.org`` wityh password ``plugh``. It is used with a
-repositories in '/var/local/hg/repos/'. Bug comments are sent to the
+collection of Mercurial repositories in ``/var/local/hg/repos/``. Bug
-Bugzilla email address 'buzilla@my-project.org'. ::
+comments are sent to the Bugzilla email address
+``buzilla@my-project.org``. ::
 [bugzilla]
 user=bugmail@my-project.org
 password=plugh
 version=xmlrpc
 [web]
 baseurl=https://dev.laicatc.com/hg
 bugzillaurl=https://dev.laicatc.com/bugzilla
 MySQL example configuration. This is for a collection of Mercurial
-repositories in '/var/local/hg/repos/' used with a local Bugzilla 3.2
+repositories in ``/var/local/hg/repos/`` used with a local Bugzilla
-installation in /opt/bugzilla-3.2. The MySQL database is on 'localhost',
+3.2 installation in /opt/bugzilla-3.2. The MySQL database is on
-the Bugzilla database name is 'bugs' and MySQL is accessed with MySQL
+``localhost``, the Bugzilla database name is ``bugs`` and MySQL is
-username 'bugs' password 'XYZZY'. ::
+accessed with MySQL username ``bugs`` password ``XYZZY``. ::
 [bugzilla]
 host=localhost
 password=XYZZY
 version=3.0

Mercurial > hg

comparison hgext/bugzilla.py @ 13841:367805c848e5