[v1] Documentation: fix typo and formattting in security/credentials.rst

[PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by Mayank Gite 1 month, 1 week ago

- Fixes a typo in "Keys and keyrings" section. Replaces "keying" with
  "keyring".
- Updates formatting of keyring types.

Signed-off-by: Mayank Gite <drapl0n.kernel@gmail.com>
---
 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 d0191c8b8060..4996838491b1 100644
--- a/Documentation/security/credentials.rst
+++ b/Documentation/security/credentials.rst
@@ -189,9 +189,9 @@ The Linux kernel supports the following types of credentials:
      be searched for the desired key.  Each process may subscribe to a number
      of keyrings:
 
-	Per-thread keying
-	Per-process keyring
-	Per-session keyring
+	- Per-thread keyring
+	- Per-process keyring
+	- Per-session keyring
 
      When a process accesses a key, if not already present, it will normally be
      cached on one of these keyrings for future accesses to find.
-- 
2.53.0

Re: [PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by Jonathan Corbet 4 weeks ago

Mayank Gite <drapl0n.kernel@gmail.com> writes:

> - Fixes a typo in "Keys and keyrings" section. Replaces "keying" with
>   "keyring".
> - Updates formatting of keyring types.
>
> Signed-off-by: Mayank Gite <drapl0n.kernel@gmail.com>
> ---
>  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 d0191c8b8060..4996838491b1 100644
> --- a/Documentation/security/credentials.rst
> +++ b/Documentation/security/credentials.rst
> @@ -189,9 +189,9 @@ The Linux kernel supports the following types of credentials:
>       be searched for the desired key.  Each process may subscribe to a number
>       of keyrings:
>  
> -	Per-thread keying
> -	Per-process keyring
> -	Per-session keyring
> +	- Per-thread keyring
> +	- Per-process keyring
> +	- Per-session keyring
>  
Applied, thanks.

jon

Re: [PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by Randy Dunlap 1 month, 1 week ago

Hi,

On 5/6/26 3:59 PM, Mayank Gite wrote:
> - Fixes a typo in "Keys and keyrings" section. Replaces "keying" with
>   "keyring".
> - Updates formatting of keyring types.
> 
> Signed-off-by: Mayank Gite <drapl0n.kernel@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

> ---
In the future, right here, after that "---" line, it should say
something like

v2: use 'git send-email' so that that patch isn't corrupted

and in the Subject: it should say
[PATCH v2] ...

Thanks.

>  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 d0191c8b8060..4996838491b1 100644
> --- a/Documentation/security/credentials.rst
> +++ b/Documentation/security/credentials.rst
> @@ -189,9 +189,9 @@ The Linux kernel supports the following types of credentials:
>       be searched for the desired key.  Each process may subscribe to a number
>       of keyrings:
>  
> -	Per-thread keying
> -	Per-process keyring
> -	Per-session keyring
> +	- Per-thread keyring
> +	- Per-process keyring
> +	- Per-session keyring
>  
>       When a process accesses a key, if not already present, it will normally be
>       cached on one of these keyrings for future accesses to find.

-- 
~Randy

Re: [PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by John Doe 1 month ago

On Wed, May 06, 2026 at 05:36:53PM -0700, Randy Dunlap wrote:
> Hi,
> 
> On 5/6/26 3:59 PM, Mayank Gite wrote:
> > - Fixes a typo in "Keys and keyrings" section. Replaces "keying" with
> >   "keyring".
> > - Updates formatting of keyring types.
> > 
> > Signed-off-by: Mayank Gite <drapl0n.kernel@gmail.com>
> 
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> 
> > ---
> In the future, right here, after that "---" line, it should say
> something like
> 
> v2: use 'git send-email' so that that patch isn't corrupted
> 
> and in the Subject: it should say
> [PATCH v2] ...
> 
> Thanks.
> 
> >  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 d0191c8b8060..4996838491b1 100644
> > --- a/Documentation/security/credentials.rst
> > +++ b/Documentation/security/credentials.rst
> > @@ -189,9 +189,9 @@ The Linux kernel supports the following types of credentials:
> >       be searched for the desired key.  Each process may subscribe to a number
> >       of keyrings:
> >  
> > -	Per-thread keying
> > -	Per-process keyring
> > -	Per-session keyring
> > +	- Per-thread keyring
> > +	- Per-process keyring
> > +	- Per-session keyring
> >  
> >       When a process accesses a key, if not already present, it will normally be
> >       cached on one of these keyrings for future accesses to find.
> 
> -- 
> ~Randy

Hi,

Thank you for the feedback and acknowledgment. I thought that since my
earlier patch was invalid/corrupted, I should submit a new one rather than
version 2.

I understand the procedure now and will ensure that future revisions follow
the guidelines.

Thanks.

Re: [PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by Jonathan Corbet 1 month ago

John Doe <drapl0n.kernel@gmail.com> writes:

> Thank you for the feedback and acknowledgment. I thought that since my
> earlier patch was invalid/corrupted, I should submit a new one rather than
> version 2.
>
> I understand the procedure now and will ensure that future revisions follow
> the guidelines.

Along those lines, seeing multiple names associated with the same email
account is a bit disconcerting.  We are not generally interested in
taking patches submitted under pseudonyms...

jon

Re: [PATCH] Documentation: fix typo and formattting in security/credentials.rst

Posted by Mayank Gite 1 month ago

On Thu, May 07, 2026 at 12:31:48PM -0600, Jonathan Corbet wrote:
> John Doe <drapl0n.kernel@gmail.com> writes:
> 
> > Thank you for the feedback and acknowledgment. I thought that since my
> > earlier patch was invalid/corrupted, I should submit a new one rather than
> > version 2.
> >
> > I understand the procedure now and will ensure that future revisions follow
> > the guidelines.
> 
> Along those lines, seeing multiple names associated with the same email
> account is a bit disconcerting.  We are not generally interested in
> taking patches submitted under pseudonyms...

While configuring mutt, I forgot to change the default placeholder value
for the "realname" variable, resulting in an inconsistent sender name.

I have corrected the configuration and verified that my environment is
now set up appropriately.

Sorry for the confusion.

Mayank