[PATCH 1/1] crypto: api.c adding kernel-doc comments

[PATCH 1/1] crypto: api.c adding kernel-doc comments

[Mark Allyn]

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@intel.com>
---
 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
+ * @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;
-- 
1.6.3.3

Re: [PATCH 1/1] crypto: api.c adding kernel-doc comments

[Randy Dunlap]

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@intel.com>
> ---
>  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 ***

RE: [PATCH 1/1] crypto: api.c adding kernel-doc comments

[Allyn, 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?

Mark

-----Original Message-----
From: Randy Dunlap [mailto:rdunlap@xenotime.net] 
Sent: Thursday, November 04, 2010 10:22 AM
To: Allyn, Mark A
Cc: linux-kernel@vger.kernel.org; linux-crypto@vger.kernel.org
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@intel.com>
> ---
>  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 ***

Re: [PATCH 1/1] crypto: api.c adding kernel-doc comments

[Randy Dunlap]

On Thu, 4 Nov 2010 11:25:06 -0600 Allyn, Mark A wrote:

> 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.

> 
> -----Original Message-----
> From: Randy Dunlap [mailto:rdunlap@xenotime.net] 
> Sent: Thursday, November 04, 2010 10:22 AM
> To: Allyn, Mark A
> Cc: linux-kernel@vger.kernel.org; linux-crypto@vger.kernel.org
> 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@intel.com>
> > ---
> >  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 ***