diff mbox

[MTD,NAND] S3C2410: Added a kerneldoc for s3c2410_nand_set

Message ID 1243705298-21814-9-git-send-email-ben-linux@fluff.org
State New, archived
Headers show

Commit Message

Ben Dooks May 30, 2009, 5:41 p.m. UTC 
From: Michel Pollet <buserror@gmail.com>

Converted the old comnent to kerneldoc.

Signed-off-by: Michel Pollet <buserror@gmail.com>
[ben-linux@fluff.org: updated subject]
Signed-off-by: Ben Dooks <ben-linux@fluff.org>
---
 arch/arm/plat-s3c/include/plat/nand.h |   22 ++++++++++++----------
 1 files changed, 12 insertions(+), 10 deletions(-)

Comments

Peter Korsgaard June 2, 2009, 7:36 p.m. UTC | #1 
>>>>> "Ben" == Ben Dooks <ben-linux@fluff.org> writes:

Hi,

 Ben> diff --git a/arch/arm/plat-s3c/include/plat/nand.h b/arch/arm/plat-s3c/include/plat/nand.h
 Ben> index 9855467..350ec95 100644
 Ben> --- a/arch/arm/plat-s3c/include/plat/nand.h
 Ben> +++ b/arch/arm/plat-s3c/include/plat/nand.h
 Ben> @@ -10,17 +10,19 @@
 Ben>   * published by the Free Software Foundation.
 Ben>  */
 
 Ben> -/* struct s3c2410_nand_set
 Ben> +/**
 Ben> + * struct s3c2410_nand_set - define a set of one or more nand chips
 Ben> + * @disable_ecc:	Entirely disable ECC - Dangerous
 Ben> + * @nr_chips:		Number of chips in this set
 Ben> + * @nr_partitions:	Number of partitions pointed to be partitoons (or zero)

s/partitoons/partitions/ - And the text sounds pretty confusing to
me. What about

Number of struct mtd_partitions pointed to by partitions (or zero)

Yes, I know it won't fit in 80 chars.
Ben Dooks June 2, 2009, 10:55 p.m. UTC | #2 
On Tue, Jun 02, 2009 at 09:36:35PM +0200, Peter Korsgaard wrote:
> >>>>> "Ben" == Ben Dooks <ben-linux@fluff.org> writes:
> 
> Hi,
> 
>  Ben> diff --git a/arch/arm/plat-s3c/include/plat/nand.h b/arch/arm/plat-s3c/include/plat/nand.h
>  Ben> index 9855467..350ec95 100644
>  Ben> --- a/arch/arm/plat-s3c/include/plat/nand.h
>  Ben> +++ b/arch/arm/plat-s3c/include/plat/nand.h
>  Ben> @@ -10,17 +10,19 @@
>  Ben>   * published by the Free Software Foundation.
>  Ben>  */
>  
>  Ben> -/* struct s3c2410_nand_set
>  Ben> +/**
>  Ben> + * struct s3c2410_nand_set - define a set of one or more nand chips
>  Ben> + * @disable_ecc:	Entirely disable ECC - Dangerous
>  Ben> + * @nr_chips:		Number of chips in this set
>  Ben> + * @nr_partitions:	Number of partitions pointed to be partitoons (or zero)
> 
> s/partitoons/partitions/ - And the text sounds pretty confusing to
> me. What about
> 
> Number of struct mtd_partitions pointed to by partitions (or zero)
> 
> Yes, I know it won't fit in 80 chars.

bah, merged the wrong patch. will fix.
 
> -- 
> Bye, Peter Korsgaard
> 
> ______________________________________________________
> Linux MTD discussion mailing list
> http://lists.infradead.org/mailman/listinfo/linux-mtd/
diff mbox

Patch

diff --git a/arch/arm/plat-s3c/include/plat/nand.h b/arch/arm/plat-s3c/include/plat/nand.h
index 9855467..350ec95 100644
--- a/arch/arm/plat-s3c/include/plat/nand.h
+++ b/arch/arm/plat-s3c/include/plat/nand.h
@@ -10,17 +10,19 @@ 
  * published by the Free Software Foundation.
 */
 
-/* struct s3c2410_nand_set
+/**
+ * struct s3c2410_nand_set - define a set of one or more nand chips
+ * @disable_ecc:	Entirely disable ECC - Dangerous
+ * @nr_chips:		Number of chips in this set
+ * @nr_partitions:	Number of partitions pointed to be partitoons (or zero)
+ * @name:		Name of set (optional)
+ * @nr_map:		Map for low-layer logical to physical chip numbers (option)
+ * @partitions:		The mtd partition list
  *
- * define an set of one or more nand chips registered with an unique mtd
- *
- * nr_chips	 = number of chips in this set
- * nr_partitions = number of partitions pointed to be partitoons (or zero)
- * name		 = name of set (optional)
- * nr_map	 = map for low-layer logical to physical chip numbers (option)
- * partitions	 = mtd partition list
-*/
-
+ * define a set of one or more nand chips registered with an unique mtd. Also
+ * allows to pass flag to the underlying NAND layer. 'disable_ecc' will trigger
+ * a warning at boot time.
+ */
 struct s3c2410_nand_set {
 	unsigned int		disable_ecc:1;