hare

commit 44a36fef405a2707e73358f16d8f54bd097bbf4e
parent a98e6e7415a660a10ec2bdcfdf3536793940bb6e
Author: Drew DeVault <sir@cmpwn.com>
Date:   Sun,  2 Jan 2022 20:10:24 +0100

io::file: update docs

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
M
io/+freebsd/file.ha
 | 
11
++++++-----
M
io/+linux/file.ha
 | 
11
++++++-----

2 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/io/+freebsd/file.ha b/io/+freebsd/file.ha
@@ -2,11 +2,12 @@ use errors;
 use rt;
 use strings;
 
-// This is an opaque type which encloses an OS-level file handle resource (on
-// Unix, a file descriptor, or "fd") within a stream. It can be used as an
-// [[stream]] in most situations, but there are some APIs which require an
-// [[file]] with some OS-level handle backing it - this type is used for such
-// APIs.
+// This is an opaque type which encloses an OS-level file handle resource. It
+// can be used as an [[stream]] in most situations, but there are some APIs
+// which require an [[file]] with some OS-level handle backing it - this type is
+// used for such APIs.
+//
+// On Linux, [[io::file]] is a file descriptor.
 export type file = int;
 
 // Opens a Unix file descriptor as a file. This is a low-level interface, to
diff --git a/io/+linux/file.ha b/io/+linux/file.ha
@@ -2,11 +2,12 @@ use errors;
 use rt;
 use strings;
 
-// This is an opaque type which encloses an OS-level file handle resource (on
-// Unix, a file descriptor, or "fd") within a stream. It can be used as an
-// [[stream]] in most situations, but there are some APIs which require an
-// [[file]] with some OS-level handle backing it - this type is used for such
-// APIs.
+// This is an opaque type which encloses an OS-level file handle resource. It
+// can be used as an [[stream]] in most situations, but there are some APIs
+// which require an [[file]] with some OS-level handle backing it - this type is
+// used for such APIs.
+//
+// On Linux, [[io::file]] is a file descriptor.
 export type file = int;
 
 // Opens a Unix file descriptor as a file. This is a low-level interface, to