Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1624662

[PATCH 0/4] Some documentation fixes

Show all headers | View 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

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH 0/4] Some documentation fixes Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
  [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside footnotes Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
    Re: [PATCH 2/4] input: xpad.rst: Don't use literal blocks inside  footnotes Dmitry Torokhov <dmitry.torokhov@gmail.com> - 2017-04-18 05:20 +0200
  [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-04-17 14:50 +0200
    Re: [PATCH 3/4] input: xpad.rst: proc/bus/usb was renamed to  dev/bus/usb Dmitry Torokhov <dmitry.torokhov@gmail.com> - 2017-04-18 05:20 +0200

csiph-web