From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756493AbcHVU6S (ORCPT ); Mon, 22 Aug 2016 16:58:18 -0400 Received: from tex.lwn.net ([70.33.254.29]:47218 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753017AbcHVU6Q (ORCPT ); Mon, 22 Aug 2016 16:58:16 -0400 From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jonathan Corbet , Jani Nikula , Mauro Carvalho Chehab , Sebastian Reichel Subject: [PATCH 0/3] RFC: The beginning of a proper driver-api book Date: Mon, 22 Aug 2016 14:57:40 -0600 Message-Id: <1471899463-5774-1-git-send-email-corbet@lwn.net> X-Mailer: git-send-email 2.7.4 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 Cc: Mauro Carvalho Chehab Cc: Sebastian Reichel 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