]> Savannah Git Hosting - gnulib.git/commitdiff
getpagesize: improve doc
authorPaul Eggert <eggert@cs.ucla.edu>
Fri, 14 Jun 2024 17:20:21 +0000 (10:20 -0700)
committerPaul Eggert <eggert@cs.ucla.edu>
Fri, 14 Jun 2024 20:19:01 +0000 (13:19 -0700)
* doc/glibc-functions/getpagesize.texi:
Mention portability problems not fixed by Gnulib.

ChangeLog
doc/glibc-functions/getpagesize.texi

index f44aab79f6717fdfdc48029c02c6d2c878d2771b..9d06cc7eac7fb20f52a2a62e78d2cd78d0b479a4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-06-14  Paul Eggert  <eggert@cs.ucla.edu>
+
+       getpagesize: improve doc
+       * doc/glibc-functions/getpagesize.texi:
+       Mention portability problems not fixed by Gnulib.
+
 2024-06-14  Bruno Haible  <bruno@clisp.org>
 
        vasnprintf: Reject a width > INT_MAX.
index 7b40f5e48d6312f758e7787e5ddf5b7662250d43..77df489bcef09e6a678ba99e35aa4ae9cd9a424d 100644 (file)
@@ -33,5 +33,18 @@ mingw.
 @end itemize
 
 Portability problems not fixed by Gnulib:
+
 @itemize
+@item
+The function has never been in POSIX and was removed from the Single
+UNIX Specification in SUSv3 (2001).
+Although portable programs are supposed to use @code{sysconf (_SC_PAGESIZE)}
+instead, in practice @code{getpagesize} can be a little faster.
+
+@item
+On typical platforms this function's API limits page sizes to at most 1 GiB@,
+even though @code{sysconf (_SC_PAGESIZE)} does not have this limitation.
+However, this has not been a practical problem yet,
+and so many programs use @code{getpagesize} that it's unlikely that
+new platforms would introduce larger page sizes any time soon.
 @end itemize