diff mbox series

[1/1] Documentation: security: core.rst: add missing argument

Message ID 20200516003917.2035545-2-list.lkml.keyrings@me.benboeckel.net (mailing list archive)
State New
Headers show
Series Document keyctl(KEYCTL_PKEY_QUERY) arguments correctly | expand

Commit Message

Ben Boeckel May 16, 2020, 12:39 a.m. UTC 
From: Ben Boeckel <mathstuf@gmail.com>

This argument was just never documented in the first place.

Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
---
 Documentation/security/keys/core.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

Jarkko Sakkinen May 16, 2020, 9:18 p.m. UTC | #1 
On Fri, 2020-05-15 at 20:39 -0400, Ben Boeckel wrote:
> From: Ben Boeckel <mathstuf@gmail.com>
> 
> This argument was just never documented in the first place.
> 
> Signed-off-by: Ben Boeckel <mathstuf@gmail.com>

Reviewed-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>

/Jarkko
David Howells May 18, 2020, 2:09 p.m. UTC | #2 
Ben Boeckel <me@benboeckel.net> wrote:

>  	long keyctl(KEYCTL_PKEY_QUERY,
>  		    key_serial_t key_id, unsigned long reserved,
> +		    const char* params,
>  		    struct keyctl_pkey_query *info);

"const char *params".  I fixed that and applied it.

David
Jonathan Corbet May 25, 2020, 4:33 p.m. UTC | #3 
On Fri, 15 May 2020 20:39:17 -0400
Ben Boeckel <me@benboeckel.net> wrote:

> From: Ben Boeckel <mathstuf@gmail.com>
> 
> This argument was just never documented in the first place.
> 
> Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
> ---
>  Documentation/security/keys/core.rst | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)

Applied, thanks.

jon
Jonathan Corbet May 25, 2020, 4:43 p.m. UTC | #4 
On Mon, 25 May 2020 10:33:10 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> On Fri, 15 May 2020 20:39:17 -0400
> Ben Boeckel <me@benboeckel.net> wrote:
> 
> > From: Ben Boeckel <mathstuf@gmail.com>
> > 
> > This argument was just never documented in the first place.
> > 
> > Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
> > ---
> >  Documentation/security/keys/core.rst | 8 ++++++--
> >  1 file changed, 6 insertions(+), 2 deletions(-)  
> 
> Applied, thanks.

...or not...looks like David got there first.  Sorry for the noise.

jon
David Howells May 26, 2020, 4:07 p.m. UTC | #5 
Jonathan Corbet <corbet@lwn.net> wrote:

> Applied, thanks.

Ah - I've applied it to my keys-next branch.

David
diff mbox series

Patch

diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst
index d9b0b859018b..c26b9e7d47c2 100644
--- a/Documentation/security/keys/core.rst
+++ b/Documentation/security/keys/core.rst
@@ -920,10 +920,14 @@  The keyctl syscall functions are:
 
 	long keyctl(KEYCTL_PKEY_QUERY,
 		    key_serial_t key_id, unsigned long reserved,
+		    const char* params,
 		    struct keyctl_pkey_query *info);
 
-     Get information about an asymmetric key.  The information is returned in
-     the keyctl_pkey_query struct::
+     Get information about an asymmetric key.  Specific algorithms and
+     encodings may be queried by using the ``params`` argument.  This is a
+     string containing a space- or tab-separated string of key-value pairs.
+     Currently supported keys include ``enc`` and ``hash``.  The information
+     is returned in the keyctl_pkey_query struct::
 
 	__u32	supported_ops;
 	__u32	key_size;