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 83F44C4332F for ; Tue, 18 Oct 2022 17:54:36 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1DC166B0072; Tue, 18 Oct 2022 13:54:36 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 1659E8E0001; Tue, 18 Oct 2022 13:54:36 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 005856B0078; Tue, 18 Oct 2022 13:54:35 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id D56096B0072 for ; Tue, 18 Oct 2022 13:54:35 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id ABC0681099 for ; Tue, 18 Oct 2022 17:54:35 +0000 (UTC) X-FDA: 80034820110.10.63D2693 Received: from mail-oa1-f44.google.com (mail-oa1-f44.google.com [209.85.160.44]) by imf14.hostedemail.com (Postfix) with ESMTP id 63891100029 for ; Tue, 18 Oct 2022 17:54:35 +0000 (UTC) Received: by mail-oa1-f44.google.com with SMTP id 586e51a60fabf-12c8312131fso17736432fac.4 for ; Tue, 18 Oct 2022 10:54:35 -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=eRfBB3PczH4udDVWnE5Hhe8NTWNmueP8X5B4lU+gCoE=; b=Uz1S07sAl4wiM9zfzAcrxaFE6EgLeaScq9V46U5QiG3QDb8fampgAAZScx7qnpUtlp s0Uzv8Snz1jIxxoCX9bXNwghIrm8Nx5WNc3c+4XJkL4Rl/mKNjd1YzR+gxYDFH3TF+Iq vG2IV02VVzuek/Pc+k0dFPCKNCCeHa1fSLjS5unx53fW7CKr/i8zId9qSkg4ye7QfdcR mgUyUPl8e5AuXSnJ6apJUoAeFcQNMZg6Of7j+4ctSrItoSf4xYAmHUOW0pz8Ijuz3zaY MCk/WFjC7hsdg8h7wLPlhq4IqPCxM1hBrqux7dFz1iskoelgd6eMHxcnoRnGT6+YrSkA RUUw== 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=eRfBB3PczH4udDVWnE5Hhe8NTWNmueP8X5B4lU+gCoE=; b=e62rURzpvprx8qR5kerY5MSqL9vs+BEkjgxosXYUj6lntCQYjl1OI4sJ0xRkWYy4+C 1IT+xnGhvVCiCtH+PmGWLctJ2HjcFUeXa5KmmLRvKynj7P++qslXLPxRsiXmvdQgnYkt aHrwaOG8m2M7VntIdp9I6GnVFbYYOyGNvhahUJU3tMfTr59FWOLHr9KFqLKl/n9w8/vk MIzSAAg9VK8UsZ+F3cdrnZBJ45bQRZNiXwSSATf70fJz8ut16FBLUeMqBJtnvTnqNNGi ZzZzAi0XVwxf5ZgBfY6QYLiRmmUOr9/e5DaU/6xewH6KQ82cnQt9purtPnXKbAQBOtKJ giEA== X-Gm-Message-State: ACrzQf0Er+BOVwNYYeBUO27VtBLHcw9qjr7yed/VhFljsD3iL4chzXYk AZGN+YO1M1M3nEmn09gKwXT3GBZW6vJW3axwhUrhhw== X-Google-Smtp-Source: AMsMyM4s7LiehMAmQwAlsglqv7I9hjEir5JxyPvKq/LWVIGO61ukt9N0xDHm3Hkjhil8AJK63zEo4I2oWd9VoQFnPIU= X-Received: by 2002:a05:6870:7023:b0:132:538:43e7 with SMTP id u35-20020a056870702300b00132053843e7mr2293163oae.123.1666115674347; Tue, 18 Oct 2022 10:54:34 -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> In-Reply-To: <2de9de5f-c82d-f2ce-26e3-b9fabd88a08c@gmail.com> From: "Zach O'Keefe" Date: Tue, 18 Oct 2022 10:53:58 -0700 Message-ID: Subject: Re: [PATCH man-pages 2/4] madvise.2: document reliable probe for advice support To: Alex 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-Authentication-Results: i=1; imf14.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=Uz1S07sA; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf14.hostedemail.com: domain of zokeefe@google.com designates 209.85.160.44 as permitted sender) smtp.mailfrom=zokeefe@google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1666115675; a=rsa-sha256; cv=none; b=XT4xdPhO4SFpIHm4HU/O4cLHfwrqYKr1CeB4oXO/rSE6+NOuV+KlY1bZA+7dVDSBFbD6UA Y0L9W2NgddweoVTwt3fX4yh14H3ElsiEdZA7fK/2tLu9sgwSAwn3T+UKLLzpnEQf9ZqcKH c2gSmBqUXWkiNKE4n98my1SotvNGRuE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1666115675; 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=eRfBB3PczH4udDVWnE5Hhe8NTWNmueP8X5B4lU+gCoE=; b=JhftYx6TdHtfwyYsYfcnOqAAx1Pt+Sq4cyY7Lcw4A57g/iHp6910Nh9AlR6nUkMjzggxI4 tZH2TnDZR9j6ETcqd4pIWT2QFPCz18qFzsQ1ZEYCAhVyM8FQ8XaHauQfT05JFdaLbS5tCQ kPWpYgbeDkAI2HD7vsMFSm8SLYu98b0= Authentication-Results: imf14.hostedemail.com; dkim=pass header.d=google.com header.s=20210112 header.b=Uz1S07sA; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf14.hostedemail.com: domain of zokeefe@google.com designates 209.85.160.44 as permitted sender) smtp.mailfrom=zokeefe@google.com X-Rspam-User: X-Rspamd-Server: rspam06 X-Stat-Signature: ckciibbby1mcxjetok89nm8wrb3tnubz X-Rspamd-Queue-Id: 63891100029 X-HE-Tag: 1666115675-714538 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: 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)"? 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<--- Thanks, Zach