* [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd()
@ 2018-10-26 10:15 Tomas Winkler
2018-10-26 13:25 ` Jarkko Sakkinen
0 siblings, 1 reply; 2+ messages in thread
From: Tomas Winkler @ 2018-10-26 10:15 UTC (permalink / raw)
To: Jarkko Sakkinen, Jason Gunthorpe
Cc: Nayna Jain, Alexander Usyskin, Tadeusz Struk, linux-integrity,
linux-security-module, linux-kernel, Tomas Winkler
kdoc for tpm2_flush_context_cmd() was off.
Fixes: 9aa36b399a50 ("tpm: export tpm2_flush_context_cmd")'
Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
V2: drop 'commit' from Fixes:
drivers/char/tpm/tpm2-cmd.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/drivers/char/tpm/tpm2-cmd.c b/drivers/char/tpm/tpm2-cmd.c
index ae86fb0218ab..ba94dd5f11a4 100644
--- a/drivers/char/tpm/tpm2-cmd.c
+++ b/drivers/char/tpm/tpm2-cmd.c
@@ -343,10 +343,9 @@ int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
/**
* tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
* @chip: TPM chip to use
- * @payload: the key data in clear and encrypted form
- * @options: authentication values and other options
+ * @handle: context handle
+ * @flags: tpm transmit flags - bitmap
*
- * Return: same as with tpm_transmit_cmd
*/
void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
unsigned int flags)
--
2.14.5
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd()
2018-10-26 10:15 [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd() Tomas Winkler
@ 2018-10-26 13:25 ` Jarkko Sakkinen
0 siblings, 0 replies; 2+ messages in thread
From: Jarkko Sakkinen @ 2018-10-26 13:25 UTC (permalink / raw)
To: Tomas Winkler
Cc: Jarkko Sakkinen, Jason Gunthorpe, Nayna Jain, Alexander Usyskin,
Tadeusz Struk, linux-integrity, linux-security-module,
linux-kernel
On Fri, 26 Oct 2018, Tomas Winkler wrote:
> kdoc for tpm2_flush_context_cmd() was off.
>
> Fixes: 9aa36b399a50 ("tpm: export tpm2_flush_context_cmd")'
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
> ---
> V2: drop 'commit' from Fixes:
> drivers/char/tpm/tpm2-cmd.c | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/char/tpm/tpm2-cmd.c b/drivers/char/tpm/tpm2-cmd.c
> index ae86fb0218ab..ba94dd5f11a4 100644
> --- a/drivers/char/tpm/tpm2-cmd.c
> +++ b/drivers/char/tpm/tpm2-cmd.c
> @@ -343,10 +343,9 @@ int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
> /**
> * tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
> * @chip: TPM chip to use
> - * @payload: the key data in clear and encrypted form
> - * @options: authentication values and other options
> + * @handle: context handle
> + * @flags: tpm transmit flags - bitmap
> *
> - * Return: same as with tpm_transmit_cmd
> */
> void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
> unsigned int flags)
> --
> 2.14.5
>
>
A minor request. There's some convention mismatch in the subsystem. In
some places the arguments are aligned and in some place they are not.
In order to make educated decision what is right I checked
Documentation/doc-guide/kernel-doc.rst. In the section called 'Function
documentation' they are aligned.
Can you do one more revision where @payload and @options are aligned
(with a tab-character) now that you are updating the kdoc anyway?
Otherwise, this looks good to me.
/Jarkko
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-10-26 13:26 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-10-26 10:15 [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd() Tomas Winkler
2018-10-26 13:25 ` Jarkko Sakkinen
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).