dri-devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: dri-devel@lists.freedesktop.org
Cc: Ezequiel Garcia <ezequiel@vanguardiasur.com.ar>
Subject: Re: [PATCH] drm: Make drm.debug parameter description more helpful
Date: Wed, 20 Apr 2016 12:21:43 +0300	[thread overview]
Message-ID: <87mvoooct4.fsf@intel.com> (raw)
In-Reply-To: <1461087638-16959-2-git-send-email-ezequiel@vanguardiasur.com.ar>

On Tue, 19 Apr 2016, Ezequiel Garcia <ezequiel@vanguardiasur.com.ar> wrote:
> Let's be user-friendly and print an actually helpful parameter
> description.
>
> Signed-off-by: Ezequiel Garcia <ezequiel@vanguardiasur.com.ar>
> ---
>  drivers/gpu/drm/drm_drv.c | 13 +++++++++++--
>  1 file changed, 11 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_drv.c b/drivers/gpu/drm/drm_drv.c
> index 167c8d3d4a31..49b658069b51 100644
> --- a/drivers/gpu/drm/drm_drv.c
> +++ b/drivers/gpu/drm/drm_drv.c
> @@ -37,15 +37,24 @@
>  #include "drm_legacy.h"
>  #include "drm_internal.h"
>  
> -unsigned int drm_debug = 0;	/* bitmask of DRM_UT_x */
> +/*
> + * drm_debug: Enable debug output.
> + * Bitmask of DRM_UT_x. See include/drm/drmP.h for details.
> + */
> +unsigned int drm_debug = 0;
>  EXPORT_SYMBOL(drm_debug);
>  
>  MODULE_AUTHOR(CORE_AUTHOR);
>  MODULE_DESCRIPTION(CORE_DESC);
>  MODULE_LICENSE("GPL and additional rights");
> -MODULE_PARM_DESC(debug, "Enable debug output");
> +MODULE_PARM_DESC(debug, "Enables debug output, where each bit enables a debug category.\n"

Please keep it as "Enable".

> +"Bit 0 (0x1) will enable CORE messages (drm core code)\n"
> +"Bit 1 (0x2) will enable DRIVER messages (drm controller code)\n"
> +"Bit 2 (0x4) will enable KMS messages (modesetting code)\n"
> +"Bit 3 (0x8) will enable PRMIE messages (prime code)\n");

Maybe prefix the continuation lines with a space or a tab? The last line
probably shouldn't contain \n. See what modinfo(8) displays and make it
pretty.

>  module_param_named(debug, drm_debug, int, 0600);
>  
> +

Spurious whitepace.

>  static DEFINE_SPINLOCK(drm_minor_lock);
>  static struct idr drm_minors_idr;

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  parent reply	other threads:[~2016-04-20  9:21 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-19 17:40 [PATCH] drm: probe_helper: Hide ugly ifdef Ezequiel Garcia
2016-04-19 17:40 ` [PATCH] drm: Make drm.debug parameter description more helpful Ezequiel Garcia
2016-04-19 21:00   ` Emil Velikov
2016-04-20  9:21   ` Jani Nikula [this message]
2016-04-20 15:48     ` Ezequiel Garcia
2016-04-20 16:45   ` [PATCH v2] " Ezequiel Garcia
2016-04-21  7:32     ` Jani Nikula
2016-04-21  7:50       ` Daniel Vetter
2016-04-20  9:24 ` [PATCH] drm: probe_helper: Hide ugly ifdef Jani Nikula
2016-04-20 11:35   ` Daniel Vetter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87mvoooct4.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=ezequiel@vanguardiasur.com.ar \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox