crypto: api.c adding kernel-doc comments
PATCH 1/1 crypto: api.c adding kernel-doc comments
Add comments to crypto_alg_lookup and crypto_larval_lookup
I am re-submitting this due to errors
--- crypto/api.c | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-)
crypto/api.c +19 -0
@@ -193,6 +193,15 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* crypto_alg_lookup() return crypto_alg structure for an algorithm +* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) +*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
@@ -205,6 +214,16 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* crypto_alg_larval lookup() return large value (larval) crypto_alg +* structure for an algorithm +* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) +*/ struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
Signature · 1 line
1.6.3.3
Quoted 14 lines · On Thu, 4 Nov 2010 10:07:22 -0700 Mark Allyn wrote:
Add comments to
crypto_alg_lookupandcrypto_larval_lookupI am re-submitting this due to errors
Signed-off-by Mark A. Allyn <[email protected]>--- crypto/api.c | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-)crypto/api.c +0
-0
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 197
Quoted 5 lines
crypto/api.c +2
-0@@ -193,6 +193,15 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* crypto_alg_lookup() return crypto_alg structure for an algorithm
needs hyphen between function name and "return".
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 203
Quoted 6 lines
crypto/api.c +6
-0+* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h)
drop the line numbers...
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 218
Quoted 10 lines
crypto/api.c +3
-0+*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;@@ -205,6 +214,16 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* crypto_alg_larval lookup() return large value (larval) crypto_alg
* crypto_larval_lookup() - return large value (larval) crypto_alg
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 226
Quoted 8 lines
crypto/api.c +8
-0+* structure for an algorithm +* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) +*/
drop the line numbers.
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 229
Quoted 4 lines
crypto/api.c +0
-0struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
This is my first time in attempting to patch documentation. Shall I follow your suggestions by submitting a patch that depends on this patch or shall I submit the whole thing again with the corrections?
Mark
-----Original Message-----
From: Randy Dunlap [mailto:[email protected]]
Sent: Thursday, November 04, 2010 10:22 AM
To: Allyn, Mark A
Cc: [email protected]; [email protected]
Subject: Re: [PATCH 1/1] crypto: api.c adding kernel-doc comments
Quoted 14 lines · On Thu, 4 Nov 2010 10:07:22 -0700 Mark Allyn wrote:
Add comments to
crypto_alg_lookupandcrypto_larval_lookupI am re-submitting this due to errors
Signed-off-by Mark A. Allyn <[email protected]>--- crypto/api.c | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-)crypto/api.c +0
-0
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 197
Quoted 5 lines
crypto/api.c +2
-0@@ -193,6 +193,15 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* crypto_alg_lookup() return crypto_alg structure for an algorithm
needs hyphen between function name and "return".
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 203
Quoted 6 lines
crypto/api.c +6
-0+* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h)
drop the line numbers...
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 218
Quoted 10 lines
crypto/api.c +3
-0+*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;@@ -205,6 +214,16 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* crypto_alg_larval lookup() return large value (larval) crypto_alg
* crypto_larval_lookup() - return large value (larval) crypto_alg
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 226
Quoted 8 lines
crypto/api.c +8
-0+* structure for an algorithm +* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) +*/
drop the line numbers.
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 229
Quoted 4 lines
crypto/api.c +0
-0struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Quoted 2 lines · Mark A
This is my first time in attempting to patch documentation. Shall I follow your suggestions by submitting a patch that depends on this patch or shall I submit the whole thing again with the corrections?
Hi Mark,
If your patch was already merged somewhere (even in an intermediate tree), you should just send a partial/update patch, but in this case, since it hasn't been merged anywhere (that I know of), I recommend sending a complete new patch.
Thanks.
Quoted 64 lines
-----Original Message-----
From: Randy Dunlap [mailto:[email protected]]
Sent: Thursday, November 04, 2010 10:22 AM
To: Allyn, Mark A
Cc: [email protected]; [email protected]
Subject: Re: [PATCH 1/1] crypto:api.cadding kernel-doc commentsQuoted 14 lines · On Thu, 4 Nov 2010 10:07:22 -0700 Mark Allyn wrote:
Add comments to
crypto_alg_lookupandcrypto_larval_lookupI am re-submitting this due to errors
Signed-off-by Mark A. Allyn <[email protected]>--- crypto/api.c | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-)crypto/api.c +0
-0crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 197
Quoted 5 lines
crypto/api.c +2
-0@@ -193,6 +193,15 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* crypto_alg_lookup() return crypto_alg structure for an algorithm needs hyphen between function name and "return".
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 203
Quoted 6 lines
crypto/api.c +6
-0+* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) drop the line numbers...
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 218
Quoted 10 lines
crypto/api.c +3
-0+*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;@@ -205,6 +214,16 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* crypto_alg_larval lookup() return large value (larval) crypto_alg *
crypto_larval_lookup()- return large value (larval)crypto_algcrypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 226
Quoted 8 lines
crypto/api.c +8
-0+* structure for an algorithm +* @name: text string containing name of algorithm +* @type: crypto type (defined at about line 31 of +* include/linux/crypto.h) +* @mask: mask of allowable crypto types (use or'd list +* of types as defined at about line 31 of +* include/linux/crypto.h) +*/
Quoted 6 lines
drop the line numbers.
Quoted 4 lines
crypto/api.c +0
-0struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***