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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8A0E4C92AE2D6D40AF99653191DA32316141394940@rrsmsx501.amr.corp.intel.com>
Date:	Thu, 4 Nov 2010 11:25:06 -0600
From:	"Allyn, Mark A" <mark.a.allyn@...el.com>
To:	Randy Dunlap <rdunlap@...otime.net>
CC:	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"linux-crypto@...r.kernel.org" <linux-crypto@...r.kernel.org>
Subject: RE: [PATCH 1/1] crypto: api.c adding kernel-doc comments

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@...otime.net] 
Sent: Thursday, November 04, 2010 10:22 AM
To: Allyn, Mark A
Cc: linux-kernel@...r.kernel.org; linux-crypto@...r.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@...el.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 ***
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/