From: "Tobin C. Harding" <me@tobin.cc> To: Jonathan Corbet <corbet@lwn.net> Cc: Randy Dunlap <rdunlap@infradead.org>, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook <keescook@chromium.org>, Alexander Popov <alex.popov@linux.com>, Joe Perches <joe@perches.com>, kernel-hardening@lists.openwall.com Subject: Re: [PATCH v4 0/3] doc: update printk documentation Date: Fri, 22 Dec 2017 09:04:18 +1100 [thread overview] Message-ID: <20171221220418.GG6618@eros> (raw) In-Reply-To: <20171221122141.10604612@lwn.net> On Thu, Dec 21, 2017 at 12:21:41PM -0700, 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! Oh ok, I would have been happy to drag it over the holiday period and get it super correct. I'm always chasing perfection (even if seemingly a long way from it ;) so please never feel you have to rush things through. I'm happy to learn how to do it correctly and that will save everyone time in the future. > That said... I am happy also to patch on top of what was applied after Christmas break :) I don't want to create any extra work for anyone else. > - 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. Ok, I'm going to go with 'kernel' everywhere from now on. Despite having two degrees I am particularly crap at English [grammar]. Please do pick me up on any mistakes no matter how trivial. That is the only way to learn IMO. > - There's a dangling reference to printk-formats.txt in lib/vsprintf.c > that we'll want to fix up. Bad Tobin, no biscuit. > - 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... I don't quite understand this yet. (I added to my kernel list of things to learn and work on ;) thanks Jon. Merry Christmas, Tobin.
WARNING: multiple messages have this Message-ID (diff)
From: "Tobin C. Harding" <me@tobin.cc> To: Jonathan Corbet <corbet@lwn.net> Cc: Randy Dunlap <rdunlap@infradead.org>, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook <keescook@chromium.org>, Alexander Popov <alex.popov@linux.com>, Joe Perches <joe@perches.com>, kernel-hardening@lists.openwall.com Subject: [kernel-hardening] Re: [PATCH v4 0/3] doc: update printk documentation Date: Fri, 22 Dec 2017 09:04:18 +1100 [thread overview] Message-ID: <20171221220418.GG6618@eros> (raw) In-Reply-To: <20171221122141.10604612@lwn.net> On Thu, Dec 21, 2017 at 12:21:41PM -0700, 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! Oh ok, I would have been happy to drag it over the holiday period and get it super correct. I'm always chasing perfection (even if seemingly a long way from it ;) so please never feel you have to rush things through. I'm happy to learn how to do it correctly and that will save everyone time in the future. > That said... I am happy also to patch on top of what was applied after Christmas break :) I don't want to create any extra work for anyone else. > - 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. Ok, I'm going to go with 'kernel' everywhere from now on. Despite having two degrees I am particularly crap at English [grammar]. Please do pick me up on any mistakes no matter how trivial. That is the only way to learn IMO. > - There's a dangling reference to printk-formats.txt in lib/vsprintf.c > that we'll want to fix up. Bad Tobin, no biscuit. > - 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... I don't quite understand this yet. (I added to my kernel list of things to learn and work on ;) thanks Jon. Merry Christmas, Tobin.
next prev parent reply other threads:[~2017-12-21 22:04 UTC|newest] Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top 2017-12-19 21:17 [PATCH v4 0/3] doc: update printk documentation Tobin C. Harding 2017-12-19 21:17 ` [kernel-hardening] " Tobin C. Harding 2017-12-19 21:17 ` [PATCH v4 1/3] doc: convert printk-formats.txt to rst Tobin C. Harding 2017-12-19 21:17 ` [kernel-hardening] " Tobin C. Harding 2017-12-19 21:17 ` [PATCH v4 2/3] doc: update kptr_restrict documentation Tobin C. Harding 2017-12-19 21:17 ` [kernel-hardening] " Tobin C. Harding 2017-12-19 21:17 ` [PATCH v4 3/3] doc: add documentation on printing kernel addresses Tobin C. Harding 2017-12-19 21:17 ` [kernel-hardening] " Tobin C. Harding 2017-12-21 19:21 ` [PATCH v4 0/3] doc: update printk documentation Jonathan Corbet 2017-12-21 19:21 ` [kernel-hardening] " Jonathan Corbet 2017-12-21 19:26 ` Randy Dunlap 2017-12-21 19:26 ` [kernel-hardening] " Randy Dunlap 2017-12-21 21:59 ` Tobin C. Harding 2017-12-21 21:59 ` [kernel-hardening] " Tobin C. Harding 2017-12-21 19:30 ` Joe Perches 2017-12-21 19:30 ` [kernel-hardening] " Joe Perches 2017-12-21 19:34 ` Jonathan Corbet 2017-12-21 19:34 ` [kernel-hardening] " Jonathan Corbet 2017-12-21 22:04 ` Tobin C. Harding [this message] 2017-12-21 22:04 ` Tobin C. Harding
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20171221220418.GG6618@eros \ --to=me@tobin.cc \ --cc=alex.popov@linux.com \ --cc=corbet@lwn.net \ --cc=joe@perches.com \ --cc=keescook@chromium.org \ --cc=kernel-hardening@lists.openwall.com \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=rdunlap@infradead.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.