linux-kernel - Re: [PATCH v2] Security: Documentation: Replace deprecated :c:func: Usage

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20200706143104.48fa2bd1@lwn.net>
Date:   Mon, 6 Jul 2020 14:31:04 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Puranjay Mohan <puranjay12@...il.com>
Cc:     skhan@...uxfoundation.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] Security: Documentation: Replace deprecated :c:func:
 Usage

On Tue,  7 Jul 2020 00:19:56 +0530
Puranjay Mohan <puranjay12@...il.com> 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 <puranjay12@...il.com>
> ---
> 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