diff options
Diffstat (limited to 'include/llvm/Support/FileSystem.h')
| -rw-r--r-- | include/llvm/Support/FileSystem.h | 8 |
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. |