Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

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
This commit is contained in:
Bruce Allen 2005-01-03 09:04:53 +00:00
parent 0fd083f620
commit b070f4f515
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/hier_dir.php
View File

@ -41,13 +41,21 @@ the right directory before calling <a href=tools_work.php>create_work()</a>.
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!]
<p>
Secondly, your validator and assimilator should call