diff mbox series

[v2] crypto: engine - Fix struct crypto_engine_op doc

Message ID 20230424002925.2740296-1-mmyangfl@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v2] crypto: engine - Fix struct crypto_engine_op doc | expand

Commit Message

David Yang April 24, 2023, 12:29 a.m. UTC
Remove redundant underscore and fix some grammar in prepare_request doc.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/b58dc77c-c975-46cf-581c-368d9a87ae64@infradead.org
Signed-off-by: David Yang <mmyangfl@gmail.com>
---
 include/crypto/engine.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap April 24, 2023, 1:25 a.m. UTC | #1
Hi,

On 4/23/23 17:29, David Yang wrote:
> Remove redundant underscore and fix some grammar in prepare_request doc.
> 
> Reported-by: Randy Dunlap <rdunlap@infradead.org>

No, I didn't report this issue. You either found it on your own or someone/something
else reported it.

> Link: https://lore.kernel.org/r/b58dc77c-c975-46cf-581c-368d9a87ae64@infradead.org

Also drop the Link: line.

> Signed-off-by: David Yang <mmyangfl@gmail.com>
> ---
>  include/crypto/engine.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/crypto/engine.h b/include/crypto/engine.h
> index ae133e98d813..2038764b30c2 100644
> --- a/include/crypto/engine.h
> +++ b/include/crypto/engine.h
> @@ -78,7 +78,7 @@ struct crypto_engine {
>  
>  /*
>   * struct crypto_engine_op - crypto hardware engine operations
> - * @prepare__request: do some prepare if need before handle the current request
> + * @prepare_request: do some preparation if needed before handling the current request

That part looks good.

>   * @unprepare_request: undo any work done by prepare_request()
>   * @do_one_request: do encryption for current request
>   */
diff mbox series

Patch

diff --git a/include/crypto/engine.h b/include/crypto/engine.h
index ae133e98d813..2038764b30c2 100644
--- a/include/crypto/engine.h
+++ b/include/crypto/engine.h
@@ -78,7 +78,7 @@  struct crypto_engine {
 
 /*
  * struct crypto_engine_op - crypto hardware engine operations
- * @prepare__request: do some prepare if need before handle the current request
+ * @prepare_request: do some preparation if needed before handling the current request
  * @unprepare_request: undo any work done by prepare_request()
  * @do_one_request: do encryption for current request
  */