linux-kernel - Re: Subject: [PATCH v2 1/1] Add documentation for proper usage and order of preference of calls to print diagnostic messages.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <1393953218.20435.34.camel@joe-AO722>
Date:	Tue, 04 Mar 2014 09:13:38 -0800
From:	Joe Perches <joe@...ches.com>
To:	yogesh <mr.yogesh@...il.com>
Cc:	LKML <linux-kernel@...r.kernel.org>,
	Levente Kurusa <levex@...ux.com>, rdunlap@...radead.org
Subject: Re: Subject: [PATCH v2 1/1] Add documentation for proper usage and
 order of preference of calls to print diagnostic messages.

On Tue, 2014-03-04 at 22:31 +0530, yogesh wrote:
> This patch adds documentation that clarifies the use of various
> diagnostic printing messages. It shows the preference of subsystem_dbg
> calls to dev_dbg (whenever possible), as the first preferred format of
> logging debug messages.
> Signed-off-by: Yogesh Chaudhari <mr.yogesh@...il.com>

Just two small things for next time, not enough
for a resend, but please add a blank line between
the commit log and the Signed-off line

commit message lines wrapped at around 70 columns
and another line...

Signed-off-by: Your Name <email@...ress.tld>

and...

> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
[]
> @@ -662,6 +662,23 @@ and driver, and are tagged with the right level:  dev_err(), dev_warn(),

> +Depending on your changes, the following order of precedence
> +applies to printing messages:
> +1. [subsystem]_dbg() is preferred when the subsystem has its own
> +diagnostic macros.
> +2. dev_dbg() is preferred when you have a generic struct device object.
> +3. pr_debug() should be used when 1 and 2 above are not applicable.
> +4. printk() should be avoided.

Another of my preferences would be to indent wrapped
lines when using numbered or bulleted lists.

1. [subsystem]_dbg is preferred when the subsystem has its own
   diagnostic macros or functions.
2. dev_dbg is ...
3. pr_debug ...
4. printk() ...


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/