From b070f4f5159d0423dda8c365d5f9d7295c21dcf0 Mon Sep 17 00:00:00 2001 From: Bruce Allen Date: Mon, 3 Jan 2005 09:04:53 +0000 Subject: [PATCH] updated docs for dir_hier_path(). Now has 6 arguments not 4. David, please proof and correct if needed. svn path=/trunk/boinc/; revision=4983 --- doc/hier_dir.php | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/hier_dir.php b/doc/hier_dir.php index c679b479d0..1229c841fe 100644 --- a/doc/hier_dir.php +++ b/doc/hier_dir.php @@ -41,13 +41,21 @@ the right directory before calling create_work(). To do this, it can use the function ".html_text(" int dir_hier_path( - const char* filename, const char* root, int fanout, char* result + const char* filename, const char* root, int fanout, bool newhash, char* result, bool make_directory_if_needed ); ")." This takes a name of the input file and the absolute path of the root of the download hierarchy (typically the download_dir element from config.xml) and returns the absolute path of the file in the hierarchy. +For new projects, newhash should be set to true. This argument may eventually +disappear: it was added to work around a poor initial choice of hashing +function for determining fanout directory names. Generally make_directory_if_needed should also be set to true: this creates a fanout directory if needed +to accomodate a particular file. + +Note: you may see this function occuring at times with the final argument +missing. In this case C++ defaults to setting make_directory_if_needed==false. +[DAVID: PLEASE CONFIRM!]

Secondly, your validator and assimilator should call