mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	David Woodhouse <dwmw2@infradead.org>,
	Brian Norris <computersforpeace@gmail.com>,
	Boris Brezillon <boris.brezillon@free-electrons.com>,
	Marek Vasut <marek.vasut@gmail.com>,
	Richard Weinberger <richard@nod.at>,
	Cyrille Pitchen <cyrille.pitchen@atmel.com>,
	linux-mtd@lists.infradead.org,
	Jani Nikula <jani.nikula@intel.com>,
	Markus Heiser <markus.heiser@darmarit.de>,
	"Herton R. Krzesinski" <herton@redhat.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>
Subject: [PATCH v2 35/53] docs-rst: convert rapidio book to ReST
Date: Tue, 16 May 2017 09:16:27 -0300	[thread overview]
Message-ID: <e85ca0a31f1a2e71a9fe09a3abe55476fc3a25ca.1494935649.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1494935649.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1494935649.git.mchehab@s-opensource.com>

Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/DocBook/Makefile       |   4 +-
 Documentation/DocBook/rapidio.tmpl   | 155 -----------------------------------
 Documentation/driver-api/index.rst   |   1 +
 Documentation/driver-api/rapidio.rst | 107 ++++++++++++++++++++++++
 4 files changed, 110 insertions(+), 157 deletions(-)
 delete mode 100644 Documentation/DocBook/rapidio.tmpl
 create mode 100644 Documentation/driver-api/rapidio.rst

diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index 3bbda02d6aee..baedb14f3b40 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -8,8 +8,8 @@
 
 DOCBOOKS := \
 	    lsm.xml \
-	    mtdnand.xml librs.xml rapidio.xml \
-	    sh.xml w1.xml
+	    mtdnand.xml librs.xml \
+	    sh.xml
 
 ifeq ($(DOCBOOKS),)
 
diff --git a/Documentation/DocBook/rapidio.tmpl b/Documentation/DocBook/rapidio.tmpl
deleted file mode 100644
index ac3cca3399a1..000000000000
--- a/Documentation/DocBook/rapidio.tmpl
+++ /dev/null
@@ -1,155 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-        "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-	<!ENTITY rapidio SYSTEM "rapidio.xml">
-	]>
-
-<book id="RapidIO-Guide">
- <bookinfo>
-  <title>RapidIO Subsystem Guide</title>
-
-  <authorgroup>
-   <author>
-    <firstname>Matt</firstname>
-    <surname>Porter</surname>
-    <affiliation>
-     <address>
-      <email>mporter@kernel.crashing.org</email>
-      <email>mporter@mvista.com</email>
-     </address>
-    </affiliation>
-   </author>
-  </authorgroup>
-
-  <copyright>
-   <year>2005</year>
-   <holder>MontaVista Software, Inc.</holder>
-  </copyright>
-
-  <legalnotice>
-   <para>
-     This documentation is free software; you can redistribute
-     it and/or modify it under the terms of the GNU General Public
-     License version 2 as published by the Free Software Foundation.
-   </para>
-
-   <para>
-     This program is distributed in the hope that it will be
-     useful, but WITHOUT ANY WARRANTY; without even the implied
-     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-     See the GNU General Public License for more details.
-   </para>
-
-   <para>
-     You should have received a copy of the GNU General Public
-     License along with this program; if not, write to the Free
-     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
-     MA 02111-1307 USA
-   </para>
-
-   <para>
-     For more details see the file COPYING in the source
-     distribution of Linux.
-   </para>
-  </legalnotice>
- </bookinfo>
-
-<toc></toc>
-
-  <chapter id="intro">
-      <title>Introduction</title>
-  <para>
-	RapidIO is a high speed switched fabric interconnect with
-	features aimed at the embedded market.  RapidIO provides
-	support for memory-mapped I/O as well as message-based
-	transactions over the switched fabric network. RapidIO has
-	a standardized discovery mechanism not unlike the PCI bus
-	standard that allows simple detection of devices in a
-	network.
-  </para>
-  <para>
-  	This documentation is provided for developers intending
-	to support RapidIO on new architectures, write new drivers,
-	or to understand the subsystem internals.
-  </para>
-  </chapter>
-
-  <chapter id="bugs">
-     <title>Known Bugs and Limitations</title>
-
-     <sect1 id="known_bugs">
-     	<title>Bugs</title>
-	  <para>None. ;)</para>
-     </sect1>
-     <sect1 id="Limitations">
-     	<title>Limitations</title>
-	  <para>
-	    <orderedlist>
-	      <listitem><para>Access/management of RapidIO memory regions is not supported</para></listitem>
-	      <listitem><para>Multiple host enumeration is not supported</para></listitem>
-	    </orderedlist>
-	 </para>
-     </sect1>
-  </chapter>
-
-  <chapter id="drivers">
-     	<title>RapidIO driver interface</title>
-	<para>
-		Drivers are provided a set of calls in order
-		to interface with the subsystem to gather info
-		on devices, request/map memory region resources,
-		and manage mailboxes/doorbells.
-	</para>
-	<sect1 id="Functions">
-		<title>Functions</title>
-!Iinclude/linux/rio_drv.h
-!Edrivers/rapidio/rio-driver.c
-!Edrivers/rapidio/rio.c
-	</sect1>
-  </chapter>
-
-  <chapter id="internals">
-     <title>Internals</title>
-
-     <para>
-     This chapter contains the autogenerated documentation of the RapidIO
-     subsystem.
-     </para>
-
-     <sect1 id="Structures"><title>Structures</title>
-!Iinclude/linux/rio.h
-     </sect1>
-     <sect1 id="Enumeration_and_Discovery"><title>Enumeration and Discovery</title>
-!Idrivers/rapidio/rio-scan.c
-     </sect1>
-     <sect1 id="Driver_functionality"><title>Driver functionality</title>
-!Idrivers/rapidio/rio.c
-!Idrivers/rapidio/rio-access.c
-     </sect1>
-     <sect1 id="Device_model_support"><title>Device model support</title>
-!Idrivers/rapidio/rio-driver.c
-     </sect1>
-     <sect1 id="PPC32_support"><title>PPC32 support</title>
-!Iarch/powerpc/sysdev/fsl_rio.c
-     </sect1>
-  </chapter>
-
-  <chapter id="credits">
-     <title>Credits</title>
-	<para>
-		The following people have contributed to the RapidIO
-		subsystem directly or indirectly:
-		<orderedlist>
-			<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
-			<listitem><para>Randy Vinson<email>rvinson@mvista.com</email></para></listitem>
-			<listitem><para>Dan Malek<email>dan@embeddedalley.com</email></para></listitem>
-		</orderedlist>
-	</para>
-	<para>
-		The following people have contributed to this document:
-		<orderedlist>
-			<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
-		</orderedlist>
-	</para>
-  </chapter>
-</book>
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 8610aab8f342..1f8517db39c7 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -36,6 +36,7 @@ available subsections can be seen below.
    libata
    miscellaneous
    w1
+   rapidio
    s390-drivers
    vme
    80211/index
diff --git a/Documentation/driver-api/rapidio.rst b/Documentation/driver-api/rapidio.rst
new file mode 100644
index 000000000000..71ff658ab78e
--- /dev/null
+++ b/Documentation/driver-api/rapidio.rst
@@ -0,0 +1,107 @@
+=======================
+RapidIO Subsystem Guide
+=======================
+
+:Author: Matt Porter
+
+Introduction
+============
+
+RapidIO is a high speed switched fabric interconnect with features aimed
+at the embedded market. RapidIO provides support for memory-mapped I/O
+as well as message-based transactions over the switched fabric network.
+RapidIO has a standardized discovery mechanism not unlike the PCI bus
+standard that allows simple detection of devices in a network.
+
+This documentation is provided for developers intending to support
+RapidIO on new architectures, write new drivers, or to understand the
+subsystem internals.
+
+Known Bugs and Limitations
+==========================
+
+Bugs
+----
+
+None. ;)
+
+Limitations
+-----------
+
+1. Access/management of RapidIO memory regions is not supported
+
+2. Multiple host enumeration is not supported
+
+RapidIO driver interface
+========================
+
+Drivers are provided a set of calls in order to interface with the
+subsystem to gather info on devices, request/map memory region
+resources, and manage mailboxes/doorbells.
+
+Functions
+---------
+
+.. kernel-doc:: include/linux/rio_drv.h
+   :internal:
+
+.. kernel-doc:: drivers/rapidio/rio-driver.c
+   :export:
+
+.. kernel-doc:: drivers/rapidio/rio.c
+   :export:
+
+Internals
+=========
+
+This chapter contains the autogenerated documentation of the RapidIO
+subsystem.
+
+Structures
+----------
+
+.. kernel-doc:: include/linux/rio.h
+   :internal:
+
+Enumeration and Discovery
+-------------------------
+
+.. kernel-doc:: drivers/rapidio/rio-scan.c
+   :internal:
+
+Driver functionality
+--------------------
+
+.. kernel-doc:: drivers/rapidio/rio.c
+   :internal:
+
+.. kernel-doc:: drivers/rapidio/rio-access.c
+   :internal:
+
+Device model support
+--------------------
+
+.. kernel-doc:: drivers/rapidio/rio-driver.c
+   :internal:
+
+PPC32 support
+-------------
+
+.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
+   :internal:
+
+Credits
+=======
+
+The following people have contributed to the RapidIO subsystem directly
+or indirectly:
+
+1. Matt Porter\ mporter@kernel.crashing.org
+
+2. Randy Vinson\ rvinson@mvista.com
+
+3. Dan Malek\ dan@embeddedalley.com
+
+The following people have contributed to this document:
+
+1. Matt Porter\ mporter@kernel.crashing.org
-- 
2.9.3

  parent reply	other threads:[~2017-05-16 12:31 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-16 12:15 [PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 01/53] docs-rst: convert kernel-hacking to ReST Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 02/53] kernel-hacking: update document Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 03/53] docs-rst: convert kernel-locking to ReST Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST Mauro Carvalho Chehab
2017-05-16 17:35   ` Darren Hart
2017-05-16 18:24     ` Mauro Carvalho Chehab
2017-05-16 19:00       ` Darren Hart
2017-05-16 12:15 ` [PATCH v2 05/53] locking.rst: reformat locking table Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 06/53] locking.rst: add captions to two tables Mauro Carvalho Chehab
2017-05-16 12:15 ` [PATCH v2 07/53] locking.rst: Update some ReST markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 08/53] docs-rst: convert kgdb DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 09/53] kgdb.rst: Adjust ReST markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 10/53] conf.py: define a color for important markup on PDF output Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 13/53] docs-rst: add crypto API book to pdf output Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 14/53] docs-rst: add dev-tools " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 15/53] docs-rst: add sound " Mauro Carvalho Chehab
2017-05-16 19:02   ` Takashi Iwai
2017-05-16 12:16 ` [PATCH v2 16/53] docs-rst: add userspace API " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 17/53] docs-rst: convert filesystems book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 18/53] docs-rst: filesystems: use c domain references where needed Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 19/53] fs: jbd2: make jbd2_journal_start() kernel-doc parseable Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 20/53] docs-rst: don't ignore internal functions for jbd2 docs Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 23/53] fs: jbd2: escape a string with special chars on a kernel-doc Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 24/53] docs-rst: convert libata book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 25/53] libata.rst: add c function and struct cross-references Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 26/53] libata: fix identation on a kernel-doc markup Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 28/53] docs-rst: convert networking book " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 29/53] net: skbuff.h: properly escape a macro name on kernel-doc Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 31/53] docs-rst: convert z8530book DocBook to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 32/53] docs-rst: convert scsi " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 33/53] scsi: fix some kernel-doc markups Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 34/53] docs-rst: convert w1 book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` Mauro Carvalho Chehab [this message]
2017-05-16 12:16 ` [PATCH v2 36/53] docs-rst: convert librs " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 37/53] docs-rst: convert mtdnand " Mauro Carvalho Chehab
2017-05-16 13:11   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Mauro Carvalho Chehab
2017-05-16 13:12   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings Mauro Carvalho Chehab
2017-05-16 13:13   ` Boris Brezillon
2017-05-16 12:16 ` [PATCH v2 40/53] docs-rst: convert sh book to ReST Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 41/53] docs-rst: convert lsm from DocBook " Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 42/53] docs: remove DocBook from the building system Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 43/53] docs: update old references for DocBook from the documentation Mauro Carvalho Chehab
2017-05-16 12:47   ` Bartlomiej Zolnierkiewicz
2017-05-17 16:51   ` Bjorn Helgaas
2017-05-16 12:16 ` [PATCH v2 44/53] MAINTAINERS: update old references for DocBook directory Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 45/53] ata: update references for libata documentation Mauro Carvalho Chehab
2017-05-16 12:47   ` Bartlomiej Zolnierkiewicz
2017-05-16 12:16 ` [PATCH v2 46/53] ia64, scsi: update references for the device-io book Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 47/53] irq: update genericirq book location Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 48/53] fs: update location of filesystems documentation Mauro Carvalho Chehab
2017-05-16 12:16 ` [PATCH v2 49/53] lib: update location of kgdb documentation Mauro Carvalho Chehab
2017-05-16 12:38 ` [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups David Howells
2017-05-16 18:11 ` [PATCH v2 50/53] fs: fix the location of the kernel-api book Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-16 18:11 ` [PATCH v2 51/53] usb: fix the comment with regards to DocBook Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-17 11:13   ` Felipe Balbi
2017-05-16 18:11 ` [PATCH v2 52/53] docs-rst: get rid of Documentation/sphinx/tmplcvt script Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2017-05-16 18:12 ` [PATCH v2 53/53] kernel-doc: describe the ``literal`` syntax Mauro Carvalho Chehab
2017-05-16 12:16   ` Mauro Carvalho Chehab
2018-06-06 16:31   ` Markus Heiser
2017-05-18 17:26 ` [PATCH v2 00/53] Get rid of Docbook Jonathan Corbet
2017-05-18 23:01   ` Mauro Carvalho Chehab
2017-06-16 14:03     ` Markus Heiser
2017-06-23 20:26       ` Jonathan Corbet
2017-07-05 21:45       ` Jim Davis
2017-07-06  8:54         ` Markus Heiser
2017-07-14 23:15           ` Jim Davis
2017-07-15  1:52             ` Mauro Carvalho Chehab

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=e85ca0a31f1a2e71a9fe09a3abe55476fc3a25ca.1494935649.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=boris.brezillon@free-electrons.com \
    --cc=computersforpeace@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cyrille.pitchen@atmel.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=dwmw2@infradead.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=herton@redhat.com \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=marek.vasut@gmail.com \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@infradead.org \
    --cc=richard@nod.at \
    /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®