Patchwork Add MODULE_DESCRIPTION to various modules in drivers/mtd

login
register
mail settings
Submitter Terry Chia
Date July 3, 2014, 6:55 a.m.
Message ID <1404370542-14357-2-git-send-email-terrycwk1994@gmail.com>
Download mbox | patch
Permalink /patch/366587/
State New
Headers show

Comments

Terry Chia - July 3, 2014, 6:55 a.m.
This starts to address
https://bugzilla.kernel.org/show_bug.cgi?id=10770

Signed-off-by: Terry Chia <terrycwk1994@gmail.com>
---
 drivers/mtd/chips/cfi_cmdset_0020.c | 1 +
 drivers/mtd/chips/cfi_util.c        | 1 +
 drivers/mtd/maps/map_funcs.c        | 1 +
 drivers/mtd/nand/denali.c           | 1 +
 4 files changed, 4 insertions(+)
Brian Norris - July 14, 2014, 5:39 a.m.
Hi Terry,

I'm not sure the descriptions are all quite right. A few suggestions:

On Thu, Jul 03, 2014 at 02:55:42PM +0800, Terry Chia wrote:
> This starts to address
> https://bugzilla.kernel.org/show_bug.cgi?id=10770
> 
> Signed-off-by: Terry Chia <terrycwk1994@gmail.com>
> ---
>  drivers/mtd/chips/cfi_cmdset_0020.c | 1 +
>  drivers/mtd/chips/cfi_util.c        | 1 +
>  drivers/mtd/maps/map_funcs.c        | 1 +
>  drivers/mtd/nand/denali.c           | 1 +
>  4 files changed, 4 insertions(+)
> 
> diff --git a/drivers/mtd/chips/cfi_cmdset_0020.c b/drivers/mtd/chips/cfi_cmdset_0020.c
> index 423666b..55f3586 100644
> --- a/drivers/mtd/chips/cfi_cmdset_0020.c
> +++ b/drivers/mtd/chips/cfi_cmdset_0020.c
> @@ -1398,3 +1398,4 @@ static void cfi_staa_destroy(struct mtd_info *mtd)
>  }
>  
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("MTD chip driver for ST (Advanced Architecture) flash chips");

Already a bit long, but can you include "CFI" in there somewhere? I
think that's an important bit. Maybe:

  "MTD CFI driver for ST flash chips"

> diff --git a/drivers/mtd/chips/cfi_util.c b/drivers/mtd/chips/cfi_util.c
> index 09c79bd..c064484 100644
> --- a/drivers/mtd/chips/cfi_util.c
> +++ b/drivers/mtd/chips/cfi_util.c
> @@ -249,3 +249,4 @@ int cfi_varsize_frob(struct mtd_info *mtd, varsize_frob_t frob,
>  EXPORT_SYMBOL(cfi_varsize_frob);
>  
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("MTD chip driver for generic utility functions");

It's not exactly a full driver, just a few utility functions. Perhaps:

  "MTD CFI utility library"

> diff --git a/drivers/mtd/maps/map_funcs.c b/drivers/mtd/maps/map_funcs.c
> index 3f26837..089906a 100644
> --- a/drivers/mtd/maps/map_funcs.c
> +++ b/drivers/mtd/maps/map_funcs.c
> @@ -41,3 +41,4 @@ void simple_map_init(struct map_info *map)
>  
>  EXPORT_SYMBOL(simple_map_init);
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Out-of-line map I/O functions for simple maps");
> diff --git a/drivers/mtd/nand/denali.c b/drivers/mtd/nand/denali.c
> index 9f2012a..d373ed2 100644
> --- a/drivers/mtd/nand/denali.c
> +++ b/drivers/mtd/nand/denali.c
> @@ -28,6 +28,7 @@
>  #include "denali.h"
>  
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("NAND Flash Controller Device Driver");

You probably want "Denali" in there (although it is in the module
name...):

  "MTD driver for Denali NAND flash controller"
>  
>  /* We define a module parameter that allows the user to override
>   * the hardware and decide what timing mode should be used.

Brian

Patch

diff --git a/drivers/mtd/chips/cfi_cmdset_0020.c b/drivers/mtd/chips/cfi_cmdset_0020.c
index 423666b..55f3586 100644
--- a/drivers/mtd/chips/cfi_cmdset_0020.c
+++ b/drivers/mtd/chips/cfi_cmdset_0020.c
@@ -1398,3 +1398,4 @@  static void cfi_staa_destroy(struct mtd_info *mtd)
 }
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("MTD chip driver for ST (Advanced Architecture) flash chips");
diff --git a/drivers/mtd/chips/cfi_util.c b/drivers/mtd/chips/cfi_util.c
index 09c79bd..c064484 100644
--- a/drivers/mtd/chips/cfi_util.c
+++ b/drivers/mtd/chips/cfi_util.c
@@ -249,3 +249,4 @@  int cfi_varsize_frob(struct mtd_info *mtd, varsize_frob_t frob,
 EXPORT_SYMBOL(cfi_varsize_frob);
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("MTD chip driver for generic utility functions");
diff --git a/drivers/mtd/maps/map_funcs.c b/drivers/mtd/maps/map_funcs.c
index 3f26837..089906a 100644
--- a/drivers/mtd/maps/map_funcs.c
+++ b/drivers/mtd/maps/map_funcs.c
@@ -41,3 +41,4 @@  void simple_map_init(struct map_info *map)
 
 EXPORT_SYMBOL(simple_map_init);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Out-of-line map I/O functions for simple maps");
diff --git a/drivers/mtd/nand/denali.c b/drivers/mtd/nand/denali.c
index 9f2012a..d373ed2 100644
--- a/drivers/mtd/nand/denali.c
+++ b/drivers/mtd/nand/denali.c
@@ -28,6 +28,7 @@ 
 #include "denali.h"
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("NAND Flash Controller Device Driver");
 
 /* We define a module parameter that allows the user to override
  * the hardware and decide what timing mode should be used.