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

[Anssi Hannula <anssi.hannula-X3B1VOXEql0@public.gmane.org>]

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