From: Bruno Haible <bruno@clisp.org>
Date: Mon, 10 Jun 2019 12:08:37 +0000 (+0200)
Subject: doc: Mention mlock2.
X-Git-Tag: v1.0~4902
X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=8d12e3c69769e06d5c156b95a2f122bb694a5195;p=gnulib.git

doc: Mention mlock2.

* doc/glibc-functions/mlock2.texi: New file.
* doc/gnulib.texi (Glibc sys/mman.h): Include it.
---

diff --git a/doc/glibc-functions/mlock2.texi b/doc/glibc-functions/mlock2.texi
new file mode 100644
index 0000000000..5a08235c5d
--- /dev/null
+++ b/doc/glibc-functions/mlock2.texi
@@ -0,0 +1,29 @@
+@node mlock2
+@subsection @code{mlock2}
+@findex mlock2
+
+Documentation:
+@itemize
+@item
+@ifinfo
+@ref{Page Lock Functions,,Functions To Lock And Unlock Pages,libc},
+@end ifinfo
+@ifnotinfo
+@url{https://www.gnu.org/software/libc/manual/html_node/Page-Lock-Functions.html},
+@end ifnotinfo
+@item
+@uref{https://www.kernel.org/doc/man-pages/online/pages/man2/mlock2.2.html,,man mlock2}.
+@end itemize
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
+@itemize
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
+@item
+This function is missing on all non-glibc platforms:
+glibc 2.26, Mac OS X 10.5, FreeBSD 12.0, NetBSD 5.0, OpenBSD 3.8, Minix 3.1.8, AIX 7.1, HP-UX 11.31, IRIX 6.5, OSF/1 5.1, Solaris 11.4, Cygwin, mingw, MSVC 14, Interix 3.5, BeOS, Android 9.0.
+@end itemize
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index 3f3fac3767..0795917175 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -5842,6 +5842,7 @@ This list of functions is sorted according to the header that declares them.
 * madvise::
 * memfd_create::
 * mincore::
+* mlock2::
 * mremap::
 * remap_file_pages::
 @end menu
@@ -5849,6 +5850,7 @@ This list of functions is sorted according to the header that declares them.
 @include glibc-functions/madvise.texi
 @include glibc-functions/memfd_create.texi
 @include glibc-functions/mincore.texi
+@include glibc-functions/mlock2.texi
 @include glibc-functions/mremap.texi
 @include glibc-functions/remap_file_pages.texi