All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 04/35] DocBook: fix emphasis at the DVB documentation
Date: Thu, 28 May 2015 18:49:07 -0300	[thread overview]
Message-ID: <6674a17160ba2f80a4537d4dc9e501149c308706.1432844837.git.mchehab@osg.samsung.com> (raw)
In-Reply-To: <cover.1432844837.git.mchehab@osg.samsung.com>
In-Reply-To: <cover.1432844837.git.mchehab@osg.samsung.com>

Currently, it is using 'role="tt"', but this is not defined at
the DocBook 4.5 spec. The net result is that no emphasis happens.

So, replace them to bold emphasis.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/Documentation/DocBook/media/dvb/audio.xml b/Documentation/DocBook/media/dvb/audio.xml
index a7ea56c71a27..a853e5b81ec7 100644
--- a/Documentation/DocBook/media/dvb/audio.xml
+++ b/Documentation/DocBook/media/dvb/audio.xml
@@ -1,7 +1,7 @@
 <title>DVB Audio Device</title>
 <para>The DVB audio device controls the MPEG2 audio decoder of the DVB hardware. It
-can be accessed through <emphasis role="tt">/dev/dvb/adapter0/audio0</emphasis>. Data types and and
-ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/audio.h</emphasis> in your
+can be accessed through <emphasis role="bold">/dev/dvb/adapter0/audio0</emphasis>. Data types and and
+ioctl definitions can be accessed by including <emphasis role="bold">linux/dvb/audio.h</emphasis> in your
 application.
 </para>
 <para>Please note that some DVB cards don&#8217;t have their own MPEG decoder, which results in
@@ -32,7 +32,7 @@ typedef enum {
 </programlisting>
 <para>AUDIO_SOURCE_DEMUX selects the demultiplexer (fed either by the frontend or the
 DVR device) as the source of the video stream. If AUDIO_SOURCE_MEMORY
-is selected the stream comes from the application through the <emphasis role="tt">write()</emphasis> system
+is selected the stream comes from the application through the <emphasis role="bold">write()</emphasis> system
 call.
 </para>
 
diff --git a/Documentation/DocBook/media/dvb/ca.xml b/Documentation/DocBook/media/dvb/ca.xml
index 85eaf4fe2931..bf9e790d674f 100644
--- a/Documentation/DocBook/media/dvb/ca.xml
+++ b/Documentation/DocBook/media/dvb/ca.xml
@@ -1,7 +1,7 @@
 <title>DVB CA Device</title>
 <para>The DVB CA device controls the conditional access hardware. It can be accessed through
-<emphasis role="tt">/dev/dvb/adapter0/ca0</emphasis>. Data types and and ioctl definitions can be accessed by
-including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application.
+<emphasis role="bold">/dev/dvb/adapter0/ca0</emphasis>. Data types and and ioctl definitions can be accessed by
+including <emphasis role="bold">linux/dvb/ca.h</emphasis> in your application.
 </para>
 
 <section id="ca_data_types">
diff --git a/Documentation/DocBook/media/dvb/demux.xml b/Documentation/DocBook/media/dvb/demux.xml
index c8683d66f059..fae0e0556ca5 100644
--- a/Documentation/DocBook/media/dvb/demux.xml
+++ b/Documentation/DocBook/media/dvb/demux.xml
@@ -1,8 +1,8 @@
 <title>DVB Demux Device</title>
 
 <para>The DVB demux device controls the filters of the DVB hardware/software. It can be
-accessed through <emphasis role="tt">/dev/adapter0/demux0</emphasis>. Data types and and ioctl definitions can be
-accessed by including <emphasis role="tt">linux/dvb/dmx.h</emphasis> in your application.
+accessed through <emphasis role="bold">/dev/adapter0/demux0</emphasis>. Data types and and ioctl definitions can be
+accessed by including <emphasis role="bold">linux/dvb/dmx.h</emphasis> in your application.
 </para>
 <section id="dmx_types">
 <title>Demux Data Types</title>
@@ -21,11 +21,11 @@ typedef enum
 	DMX_OUT_TSDEMUX_TAP /&#x22C6; Like TS_TAP but retrieved from the DMX device &#x22C6;/
 } dmx_output_t;
 </programlisting>
-<para><emphasis role="tt">DMX_OUT_TAP</emphasis> delivers the stream output to the demux device on which the ioctl is
+<para><emphasis role="bold">DMX_OUT_TAP</emphasis> delivers the stream output to the demux device on which the ioctl is
 called.
 </para>
-<para><emphasis role="tt">DMX_OUT_TS_TAP</emphasis> routes output to the logical DVR device <emphasis role="tt">/dev/dvb/adapter0/dvr0</emphasis>,
-which delivers a TS multiplexed from all filters for which <emphasis role="tt">DMX_OUT_TS_TAP</emphasis> was
+<para><emphasis role="bold">DMX_OUT_TS_TAP</emphasis> routes output to the logical DVR device <emphasis role="bold">/dev/dvb/adapter0/dvr0</emphasis>,
+which delivers a TS multiplexed from all filters for which <emphasis role="bold">DMX_OUT_TS_TAP</emphasis> was
 specified.
 </para>
 </section>
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index 8a6a6ff27af5..956b8f6882e0 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -2,9 +2,9 @@
 
 <para>The DVB frontend device controls the tuner and DVB demodulator
 hardware. It can be accessed through <emphasis
-role="tt">/dev/dvb/adapter0/frontend0</emphasis>. Data types and and
+role="bold">/dev/dvb/adapter0/frontend0</emphasis>. Data types and and
 ioctl definitions can be accessed by including <emphasis
-role="tt">linux/dvb/frontend.h</emphasis> in your application.</para>
+role="bold">linux/dvb/frontend.h</emphasis> in your application.</para>
 
 <para>DVB frontends come in three varieties: DVB-S (satellite), DVB-C
 (cable) and DVB-T (terrestrial). Transmission via the internet (DVB-IP)
diff --git a/Documentation/DocBook/media/dvb/intro.xml b/Documentation/DocBook/media/dvb/intro.xml
index 2048b53d19b9..4a34ef4783a4 100644
--- a/Documentation/DocBook/media/dvb/intro.xml
+++ b/Documentation/DocBook/media/dvb/intro.xml
@@ -129,41 +129,41 @@ hardware. It can depend on the individual security requirements of the
 platform, if and how many of the CA functions are made available to the
 application through this device.</para>
 
-<para>All devices can be found in the <emphasis role="tt">/dev</emphasis>
-tree under <emphasis role="tt">/dev/dvb</emphasis>. The individual devices
+<para>All devices can be found in the <emphasis role="bold">/dev</emphasis>
+tree under <emphasis role="bold">/dev/dvb</emphasis>. The individual devices
 are called:</para>
 
 <itemizedlist>
 <listitem>
 
-<para><emphasis role="tt">/dev/dvb/adapterN/audioM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/audioM</emphasis>,</para>
 </listitem>
 <listitem>
-<para><emphasis role="tt">/dev/dvb/adapterN/videoM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/videoM</emphasis>,</para>
 </listitem>
 <listitem>
-<para><emphasis role="tt">/dev/dvb/adapterN/frontendM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/frontendM</emphasis>,</para>
 </listitem>
  <listitem>
 
-<para><emphasis role="tt">/dev/dvb/adapterN/netM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/netM</emphasis>,</para>
 </listitem>
  <listitem>
 
-<para><emphasis role="tt">/dev/dvb/adapterN/demuxM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/demuxM</emphasis>,</para>
 </listitem>
  <listitem>
 
-<para><emphasis role="tt">/dev/dvb/adapterN/dvrM</emphasis>,</para>
+<para><emphasis role="bold">/dev/dvb/adapterN/dvrM</emphasis>,</para>
 </listitem>
  <listitem>
 
-<para><emphasis role="tt">/dev/dvb/adapterN/caM</emphasis>,</para></listitem></itemizedlist>
+<para><emphasis role="bold">/dev/dvb/adapterN/caM</emphasis>,</para></listitem></itemizedlist>
 
 <para>where N enumerates the DVB PCI cards in a system starting
 from&#x00A0;0, and M enumerates the devices of each type within each
 adapter, starting from&#x00A0;0, too. We will omit the &#8220;<emphasis
-role="tt">/dev/dvb/adapterN/</emphasis>&#8221; in the further dicussion
+role="bold">/dev/dvb/adapterN/</emphasis>&#8221; in the further dicussion
 of these devices. The naming scheme for the devices is the same wheter
 devfs is used or not.</para>
 
@@ -203,9 +203,9 @@ a partial path like:</para>
 
 <para>To enable applications to support different API version, an
 additional include file <emphasis
-role="tt">linux/dvb/version.h</emphasis> exists, which defines the
-constant <emphasis role="tt">DVB_API_VERSION</emphasis>. This document
-describes <emphasis role="tt">DVB_API_VERSION 5.8</emphasis>.
+role="bold">linux/dvb/version.h</emphasis> exists, which defines the
+constant <emphasis role="bold">DVB_API_VERSION</emphasis>. This document
+describes <emphasis role="bold">DVB_API_VERSION 5.8</emphasis>.
 </para>
 
 </section>
diff --git a/Documentation/DocBook/media/dvb/kdapi.xml b/Documentation/DocBook/media/dvb/kdapi.xml
index 6c11ec52cbee..f648115f7149 100644
--- a/Documentation/DocBook/media/dvb/kdapi.xml
+++ b/Documentation/DocBook/media/dvb/kdapi.xml
@@ -1,8 +1,8 @@
 <title>Kernel Demux API</title>
 <para>The kernel demux API defines a driver-internal interface for registering low-level,
 hardware specific driver to a hardware independent demux layer. It is only of interest for
-DVB device driver writers. The header file for this API is named <emphasis role="tt">demux.h</emphasis> and located in
-<emphasis role="tt">drivers/media/dvb-core</emphasis>.
+DVB device driver writers. The header file for this API is named <emphasis role="bold">demux.h</emphasis> and located in
+<emphasis role="bold">drivers/media/dvb-core</emphasis>.
 </para>
 <para>Maintainer note: This section must be reviewed. It is probably out of date.
 </para>
diff --git a/Documentation/DocBook/media/dvb/net.xml b/Documentation/DocBook/media/dvb/net.xml
index a193e86941b5..d4ef21764959 100644
--- a/Documentation/DocBook/media/dvb/net.xml
+++ b/Documentation/DocBook/media/dvb/net.xml
@@ -1,8 +1,8 @@
 <title>DVB Network API</title>
 <para>The DVB net device enables feeding of MPE (multi protocol encapsulation) packets
 received via DVB into the Linux network protocol stack, e.g. for internet via satellite
-applications. It can be accessed through <emphasis role="tt">/dev/dvb/adapter0/net0</emphasis>. Data types and
-and ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/net.h</emphasis> in your
+applications. It can be accessed through <emphasis role="bold">/dev/dvb/adapter0/net0</emphasis>. Data types and
+and ioctl definitions can be accessed by including <emphasis role="bold">linux/dvb/net.h</emphasis> in your
 application.
 </para>
 <section id="dvb_net_types">
diff --git a/Documentation/DocBook/media/dvb/video.xml b/Documentation/DocBook/media/dvb/video.xml
index 3ea1ca7e785e..1ea786f9b798 100644
--- a/Documentation/DocBook/media/dvb/video.xml
+++ b/Documentation/DocBook/media/dvb/video.xml
@@ -1,12 +1,12 @@
 <title>DVB Video Device</title>
 <para>The DVB video device controls the MPEG2 video decoder of the DVB hardware. It
-can be accessed through <emphasis role="tt">/dev/dvb/adapter0/video0</emphasis>. Data types and and
-ioctl definitions can be accessed by including <emphasis role="tt">linux/dvb/video.h</emphasis> in your
+can be accessed through <emphasis role="bold">/dev/dvb/adapter0/video0</emphasis>. Data types and and
+ioctl definitions can be accessed by including <emphasis role="bold">linux/dvb/video.h</emphasis> in your
 application.
 </para>
 <para>Note that the DVB video device only controls decoding of the MPEG video stream, not
 its presentation on the TV or computer screen. On PCs this is typically handled by an
-associated video4linux device, e.g. <emphasis role="tt">/dev/video</emphasis>, which allows scaling and defining output
+associated video4linux device, e.g. <emphasis role="bold">/dev/video</emphasis>, which allows scaling and defining output
 windows.
 </para>
 <para>Some DVB cards don&#8217;t have their own MPEG decoder, which results in the omission of
@@ -24,7 +24,7 @@ have been created to replace that functionality.</para>
 
 <section id="video-format-t">
 <title>video_format_t</title>
-<para>The <emphasis role="tt">video_format_t</emphasis> data type defined by
+<para>The <emphasis role="bold">video_format_t</emphasis> data type defined by
 </para>
 <programlisting>
 typedef enum {
@@ -74,7 +74,7 @@ typedef enum {
 </programlisting>
 <para>VIDEO_SOURCE_DEMUX selects the demultiplexer (fed either by the frontend or the
 DVR device) as the source of the video stream. If VIDEO_SOURCE_MEMORY
-is selected the stream comes from the application through the <emphasis role="tt">write()</emphasis> system
+is selected the stream comes from the application through the <emphasis role="bold">write()</emphasis> system
 call.
 </para>
 </section>
-- 
2.4.1


  parent reply	other threads:[~2015-05-28 21:49 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-28 21:49 [PATCH 00/35] Improve DVB frontend API documentation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 01/35] DocBook: Update DVB supported standards at introduction Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 02/35] DocBook: add a note about the ALSA API Mauro Carvalho Chehab
2015-06-02  2:50   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 03/35] DocBook: add drawing with a typical media device Mauro Carvalho Chehab
2015-05-28 21:49 ` Mauro Carvalho Chehab [this message]
2015-06-02  2:56   ` [PATCH 04/35] DocBook: fix emphasis at the DVB documentation Jonathan Corbet
2015-06-02 11:51     ` Mauro Carvalho Chehab
2015-06-02 13:02       ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 05/35] DocBook: Improve DVB frontend description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 06/35] DocBook: move DVBv3 frontend bits to a separate section Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 07/35] dvb: split enum from typedefs at frontend.h Mauro Carvalho Chehab
2015-05-28 21:57   ` Hans Verkuil
2015-05-28 21:57     ` Hans Verkuil
2015-05-28 22:22     ` Mauro Carvalho Chehab
2015-05-28 22:22       ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 08/35] DocBook: reformat FE_GET_INFO ioctl documentation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 09/35] DocBook: move FE_GET_INFO to a separate xml file Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 10/35] DocBook: improve documentation for FE_READ_STATUS Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 11/35] DocBook: move DVB properties to happen earlier at the document Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 12/35] DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std way Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 13/35] DocBook: fix xref to the FE open() function Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 14/35] DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 15/35] DocBook: Improve the description of the properties API Mauro Carvalho Chehab
2015-06-02  3:03   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 16/35] DocBook: Add xref links for DTV propeties Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 17/35] DocBook: Improve xref check for undocumented ioctls Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 18/35] DocBook: remove duplicated ioctl from v4l2-subdev Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 19/35] DocBook: Fix false positive undefined ioctl references Mauro Carvalho Chehab
2015-05-30 12:20   ` Hans Verkuil
2015-05-28 21:49 ` [PATCH 20/35] DocBook: Rename ioctl xml files Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 21/35] DocBook: move FE_GET_PROPERTY to its own xml file Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 22/35] DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 23/35] DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 24/35] DocBook: better document FE_SET_VOLTAGE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 25/35] DocBook: better document FE_SET_TONE ioctl Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 26/35] DocBook: better document FE_DISEQC_SEND_BURST ioctl Mauro Carvalho Chehab
2015-05-28 21:49   ` Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 27/35] DocBook: better document FE_DISEQC_RECV_SLAVE_REPLY Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 28/35] DocBook: better document FE_DISEQC_SEND_MASTER_CMD Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 29/35] DocBook: better document FE_DISEQC_RESET_OVERLOAD Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 30/35] DocBook: better organize the function descriptions for frontend Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 31/35] DocBook: fix FE_READ_STATUS argument description Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 32/35] DocBook: Provide a high-level description for DVB frontend Mauro Carvalho Chehab
2015-06-02  3:08   ` Jonathan Corbet
2015-05-28 21:49 ` [PATCH 33/35] DocBook: add a proper description for dvb_frontend_info.fe_type Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 34/35] DocBook: Better document enum fe_modulation Mauro Carvalho Chehab
2015-05-28 21:49 ` [PATCH 35/35] DocBook: some fixes at FE_GET_INFO Mauro Carvalho Chehab
2015-06-02  3:12 ` [PATCH 00/35] Improve DVB frontend API documentation Jonathan Corbet
2015-06-02  9:26   ` Mauro Carvalho Chehab
2015-06-02  9:33     ` 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=6674a17160ba2f80a4537d4dc9e501149c308706.1432844837.git.mchehab@osg.samsung.com \
    --to=mchehab@osg.samsung.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@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 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.