linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/4] Some documentation fixes
@ 2017-04-17 12:46 Mauro Carvalho Chehab
  2017-04-17 12:46 ` [PATCH 1/4] input: xpad.rst: usb/devices is now at /sys/kernel/debug/ Mauro Carvalho Chehab
                   ` (3 more replies)
  0 siblings, 4 replies; 8+ messages in thread
From: Mauro Carvalho Chehab @ 2017-04-17 12:46 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, Jonathan Corbet,
	linux-kernel, Dmitry Torokhov, Rafael J. Wysocki, Markus Heiser,
	Greg Kroah-Hartman, Jonathan Cameron, Martyn Welch,
	Luis R. Rodriguez, Oliver Neukum

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

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2017-04-18  3:11 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-04-17 12:46 [PATCH 0/4] Some documentation fixes Mauro Carvalho Chehab
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

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).