From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755367AbdLUT0m (ORCPT ); Thu, 21 Dec 2017 14:26:42 -0500 Received: from merlin.infradead.org ([205.233.59.134]:33104 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752522AbdLUT0j (ORCPT ); Thu, 21 Dec 2017 14:26:39 -0500 Subject: Re: [PATCH v4 0/3] doc: update printk documentation To: Jonathan Corbet , "Tobin C. Harding" Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook , Alexander Popov , Joe Perches , kernel-hardening@lists.openwall.com References: <1513718237-24140-1-git-send-email-me@tobin.cc> <20171221122141.10604612@lwn.net> From: Randy Dunlap Message-ID: <427c0072-8bdc-82a6-2efb-d43c22ee8eb1@infradead.org> Date: Thu, 21 Dec 2017 11:26:22 -0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.0 MIME-Version: 1.0 In-Reply-To: <20171221122141.10604612@lwn.net> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 12/21/2017 11:21 AM, Jonathan Corbet wrote: > On Wed, 20 Dec 2017 08:17:14 +1100 > "Tobin C. Harding" 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