[PATCH 1/2] drm/i2c/ch7006: Make some parameter descriptions more useful.

[PATCH 1/2] drm/i2c/ch7006: Make some parameter descriptions more useful.

[Francisco Jerez]

Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
---
 drivers/gpu/drm/i2c/ch7006_drv.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/gpu/drm/i2c/ch7006_drv.c b/drivers/gpu/drm/i2c/ch7006_drv.c
index 47421ba..ff0369c 100644
--- a/drivers/gpu/drm/i2c/ch7006_drv.c
+++ b/drivers/gpu/drm/i2c/ch7006_drv.c
@@ -515,11 +515,11 @@ MODULE_PARM_DESC(debug, "Enable debug output.");
 
 char *ch7006_tv_norm = NULL;
 module_param_named(tv_norm, ch7006_tv_norm, charp, 0600);
-MODULE_PARM_DESC(tv_norm, "Default TV norm.");
+MODULE_PARM_DESC(tv_norm, "Default TV norm (one of: PAL, PAL-M, PAL-N, PAL-Nc, PAL-60, NTSC-M, NTSC-J).");
 
 int ch7006_scale = 0;
 module_param_named(scale, ch7006_scale, int, 0600);
-MODULE_PARM_DESC(scale, "Default scale.");
+MODULE_PARM_DESC(scale, "Default scale (integer between 0 and 2).");
 
 MODULE_AUTHOR("Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>");
 MODULE_DESCRIPTION("Chrontel ch7006 TV encoder driver");
-- 
1.6.3.3

[PATCH 2/2] drm/nouveau: Make the tv_norm parameter description more useful.

[Francisco Jerez]

Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
---
 drivers/gpu/drm/nouveau/nouveau_drv.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/drivers/gpu/drm/nouveau/nouveau_drv.c b/drivers/gpu/drm/nouveau/nouveau_drv.c
index a39a70b..5fad17d 100644
--- a/drivers/gpu/drm/nouveau/nouveau_drv.c
+++ b/drivers/gpu/drm/nouveau/nouveau_drv.c
@@ -57,7 +57,7 @@ MODULE_PARM_DESC(uscript_tmds, "TMDS output script table ID (>=GeForce 8)");
 int nouveau_uscript_tmds = -1;
 module_param_named(uscript_tmds, nouveau_uscript_tmds, int, 0400);
 
-MODULE_PARM_DESC(tv_norm, "Default TV norm");
+MODULE_PARM_DESC(tv_norm, "Default TV norm (one of: PAL, PAL-M, PAL-N, PAL-Nc, NTSC-M, NTSC-J, hd480i, hd480p, hd576i, hd576p, hd720p, hd1080i)");
 char *nouveau_tv_norm = NULL;
 module_param_named(tv_norm, nouveau_tv_norm, charp, 0400);
 
-- 
1.6.3.3

Re: [PATCH 1/2] drm/i2c/ch7006: Make some parameter descriptions more useful.

[Anssi Hannula]

Francisco Jerez wrote:
> Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
> ---
>  drivers/gpu/drm/i2c/ch7006_drv.c |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i2c/ch7006_drv.c b/drivers/gpu/drm/i2c/ch7006_drv.c
> index 47421ba..ff0369c 100644
> --- a/drivers/gpu/drm/i2c/ch7006_drv.c
> +++ b/drivers/gpu/drm/i2c/ch7006_drv.c
> @@ -515,11 +515,11 @@ MODULE_PARM_DESC(debug, "Enable debug output.");
>  
>  char *ch7006_tv_norm = NULL;
>  module_param_named(tv_norm, ch7006_tv_norm, charp, 0600);
> -MODULE_PARM_DESC(tv_norm, "Default TV norm.");
> +MODULE_PARM_DESC(tv_norm, "Default TV norm (one of: PAL, PAL-M, PAL-N, PAL-Nc, PAL-60, NTSC-M, NTSC-J).");

I think this should also mention the default value.

BTW, somehow I'd think this should be handled in a more generic place,
like in the drm module. But that's another issue.

>  int ch7006_scale = 0;
>  module_param_named(scale, ch7006_scale, int, 0600);
> -MODULE_PARM_DESC(scale, "Default scale.");
> +MODULE_PARM_DESC(scale, "Default scale (integer between 0 and 2).");

Default value would be useful here as well. And I think the description
should be a little more verbose here, as I don't immediately see how
"scale" is related to tv-out. Does it mean the amount of overscan? Or
does it change default scaling method?

>  MODULE_AUTHOR("Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>");
>  MODULE_DESCRIPTION("Chrontel ch7006 TV encoder driver");


-- 
Anssi Hannula

[PATCHv2 1/2] drm/i2c/ch7006: Make some parameter descriptions more useful.

[Francisco Jerez]

Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
---
 drivers/gpu/drm/i2c/ch7006_drv.c |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/drivers/gpu/drm/i2c/ch7006_drv.c b/drivers/gpu/drm/i2c/ch7006_drv.c
index 47421ba..76570d6 100644
--- a/drivers/gpu/drm/i2c/ch7006_drv.c
+++ b/drivers/gpu/drm/i2c/ch7006_drv.c
@@ -515,11 +515,16 @@ MODULE_PARM_DESC(debug, "Enable debug output.");
 
 char *ch7006_tv_norm = NULL;
 module_param_named(tv_norm, ch7006_tv_norm, charp, 0600);
-MODULE_PARM_DESC(tv_norm, "Default TV norm.");
+MODULE_PARM_DESC(tv_norm, "Default TV norm.\n"
+		 "\t\tSupported: PAL, PAL-M, PAL-N, PAL-Nc, PAL-60, NTSC-M, NTSC-J.\n"
+		 "\t\tDefault: PAL");
 
 int ch7006_scale = 0;
 module_param_named(scale, ch7006_scale, int, 0600);
-MODULE_PARM_DESC(scale, "Default scale.");
+MODULE_PARM_DESC(scale, "Default scale.\n"
+		 "\t\tSupported: 0 -> Select video modes with a higher blanking ratio.\n"
+		 "\t\t\t1 -> Select default video modes.\n"
+		 "\t\t\t2 -> Select video modes with a lower blanking ratio.");
 
 MODULE_AUTHOR("Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>");
 MODULE_DESCRIPTION("Chrontel ch7006 TV encoder driver");
-- 
1.6.3.3

[PATCHv2 2/2] drm/nouveau: Make the tv_norm parameter description more useful.

[Francisco Jerez]

Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
---
 drivers/gpu/drm/nouveau/nouveau_drv.c |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/drivers/gpu/drm/nouveau/nouveau_drv.c b/drivers/gpu/drm/nouveau/nouveau_drv.c
index a39a70b..a2375c8 100644
--- a/drivers/gpu/drm/nouveau/nouveau_drv.c
+++ b/drivers/gpu/drm/nouveau/nouveau_drv.c
@@ -57,7 +57,11 @@ MODULE_PARM_DESC(uscript_tmds, "TMDS output script table ID (>=GeForce 8)");
 int nouveau_uscript_tmds = -1;
 module_param_named(uscript_tmds, nouveau_uscript_tmds, int, 0400);
 
-MODULE_PARM_DESC(tv_norm, "Default TV norm");
+MODULE_PARM_DESC(tv_norm, "Default TV norm.\n"
+		 "\t\tSupported: PAL, PAL-M, PAL-N, PAL-Nc, NTSC-M, NTSC-J,\n"
+		 "\t\t\thd480i, hd480p, hd576i, hd576p, hd720p, hd1080i.\n"
+		 "\t\tDefault: PAL\n"
+		 "\t\t*NOTE* Ignored for cards with external TV encoders.");
 char *nouveau_tv_norm = NULL;
 module_param_named(tv_norm, nouveau_tv_norm, charp, 0400);
 
-- 
1.6.3.3

Re: [PATCHv2 2/2] drm/nouveau: Make the tv_norm parameter description more useful.

[Pekka Paalanen]

On Tue, 25 Aug 2009 15:41:27 +0200
Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org> wrote:

> 
> Signed-off-by: Francisco Jerez <currojerez-sGOZH3hwPm2sTnJN9+BGXg@public.gmane.org>
> ---
>  drivers/gpu/drm/nouveau/nouveau_drv.c |    6 +++++-
>  1 files changed, 5 insertions(+), 1 deletions(-)

Both pushed, thanks.

-- 
Pekka Paalanen
http://www.iki.fi/pq/