summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDouglas Gregor <dgregor@apple.com>2011-09-14 23:21:47 +0000
committerDouglas Gregor <dgregor@apple.com>2011-09-14 23:21:47 +0000
commitd26d6b68dd5ad6cea00331182d70432e4bac3393 (patch)
tree58d823ef59c45600f65b0c4f3b95da57740707c7 /include
parent0b69247b10ddbce5f0c476c3471918ffc6091ac5 (diff)
downloadllvm-d26d6b68dd5ad6cea00331182d70432e4bac3393.tar.gz
llvm-d26d6b68dd5ad6cea00331182d70432e4bac3393.tar.bz2
llvm-d26d6b68dd5ad6cea00331182d70432e4bac3393.tar.xz
Update the comment for system_temp_directory() to indicate when it
will ignore the erasedOnReboot option, and properly escape the backslash in "C:\TEMP". Thanks to Aaron and Francois. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@139755 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r--include/llvm/Support/PathV2.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/llvm/Support/PathV2.h b/include/llvm/Support/PathV2.h
index 8dfbd77840..6d38c95715 100644
--- a/include/llvm/Support/PathV2.h
+++ b/include/llvm/Support/PathV2.h
@@ -268,7 +268,10 @@ bool is_separator(char value);
/// "/var/tmp" or "C:/TEMP"
///
/// @param erasedOnReboot Whether to favor a path that is erased on reboot
-/// rather than one that potentially persists longer.
+/// rather than one that potentially persists longer. This parameter will be
+/// ignored if the user or system has set the typical environment variable
+/// (e.g., TEMP on Windows, TMPDIR on *nix) to specify a temporary directory.
+///
/// @param Result Holds the resulting path name.
void system_temp_directory(bool erasedOnReboot, SmallVectorImpl<char> &result);