Re: [PATCH v1] Security: Documentation: Replace deprecated :c:func: Usage
From: Jonathan Corbet <corbet@lwn.net>
Date: 2020-07-06 18:40:02
Also in:
linux-kernel-mentees, lkml
On Tue, 7 Jul 2020 00:04:37 +0530 Puranjay Mohan [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Replace :c:func: with ``func()`` as the previous usage is deprecated. Remove an extra ')' to fix broken cross reference. Signed-off-by: Puranjay Mohan <redacted> --- 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..77b534f61c2a 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.
Almost ... but please leave off the ``quotes`` as well - just say groups_sort(). Thanks, jon