diff options
author | Cameron Esfahani <dirty@apple.com> | 2015-11-06 01:45:30 +0000 |
---|---|---|
committer | Cameron Esfahani <dirty@apple.com> | 2015-11-06 01:45:30 +0000 |
commit | 8d372b9761e73455873069660491e10c289009ab (patch) | |
tree | 922b80b3a64e7a07ef672b3ea3c1f389350c94b7 /llvm/include | |
parent | 03fe45e7597c9827df938d6c7b65008956dec7be (diff) | |
download | bcm5719-llvm-8d372b9761e73455873069660491e10c289009ab.tar.gz bcm5719-llvm-8d372b9761e73455873069660491e10c289009ab.zip |
NFC: Update documentation for createUniqueFile() to explain that models without an absolute path will be created in the current directory.
llvm-svn: 252265
Diffstat (limited to 'llvm/include')
-rw-r--r-- | llvm/include/llvm/Support/FileSystem.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/llvm/include/llvm/Support/FileSystem.h b/llvm/include/llvm/Support/FileSystem.h index 84d7e85b381..4733ddb7757 100644 --- a/llvm/include/llvm/Support/FileSystem.h +++ b/llvm/include/llvm/Support/FileSystem.h @@ -546,15 +546,15 @@ std::error_code status_known(const Twine &path, bool &result); /// /// Generates a unique path suitable for a temporary file and then opens it as a /// file. The name is based on \a model with '%' replaced by a random char in -/// [0-9a-f]. If \a model is not an absolute path, a suitable temporary -/// directory will be prepended. +/// [0-9a-f]. If \a model is not an absolute path, the temporary file will be +/// created in the current directory. /// /// Example: clang-%%-%%-%%-%%-%%.s => clang-a0-b1-c2-d3-e4.s /// /// This is an atomic operation. Either the file is created and opened, or the /// file system is left untouched. /// -/// The intendend use is for files that are to be kept, possibly after +/// The intended use is for files that are to be kept, possibly after /// renaming them. For example, when running 'clang -c foo.o', the file can /// be first created as foo-abc123.o and then renamed. /// |