public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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,
	Alessandro Zummo <a.zummo@towertech.it>,
	dri-devel@lists.freedesktop.org,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Alex Williamson <alex.williamson@redhat.com>,
	linux-pwm@vger.kernel.org, linux-remoteproc@vger.kernel.org,
	Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>,
	kvm@vger.kernel.org, Thierry Reding <thierry.reding@gmail.com>,
	Linus Walleij <linus.walleij@linaro.org>,
	kpreempt-tech@lists.sourceforge.net,
	Darren Hart <dvhart@infradead.org>,
	rtc-linux@googlegroups.com, linux-gpio@vger.kernel.org,
	Martin Mares <mj@ucw.cz>, Robert Love <rml@tech9.net>,
	Kirti Wankhede <kwankhede@nvidia.com>,
	Gustavo Padovan <gustavo@padovan.org>,
	Peter Zijlstra <peterz@infradead.org>,
	Alexandre Belloni <alexandre.belloni@free-electrons.com>,
	linux-wireless@vger.kernel.org, Ohad Ben-Cohen <ohad@wizery.com>,
	Johannes Berg <johannes@sipsolutions.net>,
	linux-video@atrey.karlin.mff.cuni.cz,
	Sumit Semwal <sumit.semwal@linaro.org>
Subject: [PATCH 00/29] Standardize doc formats - part 3
Date: Thu, 18 May 2017 22:25:44 -0300	[thread overview]
Message-ID: <cover.1495157082.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 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

             reply	other threads:[~2017-05-19  1:34 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-19  1:25 Mauro Carvalho Chehab [this message]
2017-05-19  1:25 ` [PATCH 01/29] pinctrl.txt: standardize document format Mauro Carvalho Chehab
2017-05-23  9:12   ` Linus Walleij
2017-06-17 15:03     ` Mauro Carvalho Chehab
2017-06-20 11:12       ` Linus Walleij
2017-05-19  1:25 ` [PATCH 02/29] pnp.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 03/29] preempt-locking.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 04/29] printk-formats.txt: " Mauro Carvalho Chehab
2017-05-19 10:26   ` Joe Perches
2017-05-19 20:28     ` Mauro Carvalho Chehab
2017-05-19 23:37       ` Randy Dunlap
2017-06-17 14:55         ` Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 05/29] pwm.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 06/29] rbtree.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 07/29] remoteproc.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 08/29] rfkill.txt: " Mauro Carvalho Chehab
2017-05-19 10:15   ` Johannes Berg
2017-05-19 11:11     ` Mauro Carvalho Chehab
2017-05-19 11:16       ` Johannes Berg
2017-05-19  1:25 ` [PATCH 09/29] robust-futex-ABI.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 10/29] robust-futexes.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 11/29] rpmsg.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 12/29] rtc.txt: " Mauro Carvalho Chehab
2017-05-31 11:17   ` Alexandre Belloni
2017-05-19  1:25 ` [PATCH 13/29] SAK.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 14/29] sgi-ioc4.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 15/29] siphash.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 16/29] SM501.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 17/29] smsc_ece1099.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 18/29] static-keys.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 19/29] svga.txt: " Mauro Carvalho Chehab
2017-05-19 13:50   ` Martin Mares
2017-05-19  1:26 ` [PATCH 20/29] sync_file.txt: " Mauro Carvalho Chehab
2017-05-25  1:36   ` Gustavo Padovan
2017-05-25  5:16     ` Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 21/29] this_cpu_ops.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 22/29] unaligned-memory-access.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 23/29] vfio-mediated-device.txt: " Mauro Carvalho Chehab
2017-05-22 19:38   ` Kirti Wankhede
2017-05-19  1:26 ` [PATCH 24/29] vfio.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 25/29] video-output.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 26/29] xillybus.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 27/29] xz.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 28/29] zorro.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 29/29] dell_rbu.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.1495157082.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=a.zummo@towertech.it \
    --cc=alex.williamson@redhat.com \
    --cc=alexandre.belloni@free-electrons.com \
    --cc=bjorn.andersson@linaro.org \
    --cc=boris.brezillon@free-electrons.com \
    --cc=computersforpeace@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cyrille.pitchen@atmel.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=dvhart@infradead.org \
    --cc=dwmw2@infradead.org \
    --cc=gustavo@padovan.org \
    --cc=johannes@sipsolutions.net \
    --cc=kpreempt-tech@lists.sourceforge.net \
    --cc=kvm@vger.kernel.org \
    --cc=kwankhede@nvidia.com \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linux-pwm@vger.kernel.org \
    --cc=linux-remoteproc@vger.kernel.org \
    --cc=linux-video@atrey.karlin.mff.cuni.cz \
    --cc=linux-wireless@vger.kernel.org \
    --cc=marek.vasut@gmail.com \
    --cc=mchehab@infradead.org \
    --cc=mingo@redhat.com \
    --cc=mj@ucw.cz \
    --cc=ohad@wizery.com \
    --cc=peterz@infradead.org \
    --cc=richard@nod.at \
    --cc=rml@tech9.net \
    --cc=rtc-linux@googlegroups.com \
    --cc=sumit.semwal@linaro.org \
    --cc=tglx@linutronix.de \
    --cc=thierry.reding@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