Re: [PATCH v4 0/3] doc: update printk documentation

Tobin C. Harding
2017-12-21T21:59:33Z

On Thu, Dec 21, 2017 at 11:26:22AM -0800, Randy Dunlap wrote:
> On 12/21/2017 11:21 AM, Jonathan Corbet wrote:
> > On Wed, 20 Dec 2017 08:17:14 +1100
> > "Tobin C. Harding" <me@tobin.cc> wrote:
> >
> >> This set converts printk-formats.txt -> core-api/printk-formats.rst
> >>
> >> We also update the documentation around printing kernel addresses.
> >>
> >> This is my first documentation conversion. Please do be hard on this
> >> patch series. I'd like to get it _really_ correct so that future
> >> conversions will require less review effort. Also if there are any
> >> peculiarities to patching docs (as apposed to C files) please say so.
> >>
> >> Thank you for the time already given to reviewing previous versions.
> >
> > So I spent a while thinking hard about how I could make Tobin do another
> > round or two on these patches. But then I figure that it's the holidays,
> > and I should just apply them. So that's done. Thanks for all of your
> > work on this!
> >
> > That said...
> >
> > - I don't quite understand why you capitalize "kernel" everywhere. I
> > vaguely recall some sort of discussion on that. To me it looks
> > strange...oh well.
>
> Mauro explained that he capitalizes Kernel when it is being used as a
> shortened version of "the Linux kernel," i.e., as a proper name,
> so I think that Tobin appropriated that style.
>
> It would be OK to undo that IMO.

I'm happy to write it however, if everyone is happy with 'kernel'
everywhere then that is good (and easier). I think Mauro is correct but
I also think Jon is correct, it does look funny. Code language doesn't
always follow English grammar rules after all.

thanks,
Tobin.