aboutsummaryrefslogtreecommitdiff
path: root/libbuild2
diff options
context:
space:
mode:
Diffstat (limited to 'libbuild2')
-rw-r--r--libbuild2/build/script/script.hxx17
-rw-r--r--libbuild2/script/script.hxx4
2 files changed, 14 insertions, 7 deletions
diff --git a/libbuild2/build/script/script.hxx b/libbuild2/build/script/script.hxx
index f8306e1..ec603a7 100644
--- a/libbuild2/build/script/script.hxx
+++ b/libbuild2/build/script/script.hxx
@@ -81,13 +81,20 @@ namespace build2
//
variable_map vars;
- // Temporary directory for the script run (see build2::script::
- // environment::temp_dir for details).
+ // Temporary directory for the script run.
//
// Currently this directory is removed regardless of the script
- // execution success or failure. Later, to ease the troubleshooting,
- // we may invent the build2 option suppressing the directory removal
- // on failure.
+ // execution success or failure. Later, to help with troubleshooting,
+ // we may invent an option that suppresses the removal of temporary
+ // files in general.
+ //
+ // This directory is available to the user via the $~ special
+ // variable. Note, however, that the following filesystem entry
+ // prefixes are reserved:
+ //
+ // stdin*
+ // stdout*
+ // stderr*
//
auto_rmdir temp_dir;
diff --git a/libbuild2/script/script.hxx b/libbuild2/script/script.hxx
index 22747a8..359bb36 100644
--- a/libbuild2/script/script.hxx
+++ b/libbuild2/script/script.hxx
@@ -363,7 +363,7 @@ namespace build2
// using the rm or mv builtins will fail the script execution. Must be
// an absolute path.
//
- const dir_path& work_dir;
+ const dir_path& work_dir; // @@ dir_path_name
const string& work_dir_name; // Directory name for diagnostics.
// If non-empty, then any attempt to remove or move a filesystem entry
@@ -371,7 +371,7 @@ namespace build2
// builtins will fail the script execution, unless the --force option is
// specified for the builtin. Must be an absolute path, unless is empty.
//
- const dir_path& sandbox_dir;
+ const dir_path& sandbox_dir; // @@ dir_path_name
const string& sandbox_dir_name; // Directory name for diagnostics.
// Used by the script running machinery to create special files in it.