public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Tobin C. Harding" <me@tobin.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: [PATCH v4 0/3] doc: update printk documentation
Date: Wed, 20 Dec 2017 08:17:14 +1100	[thread overview]
Message-ID: <1513718237-24140-1-git-send-email-me@tobin.cc> (raw)

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.

thanks,
Tobin.

v4:
 - fix typo 'kpt_restrict' -> 'kptr_restrict' (thanks Randy).

v3:
 - Update filename .txt -> .rst in lib/vsnprintf.c comment (Joe Perches)
 - Remove unnecessary commas (as suggested by Randy Dunlap)
 - Re-apply theory 'make as few changes as possible to complete the
   conversion'

v2:
 - Remove conversion/inclusion of kernel-docs from lib/vsprintf.c
 - Add '<>' around file name (in section 'Thanks').
 - Remove a few more double back ticks.
 - Apply theory 'make as few changes as possible to complete the
   conversion'

Tobin C. Harding (3):
  doc: convert printk-formats.txt to rst
  doc: update kptr_restrict documentation
  doc: add documentation on printing kernel addresses

 Documentation/00-INDEX                             |   2 -
 Documentation/core-api/index.rst                   |   1 +
 .../printk-formats.rst}                            | 229 +++++++++++----------
 Documentation/security/self-protection.rst         |  15 ++
 Documentation/sysctl/kernel.txt                    |   3 +-
 lib/vsprintf.c                                     |   3 +-
 6 files changed, 139 insertions(+), 114 deletions(-)
 rename Documentation/{printk-formats.txt => core-api/printk-formats.rst} (63%)

-- 
2.7.4

             reply	other threads:[~2017-12-19 21:17 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-19 21:17 Tobin C. Harding [this message]
2017-12-19 21:17 ` [PATCH v4 1/3] doc: convert printk-formats.txt to rst 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 ` [PATCH v4 3/3] doc: add documentation on printing kernel addresses Tobin C. Harding
2017-12-21 19:21 ` [PATCH v4 0/3] doc: update printk documentation Jonathan Corbet
2017-12-21 19:26   ` Randy Dunlap
2017-12-21 21:59     ` Tobin C. Harding
2017-12-21 19:30   ` Joe Perches
2017-12-21 19:34     ` Jonathan Corbet
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=1513718237-24140-1-git-send-email-me@tobin.cc \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox