doc: document a portability issue with macOS getrusage.

* doc/posix-functions/getrusage.texi: Document that the 'ru_maxrss'
field of 'struct rusage' is measured in bytes on macOS.

diff --git a/ChangeLog b/ChangeLog
index 7b4a86c977f258a8fd954908d4ab7a1d4ba3de72..2444097d60ff43c88916bc783a714b7a4a8d9052 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2026-01-22  Collin Funk  <collin.funk1@gmail.com>
+
+       doc: document a portability issue with macOS getrusage.
+       * doc/posix-functions/getrusage.texi: Document that the 'ru_maxrss'
+       field of 'struct rusage' is measured in bytes on macOS.
+
 2026-01-20  Bruno Haible  <bruno@clisp.org>
 
        vasnprintf: Optimize when 'long double' is the same as 'double'.

diff --git a/doc/posix-functions/getrusage.texi b/doc/posix-functions/getrusage.texi
index 8993a77fa16de99e98b65c423586ee496c3828a4..18c1c4773416bbf5902c6bac3b5bacae53224f19 100644 (file)
--- a/doc/posix-functions/getrusage.texi
+++ b/doc/posix-functions/getrusage.texi
@@ -19,4 +19,8 @@ Portability problems not fixed by Gnulib:
 @item
 Many platforms don't fill in all the fields of @code{struct rusage} with
 meaningful values.
+@item
+Some platforms fill the @code{ru_maxrss} field of @code{struct rusage}
+with the maximum resident set size in bytes instead of kilobytes:
+macOS 26.
 @end itemize