2011-03-07 19:54:12

by Roland Kammerer

[permalink] [raw]
Subject: [PATCH] Documentation/CodingStyle: fixed header file for pr_info() and pr_debug(). Removed unnecessary "Last updated" line

pr_info() and pr_debug() are in linux/printk.h
Last updated is unnecessary, we have git for that

Signed-off-by: Roland Kammerer <[email protected]>
---
Documentation/CodingStyle | 5 +----
1 files changed, 1 insertions(+), 4 deletions(-)

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 8bb3723..1cd3478 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -659,7 +659,7 @@ There are a number of driver model diagnostic
macros in <linux/device.h>
which you should use to make sure messages are matched to the right device
and driver, and are tagged with the right level: dev_err(), dev_warn(),
dev_info(), and so forth. For messages that aren't associated with a
-particular device, <linux/kernel.h> defines pr_debug() and pr_info().
+particular device, <linux/printk.h> defines pr_debug() and pr_info().

Coming up with good debugging messages can be quite a challenge; and once
you have them, they can be a huge help for remote troubleshooting. Such
@@ -819,6 +819,3 @@ language C, URL: http://www.open-std.org/JTC1/SC22/WG14/
Kernel CodingStyle, by [email protected] at OLS 2002:
http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/

---
-Last updated on 2007-July-13.
-
--
1.7.4.1


2011-03-08 20:09:14

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] Documentation/CodingStyle: fixed header file for pr_info() and pr_debug(). Removed unnecessary "Last updated" line

On Mon, 7 Mar 2011 20:54:09 +0100 Roland Kammerer wrote:

> pr_info() and pr_debug() are in linux/printk.h
> Last updated is unnecessary, we have git for that
>
> Signed-off-by: Roland Kammerer <[email protected]>
> ---
> Documentation/CodingStyle | 5 +----
> 1 files changed, 1 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> index 8bb3723..1cd3478 100644
> --- a/Documentation/CodingStyle
> +++ b/Documentation/CodingStyle
> @@ -659,7 +659,7 @@ There are a number of driver model diagnostic
> macros in <linux/device.h>

Hi,
I have applied this to my patch queue, but I had to fix it first.
Please note & prevent in the future: the long lines above were split (broken)
for you (or for us), probably by your email client.
Documentation/email-clients.txt may help you fix that.

> which you should use to make sure messages are matched to the right device
> and driver, and are tagged with the right level: dev_err(), dev_warn(),
> dev_info(), and so forth. For messages that aren't associated with a
> -particular device, <linux/kernel.h> defines pr_debug() and pr_info().
> +particular device, <linux/printk.h> defines pr_debug() and pr_info().
>
> Coming up with good debugging messages can be quite a challenge; and once
> you have them, they can be a huge help for remote troubleshooting. Such
> @@ -819,6 +819,3 @@ language C, URL: http://www.open-std.org/JTC1/SC22/WG14/
> Kernel CodingStyle, by [email protected] at OLS 2002:
> http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
>
> ---
> -Last updated on 2007-July-13.
> -
> --


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***