aboutsummaryrefslogtreecommitdiff
path: root/libbuild2/build/script
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2020-05-25 14:17:19 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2020-05-27 08:38:57 +0200
commit29c59165396eb842d92367fca74c4e459ea25900 (patch)
tree35b5e8ea952847771056bbaa7af57921e89f958f /libbuild2/build/script
parentb0b048c03930b826ab3dbf88b56fd664fca26886 (diff)
Review (temp dir)
Diffstat (limited to 'libbuild2/build/script')
-rw-r--r--libbuild2/build/script/script.hxx17
1 files changed, 12 insertions, 5 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;