Changeset 506 in tailor

Timestamp:

08/05/05 12:39:18 (8 years ago)

Author:

lele@…

Hash name:

20050805103918-97f81-2efd1936ea1410722dc75df4d4d3810eb23487b6

Message:

Some notes about using Python scripts for the configuration

File:

• README (modified) (1 diff)

README

@@ -264 +264 @@
           template config filled with the values specified by the
           other options. You can redirect 
+
+
+Using a Python script as configuration file
+-------------------------------------------
+
+Instead of executing ``tailor --configfile project.tailor.conf``
+you can prepend the following signature to the config itself::
+
+  #!/usr/bin/env /path/to/tailor
+
+Giving execute mode to it will permit the launch of the tailor
+process by running the config script directly::
+
+  $ ./project.tailor.conf
+
+When a config file is signed in this way [#]_, either you pass it as
+argument to ``--configfile`` or executed as above, tailor will
+actually execute it as a full fledged Python script, that may define
+functions that alter the behaviour of tailor itself.
+
+A common usage of this functionality is to define so called `hooks`,
+sequences of functions that are executed at particular points in
+the tailorization process.
+
+For example::
+
+    #!/usr/bin/env /home/lele/WiP/tailor/tailor
+    """
+    [project]
+    source = svn:repository
+    target = darcs:repository
+    before-commit = transform_crlf_to_lf
+    ...
+    """
+
+    def transform_crlf_to_lf(context, changeset):
+        for e in changeset.entries:
+            ....
+
+.. [#] Tailor does actually read just the first two bytes from the
+       file, and compare them with "#!", so you are free to choose
+       whatever syntax works in your environment.
+
 
 State file