Changes between Version 8 and Version 9 of TracMercurial

Timestamp:

Nov 6, 2005, 3:46:34 PM (18 years ago)

Author:

Christian Boos

Comment:

Expanded the installation instructions, to match r2511

TracMercurial

@@ -37 +37 @@
 ===== Releases =====
 || '''Version''' || mercurial-plugin || Trac vc-refactoring ||
-||      0.1      ||       r2491      ||        r2491        ||
+||      0.1      ||       r2491      ||        r2511        ||
 
 
@@ -50 +50 @@
 == Configuration ==
 
-For general instructions about plugins, see also TracPlugins.
-
-The plugin egg can be added to the `plugins` folder of an existing environment,
-or to a brand new environment. Note that if you create a new environment, it's
-currently necessary to leave the repository directory '''empty''' during the
-`initenv` step (''this will probably be fixed soon'').
-
-Then, you need to specify which version control backend has to be used:
+The configuration has to be done on the Trac side, 
+there's nothing to do on the Mercurial repository side,
+except that it should be made available locally.
+
+=== Setting up a Trac environment ===
+
+You can either reuse an existing Trac environment,
+or create a brand new one.
+
+For general instructions, see TracInstall.
+
+The TracAdmin `initenv` command has been slightly modified
+in the vc-refactoring code base: in addition to the 
+''repository directory'', it's also needed to specify the
+''repository type''.
+
+For the ''repository type'', specify `hg` instead of the default `svn`.
+For the ''repository directory'', specify the location of the Mercurial repository.
+
+In all case, you [wiki:TracIni <trac_environment>/conf/trac.ini] configuration file
+should have a `[trac]` section similar to the following:
 {{{
 [trac]
@@ -63 +76 @@
 repository_dir = /path/to/my/hg/repository
 }}}
-''Note: those installing from 0.9 + the patch on #1847 still have to specify `repository_dir=hg:/path/to/my/hg/repository`''
-
-Also, you'll need to explicitely disable the SVN components:
+
+''Note: those installing from 0.9 + the patch on #1847 will still have to specify `repository_dir=hg:/path/to/my/hg/repository`''
+
+Also, currently you still need to explicitely disable the SVN components:
 {{{
 [components]
@@ -73 +87 @@
 ''Note: that constraint will most certainly be lifted in the future''
 
-Finally, if you installed the egg by doing a `python setup.py install`,
-there's the additional constraint of specifically ''enabling'' the plugin:
+=== Setting up the mercurial plugin ===
+
+The TracMercurial-0.1 plugin egg should be added to the `plugins` folder of the 
+environment.
+
+For general instructions about plugins, see also TracPlugins.
+
+Finally, if you installed an unpacked egg by doing a `python setup.py install`
+(useful for development), there's the additional constraint of specifically 
+''enabling'' the plugin:
 {{{
 [components]