From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
Markus Heiser <markus.heiser@darmarIT.de>,
linux-doc@vger.kernel.org
Subject: [PATCH 18/18] [media] doc-rst: better name the media books
Date: Mon, 18 Jul 2016 15:30:40 -0300 [thread overview]
Message-ID: <e1813eda8e7fdacd992224b79102925cf134be8b.1468865380.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1468865380.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1468865380.git.mchehab@s-opensource.com>
The titles at the media books were misleading, and some books
were not numbered.
Rename the kAPI book to better reflect its contents, be more
consistent on the initial rst file for each book and better
name them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/index.rst | 2 +-
Documentation/media/dvb-drivers/index.rst | 9 ++++++---
Documentation/media/{media_drivers.rst => media_kapi.rst} | 9 ++++++---
Documentation/media/media_uapi.rst | 10 +++++-----
Documentation/media/v4l-drivers/index.rst | 8 +++++---
5 files changed, 23 insertions(+), 15 deletions(-)
rename Documentation/media/{media_drivers.rst => media_kapi.rst} (76%)
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 31273cc2e0bc..43c722f15292 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -15,7 +15,7 @@ Contents:
kernel-documentation
media/media_uapi
- media/media_drivers
+ media/media_kapi
media/dvb-drivers/index
media/v4l-drivers/index
diff --git a/Documentation/media/dvb-drivers/index.rst b/Documentation/media/dvb-drivers/index.rst
index 14da36fe4d01..e1d4d87f2a47 100644
--- a/Documentation/media/dvb-drivers/index.rst
+++ b/Documentation/media/dvb-drivers/index.rst
@@ -2,9 +2,9 @@
.. include:: <isonum.txt>
-#############################################
-Linux Digital Video Broadcast (DVB) subsystem
-#############################################
+##############################################
+Linux Digital TV driver-specific documentation
+##############################################
**Copyright** |copy| 2001-2016 : LinuxTV Developers
@@ -17,6 +17,9 @@ License".
.. toctree::
:maxdepth: 5
+ :numbered:
+ :caption: Table of Contents
+ :name: dvb_mastertoc
intro
avermedia
diff --git a/Documentation/media/media_drivers.rst b/Documentation/media/media_kapi.rst
similarity index 76%
rename from Documentation/media/media_drivers.rst
rename to Documentation/media/media_kapi.rst
index 8e0f455ff6e0..0af80e90b7b5 100644
--- a/Documentation/media/media_drivers.rst
+++ b/Documentation/media/media_kapi.rst
@@ -2,9 +2,9 @@
.. include:: <isonum.txt>
-=========================
-Media subsystem core kAPI
-=========================
+===================================
+Media subsystem kernel internal API
+===================================
**Copyright** |copy| 2009-2016 : LinuxTV Developers
@@ -16,6 +16,9 @@ License".
.. toctree::
:maxdepth: 5
+ :numbered:
+ :caption: Table of Contents
+ :name: kapi_mastertoc
kapi/v4l2-framework
kapi/v4l2-controls
diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst
index 5e872c8297b0..debe4531040b 100644
--- a/Documentation/media/media_uapi.rst
+++ b/Documentation/media/media_uapi.rst
@@ -2,9 +2,9 @@
.. include:: <isonum.txt>
-##############################
-Linux Media Infrastructure API
-##############################
+########################################
+Linux Media Infrastructure userspace API
+########################################
**Copyright** |copy| 2009-2016 : LinuxTV Developers
@@ -15,10 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
License".
-.. contents::
-
.. toctree::
:maxdepth: 5
+ :caption: Table of Contents
+ :name: uapi_mastertoc
intro
uapi/v4l/v4l2
diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
index 34990b536d39..8d1710234e5a 100644
--- a/Documentation/media/v4l-drivers/index.rst
+++ b/Documentation/media/v4l-drivers/index.rst
@@ -2,9 +2,9 @@
.. include:: <isonum.txt>
-###########################
-Video4Linux (V4L) subsystem
-###########################
+################################################
+Video4Linux (V4L) driver-specific documentation
+################################################
**Copyright** |copy| 1999-2016 : LinuxTV Developers
@@ -18,6 +18,8 @@ License".
.. toctree::
:maxdepth: 5
:numbered:
+ :caption: Table of Contents
+ :name: v4l_mastertoc
fourcc
v4l-with-ir
--
2.7.4
next prev parent reply other threads:[~2016-07-18 18:30 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-18 18:30 [PATCH 00/18] Complete moving media documentation to ReST format Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 01/18] [media] doc-rst: move bttv documentation to bttv.rst file Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 02/18] [media] doc-rst: add documentation for bttv driver Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 03/18] [media] doc-rst: add documentation for tuners Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 04/18] [media] doc-rst: start adding documentation for cx2341x Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 05/18] [media] cx2341x.rst: add fw-decoder-registers.txt content Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 06/18] [media] cx2341x.rst: Add the contents of fw-encoder-api.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 07/18] [media] cx2341x.rst: add the contents of fw-calling.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 08/18] [media] cx2341x.rst: add contents of fw-dma.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 09/18] [media] cx2341x.rst: add contents of fw-memory.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 10/18] [media] cx2341x.rst: add the contents of fw-upload.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 11/18] [media] cx2341x.rst: add contents of fw-osd-api.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 12/18] [media] cx2341x: add contents of README.hm12 Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 13/18] [media] cx2341x.rst: add contents of README.vbi Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 14/18] [media] cx88.rst: add contents from not-in-cx2388x-datasheet.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 15/18] [media] cx88.rst: add contents of hauppauge-wintv-cx88-ir.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 16/18] [media] get rid of Documentation/video4linux/lifeview.txt Mauro Carvalho Chehab
2016-07-18 18:30 ` [PATCH 17/18] [media] doc-rst: fix media kAPI documentation Mauro Carvalho Chehab
2016-07-18 18:30 ` Mauro Carvalho Chehab [this message]
2016-07-19 9:19 ` [PATCH 00/18] Complete moving media documentation to ReST format Hans Verkuil
2016-07-19 11:12 ` Mauro Carvalho Chehab
2016-07-19 12:31 ` Markus Heiser
2016-07-19 14:53 ` Mauro Carvalho Chehab
2016-07-19 15:40 ` Mauro Carvalho Chehab
2016-07-19 16:42 ` Markus Heiser
2016-07-19 17:18 ` Mauro Carvalho Chehab
2016-07-21 15:17 ` Markus Heiser
2016-07-22 9:46 ` Mauro Carvalho Chehab
2016-07-22 10:55 ` Markus Heiser
2016-07-19 22:49 ` Jonathan Corbet
2016-07-20 0:00 ` Mauro Carvalho Chehab
2016-07-20 6:07 ` Markus Heiser
2016-07-20 10:19 ` Mauro Carvalho Chehab
2016-07-20 23:28 ` Jonathan Corbet
2016-07-21 14:41 ` Markus Heiser
2016-07-21 16:59 ` Jonathan Corbet
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=e1813eda8e7fdacd992224b79102925cf134be8b.1468865380.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=markus.heiser@darmarIT.de \
--cc=mchehab@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.