From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
David Woodhouse <dwmw2@infradead.org>,
Brian Norris <computersforpeace@gmail.com>,
Boris Brezillon <boris.brezillon@free-electrons.com>,
Marek Vasut <marek.vasut@gmail.com>,
Richard Weinberger <richard@nod.at>,
Cyrille Pitchen <cyrille.pitchen@atmel.com>,
linux-mtd@lists.infradead.org,
Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>,
Thomas Gleixner <tglx@linutronix.de>,
Ingo Molnar <mingo@redhat.com>,
Masami Hiramatsu <mhiramat@kernel.org>,
Peter Zijlstra <peterz@infradead.org>,
William Breathitt Gray <vilhelm.gray@gmail.com>,
Steffen Klassert <steffen.klassert@secunet.com>,
Sudip Mukherjee <sudipm.mukherjee@gmail.com>,
Johannes Thumshirn <morbidrsa@gmail.com>,
linux-crypto@vger.kernel.org,
"David S. Miller" <davem@davemloft.net>,
"Richard Russon (FlatCap)" <ldm@flatcap.org>,
Jaroslav Kysela <perex@perex.cz>,
openipmi-developer@lists.sourceforge.net,
Marc Zyngier <marc.zyngier@arm.com>,
Darren Hart <dvhart@infradead.org>,
linux-ntfs-dev@lists.sourceforge.net,
Ananth N Mavinakayanahalli <ananth@linux.vnet.ibm.com>,
Corey Minyard <minyard@acm.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: [PATCH 00/30] Standardize doc formats - part 2
Date: Thu, 18 May 2017 22:23:52 -0300 [thread overview]
Message-ID: <cover.1495156975.git.mchehab@s-opensource.com> (raw)
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 2.
Mauro Carvalho Chehab (30):
iostats.txt: update it to cover recent Kernels
IPMI.txt: standardize document format
IRQ-affinity.txt: standardize document format
IRQ-domain.txt: standardize document format
irqflags-tracing.txt: standardize document format
IRQ.txt: add a markup for its title
isapnp.txt: promote title level
isa.txt: standardize document format
kernel-per-CPU-kthreads.txt: standardize document format
kobject.txt: standardize document format
kprobes.txt: standardize document format
kref.txt: standardize document format
kselftest.txt: standardize document format
ldm.txt: standardize document format
lockup-watchdogs.txt: standardize document format
lzo.txt: standardize document format
mailbox.txt: standardize document format
memory-barriers.txt: standardize document format
memory-barriers.txt: use literals for variables
memory-hotplug.txt: standardize document format
men-chameleon-bus.txt: standardize document format
nommu-mmap.txt: standardize document format
nommu-mmap.txt: don't use all upper case on titles
ntb.txt: standardize document format
numastat.txt: standardize document format
padata.txt: standardize document format
parport-lowlevel.txt: standardize document format
percpu-rw-semaphore.txt: standardize document format
phy.txt: standardize document format
pi-futex.txt: standardize document format
Documentation/IPMI.txt | 76 +-
Documentation/IRQ-affinity.txt | 77 +-
Documentation/IRQ-domain.txt | 69 +-
Documentation/IRQ.txt | 2 +
Documentation/iostats.txt | 44 +-
Documentation/irqflags-tracing.txt | 10 +-
Documentation/isa.txt | 53 +-
Documentation/isapnp.txt | 1 +
Documentation/kernel-per-CPU-kthreads.txt | 156 +++-
Documentation/kobject.txt | 69 +-
Documentation/kprobes.txt | 450 ++++++----
Documentation/kref.txt | 285 ++++---
Documentation/kselftest.txt | 37 +-
Documentation/ldm.txt | 54 +-
Documentation/lockup-watchdogs.txt | 3 +-
Documentation/lzo.txt | 27 +-
Documentation/mailbox.txt | 181 ++--
Documentation/memory-barriers.txt | 794 +++++++++---------
Documentation/memory-hotplug.txt | 357 ++++----
Documentation/men-chameleon-bus.txt | 298 +++----
Documentation/nommu-mmap.txt | 68 +-
Documentation/ntb.txt | 55 +-
Documentation/numastat.txt | 5 +-
Documentation/padata.txt | 27 +-
Documentation/parport-lowlevel.txt | 1303 ++++++++++++++++++-----------
Documentation/percpu-rw-semaphore.txt | 3 +-
Documentation/phy.txt | 106 ++-
Documentation/pi-futex.txt | 15 +-
28 files changed, 2683 insertions(+), 1942 deletions(-)
--
2.9.4
next reply other threads:[~2017-05-19 1:24 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-19 1:23 Mauro Carvalho Chehab [this message]
2017-05-19 1:23 ` [PATCH 01/30] iostats.txt: update it to cover recent Kernels Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 02/30] IPMI.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 03/30] IRQ-affinity.txt: " Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 04/30] IRQ-domain.txt: " Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 05/30] irqflags-tracing.txt: " Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 06/30] IRQ.txt: add a markup for its title Mauro Carvalho Chehab
2017-05-19 1:23 ` [PATCH 07/30] isapnp.txt: promote title level Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 08/30] isa.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 2:13 ` William Breathitt Gray
2017-05-19 8:55 ` Mauro Carvalho Chehab
2017-05-19 11:36 ` William Breathitt Gray
2017-05-19 1:24 ` [PATCH 09/30] kernel-per-CPU-kthreads.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 10/30] kobject.txt: " Mauro Carvalho Chehab
2017-05-19 5:35 ` Greg Kroah-Hartman
2017-05-19 1:24 ` [PATCH 11/30] kprobes.txt: " Mauro Carvalho Chehab
2017-05-19 14:38 ` Masami Hiramatsu
2017-05-19 1:24 ` [PATCH 12/30] kref.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 13/30] kselftest.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 14/30] ldm.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 15/30] lockup-watchdogs.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 16/30] lzo.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 17/30] mailbox.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 18/30] memory-barriers.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 19/30] memory-barriers.txt: use literals for variables Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 20/30] memory-hotplug.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 21/30] men-chameleon-bus.txt: " Mauro Carvalho Chehab
2017-05-19 6:59 ` Johannes Thumshirn
2017-05-19 1:24 ` [PATCH 22/30] nommu-mmap.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 23/30] nommu-mmap.txt: don't use all upper case on titles Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 24/30] ntb.txt: standardize document format Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 25/30] numastat.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 26/30] padata.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 27/30] parport-lowlevel.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 28/30] percpu-rw-semaphore.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 29/30] phy.txt: " Mauro Carvalho Chehab
2017-05-19 1:24 ` [PATCH 30/30] pi-futex.txt: " Mauro Carvalho Chehab
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=cover.1495156975.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=ananth@linux.vnet.ibm.com \
--cc=anil.s.keshavamurthy@intel.com \
--cc=boris.brezillon@free-electrons.com \
--cc=computersforpeace@gmail.com \
--cc=corbet@lwn.net \
--cc=cyrille.pitchen@atmel.com \
--cc=davem@davemloft.net \
--cc=dvhart@infradead.org \
--cc=dwmw2@infradead.org \
--cc=gregkh@linuxfoundation.org \
--cc=ldm@flatcap.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=linux-ntfs-dev@lists.sourceforge.net \
--cc=marc.zyngier@arm.com \
--cc=marek.vasut@gmail.com \
--cc=mchehab@infradead.org \
--cc=mhiramat@kernel.org \
--cc=mingo@redhat.com \
--cc=minyard@acm.org \
--cc=morbidrsa@gmail.com \
--cc=openipmi-developer@lists.sourceforge.net \
--cc=perex@perex.cz \
--cc=peterz@infradead.org \
--cc=richard@nod.at \
--cc=steffen.klassert@secunet.com \
--cc=sudipm.mukherjee@gmail.com \
--cc=tglx@linutronix.de \
--cc=vilhelm.gray@gmail.com \
/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;
as well as URLs for NNTP newsgroup(s).