[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <427c0072-8bdc-82a6-2efb-d43c22ee8eb1@infradead.org>
Date: Thu, 21 Dec 2017 11:26:22 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Jonathan Corbet <corbet@....net>, "Tobin C. Harding" <me@...in.cc>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
Kees Cook <keescook@...omium.org>, Alexander Popov <alex.popov@...ux.com>,
Joe Perches <joe@...ches.com>, kernel-hardening@...ts.openwall.com
Subject: Re: [PATCH v4 0/3] doc: update printk documentation
On 12/21/2017 11:21 AM, Jonathan Corbet wrote:
> On Wed, 20 Dec 2017 08:17:14 +1100
> "Tobin C. Harding" <me@...in.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.
> - There's a dangling reference to printk-formats.txt in lib/vsprintf.c
> that we'll want to fix up.
>
> - The vsprintf kerneldoc currently gets pulled into the big "kernel API"
> dumpster. Someday, it would be nice to turn printk-formats.rst into a
> "how to output data from the kernel" section, with documentation on
> vnsprintf, printk, trace_printk, and format strings all in one place.
> What a fine day that would be...
--
~Randy
Powered by blists - more mailing lists
Confused about mailing lists and their use?
Read about mailing lists on Wikipedia
and check out these
guidelines on proper formatting of your messages.
