diff doc/commands.txt @ 505:4caa400abe8e

This alters the `svn:checkout` command to take an extra parameter, `shared_path`, which will be used to share checkouts, preventing checking out the whole project for every revision that's tested. `shared_path` is relative to the project directory, so for standard usage set `shared_path` to something like `../trunk` Fixes #289
author dfraser
date Mon, 09 Mar 2009 13:59:57 +0000
parents 9bff10727d58
children 6a8dcbffdce2
line wrap: on
line diff
--- a/doc/commands.txt
+++ b/doc/commands.txt
@@ -734,25 +734,30 @@
 Parameters
 ----------
 
-+--------------+-------------------------------------------------------------+
-| Name         | Description                                                 |
-+==============+=============================================================+
-| ``url``      | URL of the repository.                                      |
-+--------------+-------------------------------------------------------------+
-| ``path``     | The path inside the repository that should be checked out.  |
-|              | You should normally set this to ``${path}`` so that the     |
-|              | path of the build configuration is used.                    |
-+--------------+-------------------------------------------------------------+
-| ``revision`` | The revision that should be checked out. You should         |
-|              | normally set this to ``${revision}`` so that the revision   |
-|              | of the build is used.                                       |
-+--------------+-------------------------------------------------------------+
-| ``dir``      | Path specifying which directory the sources should be       |
-|              | checked out to (defaults to '.').                           |
-+--------------+-------------------------------------------------------------+
-| ``verbose``  | Whether to log the list of checked out files (defaults to   |
-|              | False).                                                     |
-+--------------+-------------------------------------------------------------+
++-----------------+-------------------------------------------------------------+
+| Name            | Description                                                 |
++=================+=============================================================+
+| ``url``         | URL of the repository.                                      |
++-----------------+-------------------------------------------------------------+
+| ``path``        | The path inside the repository that should be checked out.  |
+|                 | You should normally set this to ``${path}`` so that the     |
+|                 | path of the build configuration is used.                    |
++-----------------+-------------------------------------------------------------+
+| ``revision``    | The revision that should be checked out. You should         |
+|                 | normally set this to ``${revision}`` so that the revision   |
+|                 | of the build is used.                                       |
++-----------------+-------------------------------------------------------------+
+| ``dir``         | Path specifying which directory the sources should be       |
+|                 | checked out to (defaults to '.').                           |
++-----------------+-------------------------------------------------------------+
+| ``verbose``     | Whether to log the list of checked out files (defaults to   |
+|                 | False).                                                     |
++-----------------+-------------------------------------------------------------+
+| ``shared_path`` | An optional shared directory to check the sources out in,   |
+|                 | which will be reused for each subsequent build. This is     |
+|                 | relative to the project directory, so for standard usage    |
+|                 | set it to something like ``../trunk``                       |
++-----------------+-------------------------------------------------------------+
 
 
 Examples
Copyright (C) 2012-2017 Edgewall Software