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 X-Spam-Level: X-Spam-Status: No, score=-6.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A0EF7C433E0 for ; Mon, 6 Jul 2020 20:31:08 +0000 (UTC) Received: from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 6E1D420702 for ; Mon, 6 Jul 2020 20:31:08 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6E1D420702 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=lwn.net Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linux-kernel-mentees-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 41C82875AD; Mon, 6 Jul 2020 20:31:08 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id QtyMMbNppA2B; Mon, 6 Jul 2020 20:31:07 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by fraxinus.osuosl.org (Postfix) with ESMTP id 1DB0D87666; Mon, 6 Jul 2020 20:31:07 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 1A424C0891; Mon, 6 Jul 2020 20:31:07 +0000 (UTC) Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by lists.linuxfoundation.org (Postfix) with ESMTP id 42333C016F for ; Mon, 6 Jul 2020 20:31:06 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id 3F03B88626 for ; Mon, 6 Jul 2020 20:31:06 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 4VUtNRBxW8Ny for ; Mon, 6 Jul 2020 20:31:05 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by hemlock.osuosl.org (Postfix) with ESMTPS id D82D587EA0 for ; Mon, 6 Jul 2020 20:31:05 +0000 (UTC) Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 5B81F2D6; Mon, 6 Jul 2020 20:31:05 +0000 (UTC) Date: Mon, 6 Jul 2020 14:31:04 -0600 From: Jonathan Corbet To: Puranjay Mohan Message-ID: <20200706143104.48fa2bd1@lwn.net> In-Reply-To: <20200706184956.6928-1-puranjay12@gmail.com> References: <20200706184956.6928-1-puranjay12@gmail.com> Organization: LWN.net MIME-Version: 1.0 Cc: linux-doc@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org Subject: Re: [Linux-kernel-mentees] [PATCH v2] Security: Documentation: Replace deprecated :c:func: Usage X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" On Tue, 7 Jul 2020 00:19:56 +0530 Puranjay Mohan wrote: > Replace :c:func: with ``func()`` as the previous usage is deprecated. > Remove an extra ')' to fix broken cross reference. > > Signed-off-by: Puranjay Mohan > --- > V2: Remove ``quotes`` around function names > V1: Change the subject line and remove deprecated :c:func: usage > --- > Documentation/security/credentials.rst | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/Documentation/security/credentials.rst b/Documentation/security/credentials.rst > index 282e79feee6a..15175b11336c 100644 > --- a/Documentation/security/credentials.rst > +++ b/Documentation/security/credentials.rst > @@ -453,9 +453,9 @@ still at this point. > > When replacing the group list, the new list must be sorted before it > is added to the credential, as a binary search is used to test for > -membership. In practice, this means :c:func:`groups_sort` should be > -called before :c:func:`set_groups` or :c:func:`set_current_groups`. > -:c:func:`groups_sort)` must not be called on a ``struct group_list`` which > +membership. In practice, this means groups_sort() should be > +called before set_groups() or set_current_groups(). > +groups_sort() must not be called on a ``struct group_list`` which > is shared as it may permute elements as part of the sorting process > even if the array is already sorted. I've applied this, many thanks. jon _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees