Changes between Version 3 and Version 4 of DarcsPlugin

Timestamp:

02/12/06 00:00:09 (7 years ago)

Author:

Lele Gaifax

Comment:

Completed

DarcsPlugin

@@ -5 +5 @@
   http://artiemestieri.tn.it/~lele/projects/trac-darcs
 
-'''Beware''', it's still incomplete and wrong: first, the setuptools config is currently wrong, second, `DarcsRepository.get_changes()`, a new API, is plain wrong, and I need to figure out what it should do.
+== Installing the module as a builtin ==
 
 If you want to try it out follow these directions:
@@ -40 +40 @@
    c. $ ~/.system/bin/trac-admin initenv
 }}}
+
+== Installing an egg ==
+
+The module is `setuptools`-aware, you can follow the good directions on [http://projects.edgewall.com/trac/wiki/TracPlugins TracPlugins].
+
+=== Enabling the plugin ===
+
+The plugin, if installed as a global egg, needs to be enabled, with something like
+
+{{{
+  [components]
+  trac.versioncontrol.svn_fs.* = disabled
+  darcstrac.* = enabled
+}}}
+
+(''not sure if disabling svn is actually needed'')
+
+== Configuration ==
+
+The DarcsPlugin follows the standard TracIni options to indicate the repository, such as
+{{{
+  [trac]
+  repository_type=darcs
+  repository_dir=/path/to/darcs/repository
+}}}
+
+It uses the following settings, if provided, in the `[darcs]` section of the TracIni file.
+
+|| `cachedir` || By default the darcs backend keeps a cache of the visited files at various revision inside the repository itself, in `_darcs/trac_cache`, that may be overridden by this option, setting it to the desired directory that needs to be writeable by the trac process. ||
+|| `command` || Name of the external darcs executable, default to `darcs`. This can be used to set up the environment as well, like in "`DARCS_DONT_ESCAPE_ANYTHING=1 /usr/local/bin/darcs`" ||
+|| `dont_escape_8bit` || This is a shortcut for "`command=DARCS_DONT_ESCAPE_8BIT=1 darcs`" (true, false). Default to false. ||
+|| `encoding` || Specify the encoding to be used on this repository. This goes together with `dont_escape_8bit`, when your repository metadata contains non-ascii glyphs. ||
+