Skip to contentSkip to conversation

crypto: engine - Fix struct crypto_engine_op doc

PATCH Superseded David Yang 2 participants 2 messages Apr 24, 2023 Crypto API

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

David Yang

author
#0 lore raw

PATCH v2 1/1 crypto: engine - Fix struct crypto_engine_op doc

Remove redundant underscore and fix some grammar in prepare_request doc.

---
 include/crypto/engine.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/crypto/engine.h +1 -1
index ae133e98d813..2038764b30c2 100644
@@ -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
  */
Signature · 1 line
2.39.2
#1 lore raw

Hi,

Quoted 3 lines · David Yang

Remove redundant underscore and fix some grammar in prepare_request doc.

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

Quoted 1 line

Also drop the Link: line.

Quoted 10 lines
---
 include/crypto/engine.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/crypto/engine.h +0 -0
index ae133e98d813..2038764b30c2 100644

include/crypto/engine.h struct crypto_engine { · line 81

Quoted 5 lines
include/crypto/engine.h +1 -1
@@ -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.

Quoted 3 lines
include/crypto/engine.h +0 -0
  * @unprepare_request: undo any work done by prepare_request()
  * @do_one_request: do encryption for current request
  */
Signature · 1 line
~Randy