From: Zach OKeefe <zokeefe@google.com>
To: Alejandro Colomar <alx.manpages@gmail.com>,
Michael Kerrisk <mtk.manpages@gmail.com>
Cc: Yang Shi <shy828301@gmail.com>,
linux-mm@kvack.org, linux-man@vger.kernel.org,
"Zach O'Keefe" <zokeefe@google.com>
Subject: [PATCH man-pages v2 2/4] madvise.2: document reliable probe for advice support
Date: Tue, 18 Oct 2022 16:50:49 -0700 [thread overview]
Message-ID: <20221018235051.152548-3-zokeefe@google.com> (raw)
In-Reply-To: <20221018235051.152548-1-zokeefe@google.com>
From: Zach O'Keefe <zokeefe@google.com>
EINVAL is an overloaded error code for madvise(2) and it's not clear
under what context it means "advice is not valid" vs another error.
Explicitly document that madvise(0, 0, advice) can reliably be used to
probe for kernel support for "advice", returning zero iff "advice" is
supported by the kernel.
Signed-off-by: Zach O'Keefe <zokeefe@google.com>
---
man2/madvise.2 | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/man2/madvise.2 b/man2/madvise.2
index 64f788ace..df3413cc8 100644
--- a/man2/madvise.2
+++ b/man2/madvise.2
@@ -790,6 +790,11 @@ that are not mapped, the Linux version of
ignores them and applies the call to the rest (but returns
.B ENOMEM
from the system call, as it should).
+.PP
+.IR madvise(0,\ 0,\ advice)
+will return zero iff
+.I advice
+is supported by the kernel and can be relied on to probe for support.
.\" .SH HISTORY
.\" The
.\" .BR madvise ()
--
2.38.0.413.g74048e4d9e-goog
next prev parent reply other threads:[~2022-10-18 23:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-18 23:50 [PATCH man-pages v2 0/4] Add MADV_COLLAPSE documentation Zach OKeefe
2022-10-18 23:50 ` [PATCH man-pages v2 1/4] madvise.2: update THP file/shmem documentation for +5.4 Zach OKeefe
2022-10-18 23:50 ` Zach OKeefe [this message]
2022-10-18 23:50 ` [PATCH man-pages v2 3/4] process_madvise.2: CAP_SYS_ADMIN cleanup Zach OKeefe
2022-10-19 0:11 ` Suren Baghdasaryan
2022-10-21 12:37 ` Alejandro Colomar
2022-10-21 12:41 ` Alejandro Colomar
2022-10-21 16:16 ` Zach O'Keefe
2022-10-21 16:30 ` Alejandro Colomar
2022-10-18 23:50 ` [PATCH man-pages v2 4/4] madvise.2: add documentation for MADV_COLLAPSE Zach OKeefe
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221018235051.152548-3-zokeefe@google.com \
--to=zokeefe@google.com \
--cc=alx.manpages@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mtk.manpages@gmail.com \
--cc=shy828301@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox