lkml.org 
[lkml]   [2017]   [May]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH 00/29] Standardize doc formats - part 3
Date
Each document under Documentation/*.txt has its own format.
Some follow markup notations, some don't even have a title!

In order to try to get some order on it, change the document
style to the standard we're adopting after the adoption of
ReStructured Text.

The documents touched on this series now build fine with
Sphinx, if renamed to *.rst extension.

The main goal with this is to teach people by example about
what format is expected on newer documents. It also helps
to add those files to Kernel books.

In order to make things more palatable, I'm spliting the
conversion into three parts.

This is part 3.

Mauro Carvalho Chehab (29):
pinctrl.txt: standardize document format
pnp.txt: standardize document format
preempt-locking.txt: standardize document format
printk-formats.txt: standardize document format
pwm.txt: standardize document format
rbtree.txt: standardize document format
remoteproc.txt: standardize document format
rfkill.txt: standardize document format
robust-futex-ABI.txt: standardize document format
robust-futexes.txt: standardize document format
rpmsg.txt: standardize document format
rtc.txt: standardize document format
SAK.txt: standardize document format
sgi-ioc4.txt: standardize document format
siphash.txt: standardize document format
SM501.txt: standardize document format
smsc_ece1099.txt: standardize document format
static-keys.txt: standardize document format
svga.txt: standardize document format
sync_file.txt: standardize document format
this_cpu_ops.txt: standardize document format
unaligned-memory-access.txt: standardize document format
vfio-mediated-device.txt: standardize document format
vfio.txt: standardize document format
video-output.txt: standardize document format
xillybus.txt: standardize document format
xz.txt: standardize document format
zorro.txt: standardize document format
dell_rbu.txt: standardize document format

Documentation/SAK.txt | 65 +-
Documentation/SM501.txt | 9 +-
Documentation/dell_rbu.txt | 81 ++-
Documentation/pinctrl.txt | 1104 +++++++++++++++--------------
Documentation/pnp.txt | 343 +++++----
Documentation/preempt-locking.txt | 40 +-
Documentation/printk-formats.txt | 416 ++++++-----
Documentation/pwm.txt | 46 +-
Documentation/rbtree.txt | 88 +--
Documentation/remoteproc.txt | 320 +++++----
Documentation/rfkill.txt | 47 +-
Documentation/robust-futex-ABI.txt | 14 +-
Documentation/robust-futexes.txt | 12 +-
Documentation/rpmsg.txt | 340 +++++----
Documentation/rtc.txt | 44 +-
Documentation/sgi-ioc4.txt | 4 +
Documentation/siphash.txt | 186 ++---
Documentation/smsc_ece1099.txt | 4 +
Documentation/static-keys.txt | 199 +++---
Documentation/svga.txt | 146 ++--
Documentation/sync_file.txt | 23 +-
Documentation/this_cpu_ops.txt | 49 +-
Documentation/unaligned-memory-access.txt | 57 +-
Documentation/vfio-mediated-device.txt | 252 +++----
Documentation/vfio.txt | 261 +++----
Documentation/video-output.txt | 54 +-
Documentation/xillybus.txt | 29 +-
Documentation/xz.txt | 182 ++---
Documentation/zorro.txt | 59 +-
29 files changed, 2437 insertions(+), 2037 deletions(-)

--
2.9.4


\
 
 \ /
  Last update: 2017-05-19 03:35    [W:0.170 / U:1.316 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site