From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Jani Nikula <jani.nikula@intel.com>,
Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Sebastian Reichel <sre@kernel.org>
Subject: [PATCH 0/3] RFC: The beginning of a proper driver-api book
Date: Mon, 22 Aug 2016 14:57:40 -0600 [thread overview]
Message-ID: <1471899463-5774-1-git-send-email-corbet@lwn.net> (raw)
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.
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Sebastian Reichel <sre@kernel.org>
Jonathan Corbet (3):
Docs: sphinxify device-drivers.tmpl
docs: split up the driver book
docs: Pull HSI documentation together
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/index.rst | 24 ++
Documentation/driver-api/infrastructure.rst | 169 ++++++++
Documentation/driver-api/input.rst | 51 +++
Documentation/driver-api/message-based.rst | 30 ++
Documentation/driver-api/miscellaneous.rst | 50 +++
Documentation/driver-api/serial-interfaces.rst | 189 +++++++++
Documentation/driver-api/sound.rst | 54 +++
Documentation/hsi.txt | 75 ----
Documentation/index.rst | 1 +
MAINTAINERS | 2 +-
14 files changed, 752 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/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/serial-interfaces.rst
create mode 100644 Documentation/driver-api/sound.rst
delete mode 100644 Documentation/hsi.txt
--
2.7.4
next reply other threads:[~2016-08-22 20:58 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-22 20:57 Jonathan Corbet [this message]
2016-08-22 20:57 ` [PATCH 1/3] Docs: sphinxify device-drivers.tmpl Jonathan Corbet
2016-08-22 20:57 ` [PATCH 2/3] docs: split up the driver book Jonathan Corbet
2016-08-23 14:30 ` Mauro Carvalho Chehab
2016-08-24 22:46 ` Jonathan Corbet
2016-08-25 1:55 ` Mauro Carvalho Chehab
2016-08-25 20:09 ` Jonathan Corbet
2016-08-22 20:57 ` [PATCH 3/3] docs: Pull HSI documentation together Jonathan Corbet
2016-08-23 0:20 ` Sebastian Reichel
2016-09-06 15:12 ` Jonathan Corbet
2016-08-23 14:43 ` [PATCH 0/3] RFC: The beginning of a proper driver-api book Mauro Carvalho Chehab
2016-08-26 9:34 ` Markus Heiser
2016-08-26 9:59 ` Mauro Carvalho Chehab
2016-08-26 10:19 ` Jani Nikula
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=1471899463-5774-1-git-send-email-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@s-opensource.com \
--cc=sre@kernel.org \
/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
all inboxes | Powered by JetHome®