From: Yury Khrustalev <yury.khrustalev@arm.com>
Date: Tue, 27 May 2025 10:10:12 +0000 (+0100)
Subject: manual: mention PKEY_UNRESTRICTED macro in the manual
X-Git-Tag: glibc-2.42~197
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ea30c6703055ea2ef4584c32df8d30a41b945bdf;p=thirdparty%2Fglibc.git

manual: mention PKEY_UNRESTRICTED macro in the manual

Also use this macro in one of the examples.

Reviewed-by: Florian Weimer <fweimer@redhat.com>
---

diff --git a/manual/memory.texi b/manual/memory.texi
index 9a29c7d133..46f76c17ca 100644
--- a/manual/memory.texi
+++ b/manual/memory.texi
@@ -3139,7 +3139,7 @@ used to temporarily acquire access to the memory region and relinquish
 it again:
 
 @smallexample
-  if (key >= 0 && pkey_set (key, 0) < 0)
+  if (key >= 0 && pkey_set (key, PKEY_UNRESTRICTED) < 0)
     ...; /* Perform error checking (generally fatal).  */
   /* At this point, the current thread has read-write access to the
      memory region.  */
@@ -3256,9 +3256,9 @@ not @math{-1}.
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 Change the access restrictions of the current thread for memory pages with
 the protection key @var{key} to @var{access_restrictions}.  If
-@var{access_restrictions} is zero, no additional access restrictions on top of
-the page protection flags are applied.  Otherwise, @var{access_restrictions} is
-a combination of the following flags:
+@var{access_restrictions} is @code{PKEY_UNRESTRICTED} (zero), no additional
+access restrictions on top of the page protection flags are applied.  Otherwise,
+@var{access_restrictions} is a combination of the following flags:
 
 @vtable @code
 @item PKEY_DISABLE_READ