From: "Tobin C. Harding" <me@tobin.cc>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
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 08:59:26 +1100 [thread overview]
Message-ID: <20171221215926.GF6618@eros> (raw)
In-Reply-To: <427c0072-8bdc-82a6-2efb-d43c22ee8eb1@infradead.org>
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.
WARNING: multiple messages have this Message-ID (diff)
From: "Tobin C. Harding" <me@tobin.cc>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
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 08:59:26 +1100 [thread overview]
Message-ID: <20171221215926.GF6618@eros> (raw)
In-Reply-To: <427c0072-8bdc-82a6-2efb-d43c22ee8eb1@infradead.org>
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.
next prev parent reply other threads:[~2017-12-21 21:59 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-19 21:17 [kernel-hardening] [PATCH v4 0/3] doc: update printk documentation Tobin C. Harding
2017-12-19 21:17 ` Tobin C. Harding
2017-12-19 21:17 ` [kernel-hardening] [PATCH v4 1/3] doc: convert printk-formats.txt to rst Tobin C. Harding
2017-12-19 21:17 ` Tobin C. Harding
2017-12-19 21:17 ` [kernel-hardening] [PATCH v4 2/3] doc: update kptr_restrict documentation Tobin C. Harding
2017-12-19 21:17 ` Tobin C. Harding
2017-12-19 21:17 ` [kernel-hardening] [PATCH v4 3/3] doc: add documentation on printing kernel addresses Tobin C. Harding
2017-12-19 21:17 ` Tobin C. Harding
2017-12-21 19:21 ` [kernel-hardening] Re: [PATCH v4 0/3] doc: update printk documentation Jonathan Corbet
2017-12-21 19:21 ` Jonathan Corbet
2017-12-21 19:26 ` [kernel-hardening] " Randy Dunlap
2017-12-21 19:26 ` Randy Dunlap
2017-12-21 21:59 ` Tobin C. Harding [this message]
2017-12-21 21:59 ` Tobin C. Harding
2017-12-21 19:30 ` [kernel-hardening] " Joe Perches
2017-12-21 19:30 ` Joe Perches
2017-12-21 19:34 ` [kernel-hardening] " Jonathan Corbet
2017-12-21 19:34 ` Jonathan Corbet
2017-12-21 22:04 ` [kernel-hardening] " Tobin C. Harding
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=20171221215926.GF6618@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: link
Be 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.