Re: [RFC/PATCH] Documentation of kernel messages

!MAILaRCHIVE_VOTE_RePLACE
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
To: <holzheu@...>
Cc: <linux-kernel@...>, <randy.dunlap@...>, <akpm@...>, <gregkh@...>, <mtk-manpages@...>, <schwidefsky@...>, <heiko.carstens@...>
Date: Wednesday, June 13, 2007 - 12:37 pm

On Wed, 2007-06-13 at 17:06 +0200, holzheu wrote:

I'm not sure we want to make Linux more like z/* in this regard. :)

The problem with your proposal is that every time a new message in the
kernel is created or modified, you need somebody to go update that
documentation.  It's going to get out-of-sync very fast if this isn't
done, and you either need to convince and teach each and every kernel
contributor to follow your lead, or have a team of highly trained code
monkeys to watch git-commits and resubmit documentation for every diff
that touches a printk. 

I think it's a great idea to go and update some of these obtuse kernel
messages with more understandable wording.  It might even be nice to
update the Documentation/ about what kinds of messages are good or bad
to have.  But, I just don't think this is viable to convince everybody
to do this.  Do you have a list of printks that are causing your
customers trouble?

Does every printk need one of these?  What do we do with the existing
printks?  Who will convert them over?  How do we enforce the rules if
new printks must have documentation written for them?  Who writes the
documentation if the printk author does not?

If we have a catalog of kernel messages, it obviously needs to be
versioned, but does that mean that we need to keep it in the kernel
tree?

-- Dave

-
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
[RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 11:06 am)
Re: [RFC/PATCH] Documentation of kernel messages, David Miller, (Wed Jun 13, 2:23 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 2:27 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Andrew Morton, (Wed Jun 13, 2:15 pm)
Documentation of kernel messages (Summary), Michael Holzheu, (Mon Jun 25, 9:48 am)
Re: Documentation of kernel messages (Summary), Rob Landley, (Mon Jun 25, 11:44 am)
Re: Documentation of kernel messages (Summary), Michael Holzheu, (Wed Jun 27, 11:11 am)
Re: Documentation of kernel messages (Summary), Kunai, Takashi, (Mon Jul 9, 1:15 am)
Re: Documentation of kernel messages (Summary), Oliver Neukum, (Mon Jul 9, 3:01 am)
Re: Documentation of kernel messages (Summary), Satyam Sharma, (Mon Jul 9, 6:59 pm)
Re: Documentation of kernel messages (Summary), Oliver Neukum, (Tue Jul 10, 2:15 am)
Re: Documentation of kernel messages (Summary), H. Peter Anvin, (Mon Jul 9, 1:36 am)
Re: Documentation of kernel messages (Summary), Dave Young, (Tue Jul 10, 2:38 am)
Re: Documentation of kernel messages (Summary), Rob Landley, (Mon Jul 9, 12:48 pm)
RE: Documentation of kernel messages (Summary), Li Yang-r58472, (Tue Jul 10, 3:59 am)
Re: Documentation of kernel messages (Summary), Adrian Bunk, (Mon Jul 9, 2:33 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 10, 12:25 pm)
Re: Documentation of kernel messages (Summary), Tim Bird, (Mon Jul 16, 8:31 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 17, 12:29 pm)
Re: Documentation of kernel messages (Summary), H. Peter Anvin, (Mon Jul 16, 9:17 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 17, 12:42 pm)
Re: Documentation of kernel messages (Summary), Adrian Bunk, (Tue Jul 10, 2:54 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 10, 3:53 pm)
Re: Documentation of kernel messages (Summary) , Gerrit Huizenga, (Mon Jul 9, 1:18 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 10, 12:12 pm)
Re: Documentation of kernel messages (Summary), Li Yang, (Wed Jul 11, 10:26 am)
Re: Documentation of kernel messages (Summary), Rob Landley, (Wed Jul 11, 2:13 pm)
RE: Documentation of kernel messages (Summary), Li Yang-r58472, (Thu Jul 12, 9:53 am)
Re: Documentation of kernel messages (Summary), Rob Landley, (Thu Jul 12, 1:35 pm)
Re: Documentation of kernel messages (Summary), Li Yang, (Fri Jul 13, 7:54 am)
Re: Documentation of kernel messages (Summary), Rik van Riel, (Sun Jul 15, 4:30 pm)
Re: Documentation of kernel messages (Summary), Tsugikazu Shibata, (Thu Jul 12, 10:54 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Fri Jul 13, 1:12 pm)
Re: Documentation of kernel messages (Summary), Tsugikazu Shibata, (Fri Jul 13, 9:46 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Sat Jul 14, 10:12 pm)
Re: Documentation of kernel messages (Summary), Tsugikazu Shibata, (Sun Jul 15, 12:46 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Tue Jul 17, 12:06 pm)
Re: Documentation of kernel messages (Summary), Tsugikazu Shibata, (Tue Jul 17, 7:30 pm)
Re: Documentation of kernel messages (Summary), Tsugikazu Shibata, (Thu Jul 12, 12:41 pm)
[PATCH] Chinese Language Maintainer, Rob Landley, (Thu Jul 12, 12:05 pm)
Re: [PATCH] Chinese Language Maintainer, Li Yang, (Fri Jul 13, 8:43 am)
Re: [PATCH] Chinese Language Maintainer, Rob Landley, (Fri Jul 13, 1:52 pm)
Re: [PATCH] Chinese Language Maintainer, Li Yang, (Sun Jul 15, 10:42 am)
Re: [PATCH] Chinese Language Maintainer, Tsugikazu Shibata, (Sun Jul 15, 10:49 pm)
Re: [PATCH] Chinese Language Maintainer, Li Yang, (Tue Jul 17, 12:24 pm)
Re: [PATCH] Chinese Language Maintainer, Rob Landley, (Tue Jul 17, 5:06 pm)
Re: [PATCH] Chinese Language Maintainer, H. Peter Anvin, (Sun Jul 15, 11:03 pm)
Re: [PATCH] Chinese Language Maintainer, H. Peter Anvin, (Sun Jul 15, 2:12 pm)
Re: [PATCH] Chinese Language Maintainer, Rene Herman, (Sun Jul 15, 4:25 pm)
Re: [PATCH] Chinese Language Maintainer, Li Yang, (Sun Jul 15, 2:53 pm)
Re: [PATCH] Chinese Language Maintainer, Alan Cox, (Sun Jul 15, 2:50 pm)
Re: [PATCH] Chinese Language Maintainer, H. Peter Anvin, (Sun Jul 15, 3:11 pm)
Re: [PATCH] Chinese Language Maintainer, Rik van Riel, (Sun Jul 15, 4:25 pm)
Re: [PATCH] Chinese Language Maintainer, Pavel Machek, (Thu Jul 12, 4:02 pm)
Re: [PATCH] Chinese Language Maintainer, Rob Landley, (Fri Jul 13, 12:06 pm)
Re: [PATCH] Chinese Language Maintainer, Geert Uytterhoeven, (Fri Jul 13, 3:42 am)
Re: [PATCH] Chinese Language Maintainer, Geert Uytterhoeven, (Thu Jul 12, 3:52 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Thu Jul 12, 12:56 pm)
Re: Documentation of kernel messages (Summary), Theodore Tso, (Wed Jul 11, 5:32 pm)
Re: Documentation of kernel messages (Summary), Alan Cox, (Fri Jul 13, 6:53 am)
Re: Documentation of kernel messages (Summary), Rob Landley, (Fri Jul 13, 2:05 pm)
Re: Documentation of kernel messages (Summary), Randy Dunlap, (Fri Jul 13, 11:54 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Sat Jul 14, 9:56 pm)
Re: Documentation of kernel messages (Summary), Randy Dunlap, (Sun Jul 15, 12:28 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Mon Jul 16, 3:53 pm)
Re: Documentation of kernel messages (Summary), Randy Dunlap, (Fri Aug 3, 2:11 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Fri Aug 3, 3:32 pm)
Re: Documentation of kernel messages (Summary), Greg KH, (Fri Aug 3, 11:52 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Sat Aug 4, 2:54 pm)
Re: Documentation of kernel messages (Summary), Stefan Richter, (Sat Aug 4, 4:04 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Mon Aug 6, 11:50 am)
Re: Documentation of kernel messages (Summary), Greg KH, (Fri Aug 3, 11:50 pm)
Re: Documentation of kernel messages (Summary), Rob Landley, (Sat Aug 4, 3:02 pm)
Re: Documentation of kernel messages (Summary), Stefan Richter, (Fri Jul 13, 9:25 am)
Re: Documentation of kernel messages (Summary), Li Yang, (Fri Jul 13, 8:49 am)
Re: Documentation of kernel messages (Summary), Theodore Tso, (Fri Jul 13, 9:43 am)
Re: Documentation of kernel messages (Summary), Michael Holzheu, (Wed Jul 11, 8:15 am)
Re: Documentation of kernel messages (Summary), Sam Ravnborg, (Mon Jun 25, 2:05 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Jan Kara, (Thu Jun 14, 5:41 am)
Re: [RFC/PATCH] Documentation of kernel messages, Pavel Machek, (Fri Jun 15, 8:40 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Mon Jun 18, 9:42 am)
Re: [RFC/PATCH] Documentation of kernel messages, Pavel Machek, (Mon Jun 18, 10:02 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Thu Jun 14, 6:38 am)
Re: [RFC/PATCH] Documentation of kernel messages , Gerrit Huizenga, (Fri Jun 15, 2:42 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Tim Bird, (Mon Jun 18, 8:13 pm)
Re: [RFC/PATCH] Documentation of kernel messages , Gerrit Huizenga, (Mon Jun 18, 11:52 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Sam Ravnborg, (Mon Jun 18, 9:11 am)
Re: [RFC/PATCH] Documentation of kernel messages, Randy Dunlap, (Mon Jun 18, 11:35 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Mon Jun 18, 8:55 am)
Re: [RFC/PATCH] Documentation of kernel messages, Arjan van de Ven, (Mon Jun 18, 9:12 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Mon Jun 18, 9:53 am)
Re: [RFC/PATCH] Documentation of kernel messages, Arjan van de Ven, (Mon Jun 18, 9:36 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Tue Jun 19, 7:31 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Tue Jun 19, 4:51 am)
Re: [RFC/PATCH] Documentation of kernel messages, Arjan van de Ven, (Tue Jun 19, 3:24 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Jan Kara, (Mon Jun 18, 9:33 am)
Re: [RFC/PATCH] Documentation of kernel messages, Randy Dunlap, (Fri Jun 15, 2:51 pm)
Re: [RFC/PATCH] Documentation of kernel messages , Gerrit Huizenga, (Fri Jun 15, 3:27 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Greg KH, (Fri Jun 15, 4:01 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Thu Jun 14, 7:47 am)
Re: [RFC/PATCH] Documentation of kernel messages, Jan Kara, (Thu Jun 14, 8:26 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Thu Jun 14, 11:22 am)
Re: [RFC/PATCH] Documentation of kernel messages, Martin Schwidefsky, (Thu Jun 14, 4:31 am)
Re: [RFC/PATCH] Documentation of kernel messages, Greg KH, (Wed Jun 13, 1:51 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 2:18 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Joe Perches, (Wed Jun 13, 3:04 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Jan Engelhardt, (Fri Jun 15, 4:51 am)
Re: [RFC/PATCH] Documentation of kernel messages, H. Peter Anvin, (Thu Jun 14, 3:05 am)
Re: [RFC/PATCH] Documentation of kernel messages, Greg KH, (Wed Jun 13, 2:32 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Martin Schwidefsky, (Thu Jun 14, 4:17 am)
Re: [RFC/PATCH] Documentation of kernel messages, Kok, Auke, (Wed Jun 13, 2:49 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Dave Hansen, (Wed Jun 13, 2:49 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Alexey Dobriyan, (Wed Jun 13, 1:16 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 1:46 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Jan Engelhardt, (Fri Jun 15, 4:49 am)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 2:11 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Krzysztof Halasa, (Thu Jun 14, 4:47 am)
Re: [RFC/PATCH] Documentation of kernel messages, Rob Landley, (Wed Jun 13, 2:09 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Dave Hansen, (Wed Jun 13, 12:37 pm)
Re: [RFC/PATCH] Documentation of kernel messages, holzheu, (Wed Jun 13, 1:42 pm)
Re: [RFC/PATCH] Documentation of kernel messages, Sam Ravnborg, (Wed Jun 13, 1:11 pm)