linux-kernel - [PATCH 0/5 V2] The beginning of a proper driver-api book

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: <1473175442-13277-1-git-send-email-corbet@lwn.net>
Date:   Tue,  6 Sep 2016 09:23:57 -0600
From:   Jonathan Corbet <corbet@....net>
To:     linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, Jani Nikula <jani.nikula@...el.com>,
        Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Daniel Vetter <daniel.vetter@...ll.ch>,
        Jonathan Corbet <corbet@....net>,
        Sebastian Reichel <sre@...nel.org>
Subject: [PATCH 0/5 V2] The beginning of a proper driver-api book

This short series convers device-drivers.tmpl into the RST format, splits
it up, and sets up the result under Documentation/driver-api/.  For added
fun, I've taken one top-level file (hsi.txt) and folded it into the
document as a way of showing the direction I'm thinking I would like things
to go.  There is plenty more of this sort of work that could be done, to
say the least - this is just a beginning!

The formatted results can be seen at:

    http://static.lwn.net/kerneldoc/driver-api/index.html

As part of the long-term task to turn Documentation/ into less of a horror
movie, I'd like to collect documentation of the driver-specific API here.
Arguably gpu/ and the media API stuff should eventually move here, though
we can discuss the color of that particular shed some other day.
Meanwhile, I'd appreciate comments on the general idea.

V2 changes:
  - Split apart the "serial interfaces" documents into per-subsystem files
  - Remove section numbers from hsi.rst.  We can have Sphinx put them back
    globally if that's what we want.
  - Remove the internal MPT docs which don't really belong here
  - [outside this series] Fixed up some formatting issues in kerneldoc
    comments
  - Hopefully this is about ready to go...

Cc: Sebastian Reichel <sre@...nel.org>

Jonathan Corbet (5):
  Docs: sphinxify device-drivers.tmpl
  docs: split up the driver book
  docs: Pull the HSI documentation together
  docs: split up serial-interfaces.rst
  docs: Don't format internal MPT docs

 Documentation/DocBook/Makefile              |   2 +-
 Documentation/DocBook/device-drivers.tmpl   | 521 ----------------------------
 Documentation/driver-api/basics.rst         | 120 +++++++
 Documentation/driver-api/frame-buffer.rst   |  62 ++++
 Documentation/driver-api/hsi.rst            |  88 +++++
 Documentation/driver-api/i2c.rst            |  46 +++
 Documentation/driver-api/index.rst          |  26 ++
 Documentation/driver-api/infrastructure.rst | 169 +++++++++
 Documentation/driver-api/input.rst          |  51 +++
 Documentation/driver-api/message-based.rst  |  12 +
 Documentation/driver-api/miscellaneous.rst  |  50 +++
 Documentation/driver-api/sound.rst          |  54 +++
 Documentation/driver-api/spi.rst            |  53 +++
 Documentation/hsi.txt                       |  75 ----
 Documentation/index.rst                     |   1 +
 MAINTAINERS                                 |   2 +-
 16 files changed, 734 insertions(+), 598 deletions(-)
 delete mode 100644 Documentation/DocBook/device-drivers.tmpl
 create mode 100644 Documentation/driver-api/basics.rst
 create mode 100644 Documentation/driver-api/frame-buffer.rst
 create mode 100644 Documentation/driver-api/hsi.rst
 create mode 100644 Documentation/driver-api/i2c.rst
 create mode 100644 Documentation/driver-api/index.rst
 create mode 100644 Documentation/driver-api/infrastructure.rst
 create mode 100644 Documentation/driver-api/input.rst
 create mode 100644 Documentation/driver-api/message-based.rst
 create mode 100644 Documentation/driver-api/miscellaneous.rst
 create mode 100644 Documentation/driver-api/sound.rst
 create mode 100644 Documentation/driver-api/spi.rst
 delete mode 100644 Documentation/hsi.txt

-- 
2.7.4