[PATCH] docs: improve issue tracker integration docs
Andrew Shadura
andrew at shadura.me
Wed Feb 25 08:06:50 EST 2015
# HG changeset patch
# User Andrew Shadura <andrew at shadura.me>
# Date 1424869587 -3600
# Wed Feb 25 14:06:27 2015 +0100
# Node ID 5b85679c832b1de3471ed3c62a555d22cbad0c33
# Parent 54ca0422017d790f16135b4da347850c68458c55
docs: improve issue tracker integration docs
diff --git a/docs/setup.rst b/docs/setup.rst
--- a/docs/setup.rst
+++ b/docs/setup.rst
@@ -448,16 +448,29 @@ uncomment following variables in the ini
issue_prefix = #
`issue_pat` is the regular expression that will fetch issues from commit messages.
-Default regex will match issues in format of #<number> eg. #300.
+Default regex matches issues in format of #<number> eg. #300.
-Matched issues will be replace with the link specified as `issue_server_link`
-{id} will be replaced with issue id, and {repo} with repository name.
-Since the # is striped `issue_prefix` is added as a prefix to url.
-`issue_prefix` can be something different than # if you pass
-ISSUE- as issue prefix this will generate an url in format::
+Matched issues are be replaced with the link specified as `issue_server_link`
+{id} is replaced with issue id, and {repo} with repository name.
+Since the # is stripped away, `issue_prefix` is added as a prefix to url.
+`issue_prefix` doesn't necessarily need to be #, so if you set issue
+prefix to ISSUE- this will generate an URL in format::
<a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>
+If needed, more than one pattern can be specified by appending a unique suffix to
+the variables. For example::
+
+ issue_pat_wiki = (?:wiki-)(.+)
+ issue_server_link_wiki = https://mywiki.com/{id}
+ issue_prefix_wiki = WIKI-
+
+From now on, wiki pages can be referenced as wiki-some-id, and every such reference
+will be transformed into::
+
+ <a href="https://mywiki.com/some-id">WIKI-some-id</a>
+
+
Hook management
---------------
More information about the kallithea-general
mailing list