changeset 1870:941dee113136 beta

docs update
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 09 Jan 2012 04:04:58 +0200
parents 682057a38cd3
children 395a3196de73
files docs/changelog.rst docs/setup.rst
diffstat 2 files changed, 13 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/docs/changelog.rst	Mon Jan 09 04:00:44 2012 +0200
+++ b/docs/changelog.rst	Mon Jan 09 04:04:58 2012 +0200
@@ -33,8 +33,9 @@
 - implements #330 api method for listing nodes ar particular revision
 - fixed #331 RhodeCode mangles repository names if the a repository group 
   contains the "full path" to the repositories
-- #73 added linking issues in commit messages to choosen issue tracker url
+- #73 added linking issues in commit messages to chosen issue tracker url
   based on user defined regular expression
+- new compact changelog with expandable commit messages
     
 fixes
 -----
--- a/docs/setup.rst	Mon Jan 09 04:00:44 2012 +0200
+++ b/docs/setup.rst	Mon Jan 09 04:04:58 2012 +0200
@@ -434,16 +434,19 @@
 uncomment following variables in the ini file::
 
     url_pat = (?:^#|\s#)(\w+)
-    issue_server = https://myissueserver.com/issue/{id}
+    issue_server_link = https://myissueserver.com/{repo}/issue/{id}
     issue_prefix = #
 
-`url_pat` is the regular expression that will match issues, default given regex
-will match issues in format of #<number> eg. #300. 
-Matched issues will be replace with the `issue_server` url replacing {id} with
-id fetched from regex. 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 
-`<a href="https://myissueserver.com/issue/300">ISSUE-300</a>`  
+`url_pat` is the regular expression that will fetch issues from commit messages.
+Default regex will match 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::
+ 
+  <a href="https://myissueserver.com/example_repo/issue/300">ISSUE-300</a>  
 
 Hook management
 ---------------