Security: Documentation: Replace deprecated :c:func: Usage
Subsystems (2)
PATCH v2 1/1 Security: Documentation: Replace deprecated :c:func: Usage
Replace :c:func: with ``func()`` as the previous usage is deprecated. Remove an extra ')' to fix broken cross reference.
Signed-off-by Puranjay Mohan <[email protected]>
---
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(-)
Documentation/security/credentials.rst +3 -3
@@ -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.
Signature · 1 line
2.27.0
Quoted 17 lines · On Tue, 7 Jul 2020 00:19:56 +0530 Puranjay Mohan <[email protected]> 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 <[email protected]>---
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(-)Documentation/security/credentials.rst +0
-0@@ -453,9 +453,9 @@ still at this point.
Documentation/security/credentials.rst still at this point. · line 460
Quoted 10 lines
Documentation/security/credentials.rst +3
-3When 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