aboutsummaryrefslogtreecommitdiff
path: root/lib/Support/Unix
diff options
context:
space:
mode:
authorMichael J. Spencer <bigcheesegs@gmail.com>2010-12-07 01:23:08 +0000
committerMichael J. Spencer <bigcheesegs@gmail.com>2010-12-07 01:23:08 +0000
commitad8a14f24eb3daee61c8076ff6e5a8135f4dd124 (patch)
treea99975f29b2fda551aaa5cf01f294eaf17228a07 /lib/Support/Unix
parent1522fce477f3b6b1b5812aa561ad2ff3f51eb968 (diff)
Support/PathV2: Clarify and correct documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121091 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'lib/Support/Unix')
-rw-r--r--lib/Support/Unix/PathV2.inc5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/Support/Unix/PathV2.inc b/lib/Support/Unix/PathV2.inc
index f7ca64daf7..4ca482dfce 100644
--- a/lib/Support/Unix/PathV2.inc
+++ b/lib/Support/Unix/PathV2.inc
@@ -30,6 +30,11 @@
using namespace llvm;
namespace {
+ /// This class automatically closes the given file descriptor when it goes out
+ /// of scope. You can take back explicit ownership of the file descriptor by
+ /// calling take(). The destructor does not verify that close was successful.
+ /// Therefore, never allow this class to call close on a file descriptor that
+ /// has been read from or written to.
struct AutoFD {
int FileDescriptor;