fs: add a note about using os.File.Fd()

Change-Id: I19d52f14f63f1481b2b1aa9dcd46c91fe4e1ad99

fs: add a note about using os.File.Fd()
Change-Id: I19d52f14f63f1481b2b1aa9dcd46c91fe4e1ad99
cb685274 · Han-Wen Nienhuys · Han-Wen Nienhuys · 625c7706 · cb685274
Commit cb685274 authored Dec 27, 2020 by Han-Wen Nienhuys Committed by Han-Wen Nienhuys Dec 27, 2020
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 1 deletion

fs/files.go fs/files.go +3 -1

No files found.
--- a/fs/files.go
+++ b/fs/files.go
@@ -17,7 +17,9 @@ import (
 )

 // NewLoopbackFile creates a FileHandle out of a file descriptor. All
-// operations are implemented.
+// operations are implemented. When using the Fd from a *os.File, call
+// syscall.Dup() on the fd, to avoid os.File's finalizer from closing
+// the file descriptor.
 func NewLoopbackFile(fd int) FileHandle {
 	return &loopbackFile{fd: fd}
 }