From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 13EFCC43217 for ; Tue, 18 Oct 2022 18:31:24 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A4DFA6B0072; Tue, 18 Oct 2022 14:31:23 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 9FD168E0002; Tue, 18 Oct 2022 14:31:23 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8C5C18E0001; Tue, 18 Oct 2022 14:31:23 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 7F2896B0072 for ; Tue, 18 Oct 2022 14:31:23 -0400 (EDT) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 4893D1A086A for ; Tue, 18 Oct 2022 18:31:23 +0000 (UTC) X-FDA: 80034912846.05.7B81F98 Received: from mail-oi1-f173.google.com (mail-oi1-f173.google.com [209.85.167.173]) by imf03.hostedemail.com (Postfix) with ESMTP id D711320032 for ; Tue, 18 Oct 2022 18:31:21 +0000 (UTC) Received: by mail-oi1-f173.google.com with SMTP id n130so16542547oia.6 for ; Tue, 18 Oct 2022 11:31:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=EnP8sgGhihhh5pbXuuUK2sG9k2D16qAENqhp+CIh9HE=; b=AFOcQpSfNP6N3XORSUBvHbgkPAaQwNtJbq3oZ2rcNj6xjkXoAgjjx+3gSmzMItZq0D OlW+42vwAkwGltYJIK/D12GmyoSeEe3OhpJKMml1c7FSeRhTKR8kS3wE0K3+0fweS6Zz 1l8UIxSS4BxzhboAX1lKxaJODpn1TyMN3Y3gMPL39cMuWM7NeyK1LEMT0loaBl8ILvKb iCoKBmizhpsrPv6Qny7QXMrl8kyndCyWmesLe+DPMQcKMUeFTq1mymkN/E57Yww6sOkR c/WCAWZISBoUkl7qPWl1G2eMbJDzfIXMtMV56MaSlisoAocLEMnQNPDcSJow5O9SUvbM /ffg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=EnP8sgGhihhh5pbXuuUK2sG9k2D16qAENqhp+CIh9HE=; b=ST/LgTk61MRWu0ivO+9ODgRyS4twq1QTo1sYLCQWYPiA12eLJ9N967IH/tz1U3ZQbh UQuMNWLZX+F8fOalPGPhwgSrzKAHDIABeB780sTaLcMGgo+fSQBkZ8LbWPARr2JqBT2m MCQ42R4q9Jl2Vm06JHR+EXLJ9OgQOq/8Xm7wipSE3bCxF+vsqMwmXX5DH5KY+zi6bTa4 3VpZPSuI5FxX/4nlaG4bk+uuGCQvWDDhd2GTjYTpz1776OhW6XCOijzmwhNKN7WeNUl9 5726FKetejKSo6y7i4+hN7jV/f/YBV6PH1zffAHuisoUWwW/WqRqOZd0uHniT8fFfnRy KaDw== X-Gm-Message-State: ACrzQf0H9As+69oNtVwCn3I73kad15LClzfHu0Zb4nP28XWN8iU13oE4 VHRfR6GqysEudnAkJaTGKafUfjlJFwiYbYLUrqzVbA== X-Google-Smtp-Source: AMsMyM5+40jotf53m5cZQRUwf/hLr9NInDdhVdN7owL/JDYj0ah9yrixM5AtJyvtvRoAhjlZJxKaHcnjXOePLaT4t3w= X-Received: by 2002:a05:6808:f12:b0:354:b4c6:b4a3 with SMTP id m18-20020a0568080f1200b00354b4c6b4a3mr2070234oiw.123.1666117880895; Tue, 18 Oct 2022 11:31:20 -0700 (PDT) MIME-Version: 1.0 References: <20221017175523.2048887-1-zokeefe@google.com> <20221017175523.2048887-3-zokeefe@google.com> <2de9de5f-c82d-f2ce-26e3-b9fabd88a08c@gmail.com> <30f2b019-1dbd-dbb8-e6f5-a1c2c9f3a979@gmail.com> In-Reply-To: <30f2b019-1dbd-dbb8-e6f5-a1c2c9f3a979@gmail.com> From: "Zach O'Keefe" Date: Tue, 18 Oct 2022 11:30:45 -0700 Message-ID: Subject: Re: [PATCH man-pages 2/4] madvise.2: document reliable probe for advice support To: Alejandro Colomar Cc: Michael Kerrisk , Yang Shi , linux-mm@kvack.org, linux-man@vger.kernel.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1666117881; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=EnP8sgGhihhh5pbXuuUK2sG9k2D16qAENqhp+CIh9HE=; b=ZNXcYQj/G3nFmjFSNdlVV8uooL9nCU1kbSunAkyTcOFvdiX3vAA3JWLip+/ucP7brJeOX5 Wc9eVq0DggW9wzGn1Q9k8OfCDYolOV0nCbFkQR2suKR59UL/7Pla1JzS9z4MGNgL7d8PRs js5Hrnb8aRJdawA/cR9Y8IrfldP07gI= ARC-Authentication-Results: i=1; imf03.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=AFOcQpSf; spf=pass (imf03.hostedemail.com: domain of zokeefe@google.com designates 209.85.167.173 as permitted sender) smtp.mailfrom=zokeefe@google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1666117881; a=rsa-sha256; cv=none; b=f07agU77VBAyoujk3rve1ahfs919hBA70LuE5sVQnzfT2rWD0GKavUqP4rJX9W06ARXYc1 PxUH/ndZXg2VpMfSG8In4+Bvlg4m9YTlF9Ua3uVipKUfXb19EzwRlU7smJpKU7QJTPBYbd hz71ULBU/OYST9oSbco+hPsN8hCUncE= X-Rspamd-Server: rspam12 X-Rspam-User: Authentication-Results: imf03.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=AFOcQpSf; spf=pass (imf03.hostedemail.com: domain of zokeefe@google.com designates 209.85.167.173 as permitted sender) smtp.mailfrom=zokeefe@google.com; dmarc=pass (policy=reject) header.from=google.com X-Stat-Signature: a3h496u183kw8cwey5mf3yhn4d9dbrh4 X-Rspamd-Queue-Id: D711320032 X-HE-Tag: 1666117881-396817 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Tue, Oct 18, 2022 at 11:04 AM Alejandro Colomar wrote: > > Hey Zach! > > On 10/18/22 19:53, Zach O'Keefe wrote: > > Hey Alex, > > > >>> diff --git a/man2/madvise.2 b/man2/madvise.2 > >>> index e14e0f7fb..adfe24c24 100644 > >>> --- a/man2/madvise.2 > >>> +++ b/man2/madvise.2 > >>> @@ -789,6 +789,13 @@ 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 > >>> +.BR madvise (0, > >>> +0, > >>> +.IR advice ) > >> > >> For expressions, we don't follow the same highlighting rules as in > >> identifiers and man-page references. Instead we use all italics. See > >> man-pages(7): > >> > >> Expressions, if not written on a separate indented line, > >> should be specified in italics. Again, the use of non=E2= =80=90 > >> breaking spaces may be appropriate if the expression is > >> inlined with normal text. > > > > Just to confirm, by "expression", you mean "madvise(0, 0, advice)"? > > Yes, I meant that. > > > If > > so, to be consistent with the other note, perhaps best to break this > > into a phrase such as: > > > > --8<--- > > .BR madvise () > > called with zero for both > > .IR addr > > and > > .IR length > > will return zero iff > > .I advice > > is supported by the kernel and can be relied on to probe for support. > > --8<--- > > I think the C expression was more readable. SGTM - will update for v2. Appreciate your help here! Best, Zach