Changeset 651 in tailor for README

Timestamp:

08/20/05 23:39:45 (8 years ago)

Author:

lele@…

Hash name:

20050820213945-97f81-c05c9f4b35c436c974a8606860a382bbc31fc9e3

Message:

Detailed the options of the project and repository sections in the config

File:

• README (modified) (2 diffs)

README

@@ -284 +284 @@
     subdir = darcside
 
-The configuration may hold one or more `projects` and two or more
-`repositories`: project names do not contains colons ":",
+The configuration may hold one or more `projects`_ and two or more
+`repositories`_: project names do not contains colons ":",
 repository names must and the first part of the name before the
 colon specify the kind of the repository.  So, the above example
@@ -341 +341 @@
 
 
+Configuration sections
+----------------------
+
+Projects
+~~~~~~~~
+
+A project is identified by a section whose name does not contain any
+colon (":") character, and configured with the following values:
+
+root-directory
+  This is where all the fun will happen: this directory will contain
+  the source and the target working copy, and usually the state and
+  the log file. It support the conventional `~user` to indicate user's
+  home directory.
+
+subdir
+  This is the subdirectory, relative to the `root-directory`, where
+  tailor will extract the source working copy. It may be '.' for some
+  backend kinds.
+
+state-file
+  Name of the state file needed to store tailor last activity.
+
+source
+  The source repository: a repository name is something like
+  "darcs:somename", that will be loaded from the homonymous section
+  in the configuration.
+
+target
+  The counterpart of `source`, the repository that will receive the
+  changes coming from there.
+
+Non mandatory options:
+
+verbose
+  Print the commands as they are executed.
+
+debug
+  Print also their output.
+  
+before-commit
+  This is a function name, or a sequence of function names enclosed
+  by brackets, that will be executed on each changeset just before
+  it get replayed on the target system: this may be used to perform
+  any kind of alteration on the content of the changeset, or to skip
+  some of them.
+
+after-commit
+  This is a function name, or a sequence of function names enclosed
+  by brackets, that will be executed on each changeset just after
+  the commit on the target system: this may be used for example to
+  create a tag.
+
+subdir
+  The name of the subdirectory, under ``root-directory``, that will
+  contain the source and target repositories/working directories.
+
+
+Repositories
+~~~~~~~~~~~~
+
+All the section whose name contains at least one colon character
+denote a repository.  A single repository may be shared by zero, one or
+more projects.  The first part of the name up to the first colon
+indicates the `kind` of the repository, one of ``arx``, ``bzr``,
+``bzrng``, ``cdv``, ``cvs``, ``darcs``, ``hg``, ``monotone``, ``svn``
+and ``tla``.
+
+When a repository is used as a `source`, it must indicate its origin
+with ``repository``, and for some backends also a ``module``, but are
+not required when it's a target system, even if some backend may use
+the information to create the target repository (like ``svn`` backend
+does). 
+
+Each repository may then impose a particular external binary to be
+used, as done in the example above for ``hg``. Actually only one of
+them, `bzrng`, accepts an option ``python-path``, to indicate where
+the BazaarNG Python library is located.
+
+A repository may also have it's own ``subdir``: when the `source` and
+`target` repositories use different subdirectories, tailor uses
+``rsync`` to copy the changes between the two after each applied
+changeset.
+
+
 Using a Python script as configuration file
 -------------------------------------------