linux-kernel - [PATCH 0/4] Some documentation fixes

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <cover.1492432818.git.mchehab@s-opensource.com>
Date:   Mon, 17 Apr 2017 09:46:12 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Markus Heiser <markus.heiser@...marit.de>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jonathan Cameron <jic23@...nel.org>,
        Martyn Welch <martyn@...chs.me.uk>,
        "Luis R. Rodriguez" <mcgrof@...nel.org>,
        Oliver Neukum <oneukum@...e.com>
Subject: [PATCH 0/4] Some documentation fixes

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