[PATCH 01/14] media: dvb uapi docs: better organize header files

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>,
	Linux Media Mailing List <linux-media@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>
Subject: [PATCH 01/14] media: dvb uapi docs: better organize header files
Date: Fri,  1 Sep 2017 16:37:37 -0300	[thread overview]
Message-ID: <20a109caba32f49fde9e8de35c7efdd4b404fbd5.1504293108.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1504293108.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1504293108.git.mchehab@s-opensource.com>

Instead of having one chapter per file, place all of them at
the same chapter. That better organize the chapters at the uAPI
documentation.

As a side effect, now all uAPI headers are at the same page,
at the html output, with makes easier to use it as a reference
index for the spec.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/media/uapi/dvb/audio_h.rst    |  9 ---------
 Documentation/media/uapi/dvb/ca_h.rst       |  9 ---------
 Documentation/media/uapi/dvb/dmx_h.rst      |  9 ---------
 Documentation/media/uapi/dvb/dvbapi.rst     |  7 +------
 Documentation/media/uapi/dvb/frontend_h.rst |  9 ---------
 Documentation/media/uapi/dvb/headers.rst    | 21 +++++++++++++++++++++
 Documentation/media/uapi/dvb/net_h.rst      |  9 ---------
 Documentation/media/uapi/dvb/video_h.rst    |  9 ---------
 8 files changed, 22 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/media/uapi/dvb/audio_h.rst
 delete mode 100644 Documentation/media/uapi/dvb/ca_h.rst
 delete mode 100644 Documentation/media/uapi/dvb/dmx_h.rst
 delete mode 100644 Documentation/media/uapi/dvb/frontend_h.rst
 create mode 100644 Documentation/media/uapi/dvb/headers.rst
 delete mode 100644 Documentation/media/uapi/dvb/net_h.rst
 delete mode 100644 Documentation/media/uapi/dvb/video_h.rst

diff --git a/Documentation/media/uapi/dvb/audio_h.rst b/Documentation/media/uapi/dvb/audio_h.rst
deleted file mode 100644
index e00c3010fdf9..000000000000
--- a/Documentation/media/uapi/dvb/audio_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _audio_h:
-
-*********************
-DVB Audio Header File
-*********************
-
-.. kernel-include:: $BUILDDIR/audio.h.rst
diff --git a/Documentation/media/uapi/dvb/ca_h.rst b/Documentation/media/uapi/dvb/ca_h.rst
deleted file mode 100644
index f513592ef529..000000000000
--- a/Documentation/media/uapi/dvb/ca_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _ca_h:
-
-**********************************
-DVB Conditional Access Header File
-**********************************
-
-.. kernel-include:: $BUILDDIR/ca.h.rst
diff --git a/Documentation/media/uapi/dvb/dmx_h.rst b/Documentation/media/uapi/dvb/dmx_h.rst
deleted file mode 100644
index 4fd1704a0833..000000000000
--- a/Documentation/media/uapi/dvb/dmx_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _dmx_h:
-
-*********************
-DVB Demux Header File
-*********************
-
-.. kernel-include:: $BUILDDIR/dmx.h.rst
diff --git a/Documentation/media/uapi/dvb/dvbapi.rst b/Documentation/media/uapi/dvb/dvbapi.rst
index 37680137e3f2..9ca3dd24bd7d 100644
--- a/Documentation/media/uapi/dvb/dvbapi.rst
+++ b/Documentation/media/uapi/dvb/dvbapi.rst
@@ -30,12 +30,7 @@ Part II - Digital TV API
     net
     legacy_dvb_apis
     examples
-    audio_h
-    ca_h
-    dmx_h
-    frontend_h
-    net_h
-    video_h
+    headers
 
 
 **********************
diff --git a/Documentation/media/uapi/dvb/frontend_h.rst b/Documentation/media/uapi/dvb/frontend_h.rst
deleted file mode 100644
index 15fca04d1c32..000000000000
--- a/Documentation/media/uapi/dvb/frontend_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _frontend_h:
-
-************************
-DVB Frontend Header File
-************************
-
-.. kernel-include:: $BUILDDIR/frontend.h.rst
diff --git a/Documentation/media/uapi/dvb/headers.rst b/Documentation/media/uapi/dvb/headers.rst
new file mode 100644
index 000000000000..c13fd537fbff
--- /dev/null
+++ b/Documentation/media/uapi/dvb/headers.rst
@@ -0,0 +1,21 @@
+****************************
+Digital TV uAPI header files
+****************************
+
+Digital TV uAPI headers
+***********************
+
+.. kernel-include:: $BUILDDIR/frontend.h.rst
+
+.. kernel-include:: $BUILDDIR/dmx.h.rst
+
+.. kernel-include:: $BUILDDIR/ca.h.rst
+
+.. kernel-include:: $BUILDDIR/net.h.rst
+
+Legacy uAPI
+***********
+
+.. kernel-include:: $BUILDDIR/audio.h.rst
+
+.. kernel-include:: $BUILDDIR/video.h.rst
diff --git a/Documentation/media/uapi/dvb/net_h.rst b/Documentation/media/uapi/dvb/net_h.rst
deleted file mode 100644
index 7bcf5ba9d1eb..000000000000
--- a/Documentation/media/uapi/dvb/net_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _net_h:
-
-***********************
-DVB Network Header File
-***********************
-
-.. kernel-include:: $BUILDDIR/net.h.rst
diff --git a/Documentation/media/uapi/dvb/video_h.rst b/Documentation/media/uapi/dvb/video_h.rst
deleted file mode 100644
index 3f39b0c4879c..000000000000
--- a/Documentation/media/uapi/dvb/video_h.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-.. _video_h:
-
-*********************
-DVB Video Header File
-*********************
-
-.. kernel-include:: $BUILDDIR/video.h.rst
-- 
2.13.5

next prev parent reply	other threads:[~2017-09-01 19:38 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-01 19:37 [PATCH 00/14] Another set of DVB documentation patches Mauro Carvalho Chehab
2017-09-01 19:37 ` Mauro Carvalho Chehab [this message]
2017-09-01 19:37 ` [PATCH 02/14] media: gen-errors.rst: remove row number comments Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 03/14] media: gen-errors.rst: document ENXIO error code Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 04/14] media: dvb uAPI docs: adjust return value ioctl descriptions Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 05/14] media: ca-fopen.rst: Fixes the device node name for CA Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 06/14] media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB" Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 07/14] media: dmx-fread.rst: specify how DMX_CHECK_CRC works Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 08/14] media: dvb-frontend-parameters.rst: fix the name of a struct Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 09/14] media: dvbapi.rst: add an entry to DVB revision history Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 10/14] media: dvb uAPI docs: minor editorial changes Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 11/14] media: dmx-get-pes-pids.rst: document the ioctl Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 12/14] media: dvbstb.svg: use dots for the optional parts of the hardware Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 13/14] media: intro.rst: don't assume audio and video codecs to be MPEG2 Mauro Carvalho Chehab
2017-09-01 19:37 ` [PATCH 14/14] media: frontend.h: Avoid the term DVB when doesn't refer to a delivery system 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=20a109caba32f49fde9e8de35c7efdd4b404fbd5.1504293108.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --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 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®