2018-10-26 10:20:44

by Tomas Winkler

Subject: [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd()

kdoc for tpm2_flush_context_cmd() was off.

Fixes: 9aa36b399a50 ("tpm: export tpm2_flush_context_cmd")'
Signed-off-by: Tomas Winkler <[email protected]>
---
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

2018-10-26 13:28:22

by Jarkko Sakkinen

Subject: Re: [PATCH v2] tpm: fix kdoc for tpm2_flush_context_cmd()

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 <[email protected]>
> ---
> 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