OSDN Git Service

doc: convert printk-formats.txt to rst
authorTobin C. Harding <me@tobin.cc>
Tue, 19 Dec 2017 21:17:15 +0000 (08:17 +1100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 21 Dec 2017 20:39:07 +0000 (13:39 -0700)
commitb3ed23213eab1e08be594ad44b4237588c58af09
tree535a4c3ab48598e57bd938eaaff90b39558e56fe
parent2a7c7cba38f4176af081de74e82b61aeae4feaa1
doc: convert printk-formats.txt to rst

Documentation/printk-formats.txt is a candidate for conversion to
ReStructuredText format. Some effort has already been made to do this
conversion even thought the suffix is currently .txt

Changes required to complete conversion

 - Move printk-formats.txt to core-api/printk-formats.rst
 - Add entry to Documentation/core-api/index.rst
 - Remove entry from Documentation/00-INDEX
 - Fix minor grammatical errors.
 - Order heading adornments as suggested by rst docs.
 - Use 'Passed by reference' uniformly.
 - Update pointer documentation around %px specifier.
 - Fix erroneous double backticks (to commas).
 - Remove extraneous double backticks (suggested by Jonathan Corbet).
 - Simplify documentation for kobject.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
[jc: downcased "kernel"]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/00-INDEX
Documentation/core-api/index.rst
Documentation/core-api/printk-formats.rst [moved from Documentation/printk-formats.txt with 64% similarity]
lib/vsprintf.c