From: Bruno Haible <bruno@clisp.org>
Date: Sat, 3 Sep 2022 18:57:14 +0000 (+0200)
Subject: sys_file: Document this module.
X-Git-Tag: v1.0~2089
X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=4413450467fda40f599a9d4a8f9cc0d542bf3d73;p=gnulib.git

sys_file: Document this module.

* doc/glibc-headers/sys_file.texi: New file.
* doc/gnulib.texi (Glibc Header File Substitutes): Include it.
---

diff --git a/ChangeLog b/ChangeLog
index 30cf81091c..e6a48eb067 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2022-09-03  Bruno Haible  <bruno@clisp.org>
+
+	sys_file: Document this module.
+	* doc/glibc-headers/sys_file.texi: New file.
+	* doc/gnulib.texi (Glibc Header File Substitutes): Include it.
+
 2022-09-03  Bruno Haible  <bruno@clisp.org>
 
 	stdckdint: Add C++ tests.
diff --git a/doc/glibc-headers/sys_file.texi b/doc/glibc-headers/sys_file.texi
new file mode 100644
index 0000000000..42ccdf960b
--- /dev/null
+++ b/doc/glibc-headers/sys_file.texi
@@ -0,0 +1,20 @@
+@node sys/file.h
+@section @file{sys/file.h}
+
+Declares the function @code{flock}.
+
+Gnulib module: sys_file
+
+Portability problems fixed by Gnulib:
+@itemize
+@item
+This header file is missing on some platforms:
+MSVC 14.
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
+@item
+This header file does not declare the @code{flock} function on some platforms:
+AIX 7.1, HP-UX 11.23, Solaris 11.4.
+@end itemize
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index ec5891e57f..0cc25f9e88 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -3755,6 +3755,7 @@ not worked around by Gnulib.
 * pty.h::
 * resolv.h::
 * shadow.h::
+* sys/file.h::
 * sys/ioctl.h::
 * sys/random.h::
 * sysexits.h::
@@ -3792,6 +3793,7 @@ not worked around by Gnulib.
 @include glibc-headers/pty.texi
 @include glibc-headers/resolv.texi
 @include glibc-headers/shadow.texi
+@include glibc-headers/sys_file.texi
 @include glibc-headers/sys_ioctl.texi
 @include glibc-headers/sys_random.texi
 @include glibc-headers/sysexits.texi