kallithea Changeset - 570a4e40f0bb

Changeset - 570a4e40f0bb

Parent rev.

Child rev.

[Not reviewed]

default

0 2 0

Andrew Shadura - 11 years ago 2015-02-25 14:06:27
andrew@shadura.me

docs: improve issue tracker integration docs

2 files changed with 23 insertions and 7 deletions:

docs/changelog.rst

+chmod

docs/setup.rst

0 comments (0 inline, 0 general)

docs/changelog.rst

➞

Show inline comments

modified file chmod 100755 => 100644

docs/setup.rst

➞

Show inline comments

@@ modified file chmod 100755 => 100644 @@
@@ @@ -444,23 +444,39 @@ messages and replace that with an url to @@
 uncomment following variables in the ini file::
     issue_pat = (?:^#|\s#)(\w+)
     issue_server_link = https://myissueserver.com/{repo}/issue/{id}
     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.
 `issue_pat` is the regular expression describing which strings in
 commit messages will be treated as issue references. A match group in
 parentheses should be used to specify the actual issue id.
 The default expression matches issues in the format '#<number>', e.g. '#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 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 prepended to the link text.
 `issue_prefix` doesn't necessarily need to be #: if you set issue
 prefix to ISSUE- this will generate a 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-
 With these settings, 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
 ---------------
 Hooks can be managed in similar way to this used in .hgrc files.
 To access hooks setting click `advanced setup` on Hooks section of Mercurial
 Settings in Admin.

0 comments (0 inline, 0 general)