summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMichael J. Spencer <bigcheesegs@gmail.com>2011-12-12 06:04:01 +0000
committerMichael J. Spencer <bigcheesegs@gmail.com>2011-12-12 06:04:01 +0000
commitc3b00e80400d27d5d6152374d87c0ad5866c780c (patch)
tree3adf92cdfd9478aae132d0d0d2ab5f25b57a79ed /include
parent1dd2ee7bf4d848e368829cb01033f297afb674ab (diff)
downloadllvm-c3b00e80400d27d5d6152374d87c0ad5866c780c.tar.gz
llvm-c3b00e80400d27d5d6152374d87c0ad5866c780c.tar.bz2
llvm-c3b00e80400d27d5d6152374d87c0ad5866c780c.tar.xz
Support/FileSystem: Implement canonicalize.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@146363 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r--include/llvm/Support/FileSystem.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/llvm/Support/FileSystem.h b/include/llvm/Support/FileSystem.h
index 42e61dcba7..6db4554aea 100644
--- a/include/llvm/Support/FileSystem.h
+++ b/include/llvm/Support/FileSystem.h
@@ -370,8 +370,12 @@ error_code unique_file(const Twine &model, int &result_fd,
/// @brief Canonicalize path.
///
-/// Sets result to the file system's idea of what path is. The result is always
-/// absolute and has the same capitalization as the file system.
+/// Sets result to the file system's idea of what path is. Path must be
+/// absolute. The result has the same case as the file system.
+///
+/// Example: Give a file system with "C:\a\b\c\file.txt".
+///
+/// C:\A\b\C\fIlE.TxT => C:\a\b\c\file.txt
///
/// @param path Input path.
/// @param result Set to the canonicalized version of \a path.