Follow @Openwall on Twitter for new release announcements and other news
[<prev] [next>] [thread-next>] [day] [month] [year] [list] 
Message-Id: <1513718237-24140-1-git-send-email-me@tobin.cc>
Date: Wed, 20 Dec 2017 08:17:14 +1100
From: "Tobin C. Harding" <me@...in.cc>
To: Jonathan Corbet <corbet@....net>
Cc: "Tobin C. Harding" <me@...in.cc>,
	Randy Dunlap <rdunlap@...radead.org>,
	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: [PATCH v4 0/3] doc: update printk documentation

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

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.