From 34d71e225f98dcef3e4cf8d895df4a8a31c5f9c9 Mon Sep 17 00:00:00 2001 From: Chris Filo Gorgolewski Date: Wed, 12 Jan 2011 16:39:25 +0000 Subject: [PATCH] Updated config documentation. --- doc/users/config_file.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/doc/users/config_file.rst b/doc/users/config_file.rst index bd6937c5d1..b6e8f5f9dc 100644 --- a/doc/users/config_file.rst +++ b/doc/users/config_file.rst @@ -13,7 +13,16 @@ Logging How detailed the logs regarding workflow should be (possible values: ``INFO`` and ``DEBUG``; default value: ``INFO``) *filemanip_level* - How detailed the logs regarding file operations (for example overwiting warning) should be (possible values: ``INFO`` and ``DEBUG``; default value: ``INFO``) + How detailed the logs regarding file operations (for example overwriting warning) should be (possible values: ``INFO`` and ``DEBUG``; default value: ``INFO``) + +*interface_level* + How detailed the logs regarding interface execution should be (possible values: ``INFO`` and ``DEBUG``; default value: ``INFO``) +*log_directory* + Where to store logs. (string, default value: home directory) +*log_size* + Size of a single log file. (integer, default value: 254000) +*log_rotate* + How many rotation should the log file make. (integer, default value: 4) Execution ~~~~~~~~~~~ @@ -23,12 +32,15 @@ Execution *hash_method* Should the input files be checked for changes using their content (slow, but 100% accurate) or just their size and modification date (fast, but potentially prone to errors)? (possible values: ``content`` and ``timestamp``; default value: ``content``) *single_thread_matlab* - Should all of the matlab interfaces (including SPM) use only one thread? This is useful if you are parallelizing your workflow using IPython on a single multicore machine. (possible values: ``true`` and ``false``; default value: ``true``) + Should all of the Matlab interfaces (including SPM) use only one thread? This is useful if you are parallelizing your workflow using IPython on a single multicore machine. (possible values: ``true`` and ``false``; default value: ``true``) *run_in_series* Should workflows be executed in series or parallel? (possible values: ``true`` and ``false``; default value: ``false``) *display_variable* What ``DISPLAY`` variable should all command line interfaces be run with. This is useful if you are using `xnest `_ or `Xvfb `_ and you would like to redirect all spawned windows to it. (possible values: any X server address; default value: not set) - +*use_relative_paths* + Should the paths stored in results (and used to look for inputs) be relative or absolute. Relative paths allow moving the whole working directory around but may cause problems with simlinks. (possible values: ``true`` and ``false``; default value: ``false``) +*remove_node_directories* + Removes directories whose outputs have already been used up. Doesn't work with IdentiInterface or any node that patches data through (without copying) (possible values: ``true`` and ``false``; default value: ``false``) Example ~~~~~~~