From 9b72eeb2ea38567a8bf087cd59f0577b52e239a5 Mon Sep 17 00:00:00 2001 From: tradke Date: Wed, 16 Nov 2005 13:35:48 +0000 Subject: Clearly state that the 'IO::checkpoint_keep' parameter refers to the number of _evolution_ checkpoints to keep. git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOUtil/trunk@235 b32723a9-ab3a-4a60-88e2-2e5d99d7c17a --- doc/documentation.tex | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index 1e890aa..b5a049e 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -430,11 +430,11 @@ parameters. The most important ones are: \item {\tt IO::checkpoint\_dir}\\ names the directory where checkpoint files are stored \item {\tt IO::checkpoint\_keep} (steerable)\\ - specifies how many checkpoints should be kept\\ - The default value of $1$ means that only the latest checkpoint is kept - and older checkpoints are removed in order to save disk space. + specifies how many evolution checkpoints should be kept\\ + The default value of $1$ means that only the latest evolution checkpoint + is kept and older checkpoints are removed in order to save disk space. Setting {\tt IO::checkpoint\_keep} to a positive value will keep so many - checkpoints around. A value of $-1$ will keep all (future) checkpoints. + evolution checkpoints around. A value of $-1$ will keep all (future) checkpoints. \item {\tt IO::recover}\\ keyword parameter telling if/how to recover.\\ Choices are {\tt "no"}, {\tt "manual"}, {\tt "auto"}, and {\tt "autoprobe"}. -- cgit v1.2.3