Re: [PATCH 1/2] drm/i915: module parameter descriptions

[Chris Wilson <chris@chris-wilson.co.uk>]

User-facing documentation brings out the pedant...

On Sat,  2 Jul 2011 16:42:33 -0700, Ben Widawsky <ben@bwidawsk.net> wrote:
> Signed-off-by: Ben Widawsky <ben@bwidawsk.net>
> ---
>  drivers/gpu/drm/i915/i915_drv.c |   24 ++++++++++++++++++++++++
>  1 files changed, 24 insertions(+), 0 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/i915_drv.c b/drivers/gpu/drm/i915/i915_drv.c
> index b54f7d9..7164650 100644
> --- a/drivers/gpu/drm/i915/i915_drv.c
> +++ b/drivers/gpu/drm/i915/i915_drv.c
> @@ -39,39 +39,63 @@
>  
>  static int i915_modeset = -1;
>  module_param_named(modeset, i915_modeset, int, 0400);
> +MODULE_PARM_DESC(modeset, "Use kernel modesetting (KMS) "
> +		 "(0=use DRM_I915_KMS from .config "
> +		 "1=on "
> +		 "-1=force vga console prio boost [default])");
Commas required between the options.
  
>  unsigned int i915_fbpercrtc = 0;
>  module_param_named(fbpercrtc, i915_fbpercrtc, int, 0400);
>  
>  int i915_panel_ignore_lid = 0;
>  module_param_named(panel_ignore_lid, i915_panel_ignore_lid, int, 0600);
> +MODULE_PARM_DESC(panel_ignore_lid, "Override lid status "
> +		 "(0=autodetect [default], >0=lid open, <0=lid closed)");
0, -1, 1. Let's not overcomplicate the instructions.
  
>  unsigned int i915_powersave = 1;
>  module_param_named(powersave, i915_powersave, int, 0600);
> +MODULE_PARM_DESC(powersave, "Powersaving features, fbc, downclocking, etc. "
> +		 "(0=off, !0=on [default)");
0 or 1, as above and below. In fact, I prefer the true/false as you used
later. Be consistent! :-)
  
>  unsigned int i915_semaphores = 0;
>  module_param_named(semaphores, i915_semaphores, int, 0600);
> +MODULE_PARM_DESC(semaphores, "Use semaphores for inter-ring synchronization "
> +		 "(0=off [default], !0=on)");
>  
>  unsigned int i915_enable_rc6 = 1;
>  module_param_named(i915_enable_rc6, i915_enable_rc6, int, 0600);
> +MODULE_PARM_DESC(i915_enable_rc6,
> +		 "Enable render C-state 6 (0=off, !0=on [default])");
"Enable power-saving render C-state 6 (default: true)");

>  
>  unsigned int i915_enable_fbc = 0;
>  module_param_named(i915_enable_fbc, i915_enable_fbc, int, 0600);
> +MODULE_PARM_DESC(i915_enable_fbc,
> +		 "Enable frame buffer compression for power savings "
> +		 "(0=off [default], !0=on)");
>  
>  unsigned int i915_lvds_downclock = 0;
>  module_param_named(lvds_downclock, i915_lvds_downclock, int, 0400);
> +MODULE_PARM_DESC(lvds_downclock,
> +		 "LVDS downclocking for power savings(0=off [default], !0=on)");
"Use panel (LVDS/eDP) downclocking for power savings(default: false)");
 
>  unsigned int i915_panel_use_ssc = 1;
>  module_param_named(lvds_use_ssc, i915_panel_use_ssc, int, 0600);
> +MODULE_PARM_DESC(lvds_use_ssc,
> +		 "LVDS Spread Spectrum Clock (0=off, !0=on [default])");
"Use Spread Spectrum Clock with panels (LVDS/eDP) (default: true)");
  
>  int i915_vbt_sdvo_panel_type = -1;
>  module_param_named(vbt_sdvo_panel_type, i915_vbt_sdvo_panel_type, int, 0600);
> +MODULE_PARM_DESC(vbt_sdvo_panel_type,
> +		 "SDVO panel type override (Default: auto)");
"Override selection of SDVO panel mode in the VBT (Default: auto)");
  
>  static bool i915_try_reset = true;
>  module_param_named(reset, i915_try_reset, bool, 0600);
> +MODULE_PARM_DESC(reset, "Attempt GPU resets (Default: true)");
>  
>  bool i915_enable_hangcheck = true;
>  module_param_named(enable_hangcheck, i915_enable_hangcheck, bool, 0644);
> +MODULE_PARM_DESC(enable_hangcheck,
> +		 "Enable hanghceck triggered reset (Default: true)");
"Periodically check GPU activity for detecting hangs [aka hangcheck]
(Default:true)"
-Chris

-- 
Chris Wilson, Intel Open Source Technology Centre