[PATCH] staging: gasket: Add descriptions for module parameters

[Greg Kroah-Hartman]

On Sun, Jul 08, 2018 at 08:30:50PM +0300, Kamal Heib wrote:
> This patch add description for the module parameters and remove the task
> to do it from the TODO file.
> 
> Signed-off-by: Kamal Heib <kamalheib1 at gmail.com>
> ---
>  drivers/staging/gasket/TODO          | 1 -
>  drivers/staging/gasket/apex_driver.c | 8 ++++++++
>  2 files changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/staging/gasket/TODO b/drivers/staging/gasket/TODO
> index 0d8ee9602c80..c524dba7945f 100644
> --- a/drivers/staging/gasket/TODO
> +++ b/drivers/staging/gasket/TODO
> @@ -5,7 +5,6 @@ staging directory.
>  - Remove static function declarations.
>  - Document sysfs files with Documentation/ABI/ entries.
>  - Use misc interface instead of major number for driver version description.
> -- Add descriptions of module_param's
>  - Remove gasket-specific logging functions.
>  - apex_get_status() should actually check status.
>  - Static functions don't need kernel doc formatting, can be simplified.
> diff --git a/drivers/staging/gasket/apex_driver.c b/drivers/staging/gasket/apex_driver.c
> index 395256704428..21deef38807a 100644
> --- a/drivers/staging/gasket/apex_driver.c
> +++ b/drivers/staging/gasket/apex_driver.c
> @@ -329,9 +329,17 @@ static int allow_hw_clock_gating = 1;
>  static int bypass_top_level;
>  
>  module_param(allow_power_save, int, 0644);
> +MODULE_PARM_DESC(allow_power_save,
> +		 "Allows device to enter power save upon driver close()");
> +
>  module_param(allow_sw_clock_gating, int, 0644);
> +MODULE_PARM_DESC(allow_sw_clock_gating, "Allows SW based clock gating");
> +
>  module_param(allow_hw_clock_gating, int, 0644);
> +MODULE_PARM_DESC(allow_hw_clock_gating, "Allows HW based clock gating");
> +
>  module_param(bypass_top_level, int, 0644);
> +MODULE_PARM_DESC(bypass_top_level, "Act as if only GCB is instantiated");

Are you sure these options are even needed?  "Modern" drivers do not
need kernel module options as everything should "just work"
automatically.  Why are these options on a per-module basis and not a
per-device basis?

So I'd prefer to not take this patch and have the root problem here
fixed instead.

thanks,

greg k-h