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:rdunlap@xxxxxxxxxxxx] Sent: Thursday, November 04, 2010 10:22 AM To: Allyn, Mark A Cc: linux-kernel@xxxxxxxxxxxxxxx; linux-crypto@xxxxxxxxxxxxxxx Subject: Re: [PATCH 1/1] crypto: api.c adding kernel-doc comments On Thu, 4 Nov 2010 10:07:22 -0700 Mark Allyn wrote: > Add comments to crypto_alg_lookup and crypto_larval_lookup > > I am re-submitting this due to errors > > Signed-off-by: Mark A. Allyn <mark.a.allyn@xxxxxxxxx> > --- > crypto/api.c | 19 +++++++++++++++++++ > 1 files changed, 19 insertions(+), 0 deletions(-) > > diff --git a/crypto/api.c b/crypto/api.c > index 033a714..71c389d 100644 > --- a/crypto/api.c > +++ b/crypto/api.c > @@ -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". > + * @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... > + */ > 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 > + * 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. > struct 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 *** -- To unsubscribe from this list: send the line "unsubscribe linux-crypto" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
