linux-kernel.vger.kernel.org archive mirror
 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>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-kernel@vger.kernel.org,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
	Markus Heiser <markus.heiser@darmarit.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jonathan Cameron <jic23@kernel.org>,
	Martyn Welch <martyn@welchs.me.uk>,
	"Luis R. Rodriguez" <mcgrof@kernel.org>,
	Oliver Neukum <oneukum@suse.com>
Subject: [PATCH 0/4] Some documentation fixes
Date: Mon, 17 Apr 2017 09:46:12 -0300	[thread overview]
Message-ID: <cover.1492432818.git.mchehab@s-opensource.com> (raw)

This patch series address a few issues at the documentation, after
applying this patch series:
   https://lkml.org/lkml/2017/4/16/2

The first patch solves a limitation with Sphinx and literal blocks
inside a footnote.

The next two patches fix issues with xpad.rst documentation, with
mentions /proc/bus/usb/, with used to be part of usbfs. When usbfs
got removed, the old location changed. So, update accordingly.

The final patch is RFC: it adds the uapi input.h file to the
documentation and groups the kAPI documentation generated from the
source code together with the kAPI part of the linux-input book.
We need to discuss it with documentation maintainers, to get an
agreement if this is the best way to handle it.

Mauro Carvalho Chehab (4):
  input: xpad.rst: usb/devices is now at /sys/kernel/debug/
  input: xpad.rst: Don't use literal blocks inside footnotes
  input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb
  [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book

 Documentation/driver-api/iio/intro.rst             |  4 +-
 Documentation/driver-api/index.rst                 |  1 -
 Documentation/input/devices/xpad.rst               | 53 +++++++++++-----------
 Documentation/input/input_kapi.rst                 |  1 +
 .../input.rst => input/input_kapi_symbols.rst}     |  6 ++-
 Documentation/input/input_uapi.rst                 |  1 +
 Documentation/input/input_uapi_symbols.rst         |  4 ++
 7 files changed, 38 insertions(+), 32 deletions(-)
 rename Documentation/{driver-api/input.rst => input/input_kapi_symbols.rst} (93%)
 create mode 100644 Documentation/input/input_uapi_symbols.rst

-- 
2.9.3

             reply	other threads:[~2017-04-17 12:47 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-17 12:46 Mauro Carvalho Chehab [this message]
2017-04-17 12:46 ` [PATCH 1/4] input: xpad.rst: usb/devices is now at /sys/kernel/debug/ Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov
2017-04-17 12:46 ` [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov
2017-04-17 12:46 ` [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb Mauro Carvalho Chehab
2017-04-18  3:11   ` Dmitry Torokhov
2017-04-17 12:46 ` [PATCH 4/4] [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book 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.1492432818.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=dmitry.torokhov@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jic23@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=martyn@welchs.me.uk \
    --cc=mcgrof@kernel.org \
    --cc=mchehab@infradead.org \
    --cc=oneukum@suse.com \
    --cc=rafael.j.wysocki@intel.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).