* [PATCH 0/3] DocBook media: xmllint/typo fixes
@ 2015-05-31 12:59 Hans Verkuil
2015-05-31 12:59 ` [PATCH 1/3] DocBook media: fix typos Hans Verkuil
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Hans Verkuil @ 2015-05-31 12:59 UTC (permalink / raw)
To: linux-media
From: Hans Verkuil <hans.verkuil@cisco.com>
Hi Mauro,
Here are three patches that fix typos and xmllint errors.
The first patch fixes typos, the second a large number of xmllint
errors and the last fixes a final xmllint error, but it does that by
copying most of the v4l2 open/close text and you should check whether
I didn't remove anything that is relevant for DVB.
Note that I use the following 'gitdocs.sh' script to build the documentation:
--------------------------------
#!/bin/sh
make DOCBOOKS=media_api.xml htmldocs 2>&1 | grep -v "element.*: validity error : ID .* already defined"
xmllint --noent --postvalid "$PWD/Documentation/DocBook/media_api.xml" >/tmp/x.xml 2>/dev/null
xmllint --noent --postvalid --noout /tmp/x.xml
xmlto html-nochunks -m ./Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/media Documentation/DocBook/media_api.xml >/dev/null 2>&1
echo file://$PWD/Documentation/DocBook/media/media_api.html
--------------------------------
This does a pretty thorough xmllint check. It also creates a /tmp/x.xml file that can be used
to relate xmllint line numbers to that file.
Finally it creates a single big html file which has the whole spec. I prefer that
over all the little html pages you otherwise get. Also, by building one large file
it is easier to find clashing IDs etc. since the whole spec is analyzed.
Regards,
Hans
Hans Verkuil (3):
DocBook media: fix typos
DocBook media: xmllint fixes
DocBook media: rewrite frontend open/close
Documentation/DocBook/media/dvb/dvbproperty.xml | 28 +-
.../media/dvb/fe-diseqc-recv-slave-reply.xml | 2 +-
.../DocBook/media/dvb/fe-diseqc-send-burst.xml | 8 +-
.../media/dvb/fe-diseqc-send-master-cmd.xml | 2 +-
.../media/dvb/fe-enable-high-lnb-voltage.xml | 6 +-
Documentation/DocBook/media/dvb/fe-get-info.xml | 8 +-
.../DocBook/media/dvb/fe-get-property.xml | 26 +-
Documentation/DocBook/media/dvb/fe-read-status.xml | 4 +-
.../media/dvb/fe-set-frontend-tune-mode.xml | 6 +-
Documentation/DocBook/media/dvb/fe-set-tone.xml | 10 +-
Documentation/DocBook/media/dvb/fe-set-voltage.xml | 8 +-
Documentation/DocBook/media/dvb/frontend.xml | 299 ++++++++++++---------
.../DocBook/media/dvb/frontend_legacy_api.xml | 3 +-
13 files changed, 222 insertions(+), 188 deletions(-)
--
2.1.4
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH 1/3] DocBook media: fix typos
2015-05-31 12:59 [PATCH 0/3] DocBook media: xmllint/typo fixes Hans Verkuil
@ 2015-05-31 12:59 ` Hans Verkuil
2015-05-31 12:59 ` [PATCH 2/3] DocBook media: xmllint fixes Hans Verkuil
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Hans Verkuil @ 2015-05-31 12:59 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil
From: Hans Verkuil <hans.verkuil@cisco.com>
satellital -> satellite
antena -> antenna
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
---
Documentation/DocBook/media/dvb/dvbproperty.xml | 8 ++++----
Documentation/DocBook/media/dvb/fe-set-tone.xml | 2 +-
Documentation/DocBook/media/dvb/fe-set-voltage.xml | 2 +-
Documentation/DocBook/media/dvb/frontend.xml | 4 ++--
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml
index a5d0a20..00bf3ed 100644
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -3,7 +3,7 @@
<para>Tuning into a Digital TV physical channel and starting decoding it
requires to change a set of parameters, in order to control the
tuner, the demodulator, the Linear Low-noise Amplifier (LNA) and to set the
- antena subsystem via Satellite Equipment Control (SEC), on satellital
+ antenna subsystem via Satellite Equipment Control (SEC), on satellite
systems. The actual parameters are specific to each particular digital
TV standards, and may change as the digital TV specs evolutes.</para>
<para>In the past, the strategy used were to have an union with the parameters
@@ -171,7 +171,7 @@ get/set up to 64 properties. The actual meaning of each property is described on
<para>Central frequency of the channel.</para>
<para>Notes:</para>
- <para>1)For satellital delivery systems, it is measured in kHz.
+ <para>1)For satellite delivery systems, it is measured in kHz.
For the other ones, it is measured in Hz.</para>
<para>2)For ISDB-T, the channels are usually transmitted with an offset of 143kHz.
E.g. a valid frequency could be 474143 kHz. The stepping is bound to the bandwidth of
@@ -1434,8 +1434,8 @@ enum fe_interleaving {
<para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
</section>
</section>
- <section id="frontend-property-satellital-systems">
- <title>Properties used on satellital delivery systems</title>
+ <section id="frontend-property-satellite-systems">
+ <title>Properties used on satellite delivery systems</title>
<section id="dvbs-params">
<title>DVB-S delivery system</title>
<para>The following parameters are valid for DVB-S:</para>
diff --git a/Documentation/DocBook/media/dvb/fe-set-tone.xml b/Documentation/DocBook/media/dvb/fe-set-tone.xml
index f3d9655..4ef6c74 100644
--- a/Documentation/DocBook/media/dvb/fe-set-tone.xml
+++ b/Documentation/DocBook/media/dvb/fe-set-tone.xml
@@ -49,7 +49,7 @@
<para>This ioctl is used to set the generation of the continuous 22kHz tone.
This call requires read/write permissions.</para>
-<para>Usually, satellital antenna subsystems require that the digital TV
+<para>Usually, satellite antenna subsystems require that the digital TV
device to send a 22kHz tone in order to select between high/low band on
some dual-band LNBf. It is also used to send signals to DiSEqC equipment,
but this is done using the DiSEqC ioctls.</para>
diff --git a/Documentation/DocBook/media/dvb/fe-set-voltage.xml b/Documentation/DocBook/media/dvb/fe-set-voltage.xml
index d43d51a..688fbc2 100644
--- a/Documentation/DocBook/media/dvb/fe-set-voltage.xml
+++ b/Documentation/DocBook/media/dvb/fe-set-voltage.xml
@@ -49,7 +49,7 @@
<para>This ioctl allows to set the DC voltage level sent through the antenna
cable to 13V, 18V or off.</para>
-<para>Usually, a satellital antenna subsystems require that the digital TV
+<para>Usually, a satellite antenna subsystems require that the digital TV
device to send a DC voltage to feed power to the LNBf. Depending on the
LNBf type, the polarization or the intermediate frequency (IF) of the LNBf
can controlled by the voltage level. Other devices (for example, the ones
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index d81b3ff..9eda6c0 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -4,7 +4,7 @@
<itemizedlist>
<listitem>Terrestrial systems: DVB-T, DVB-T2, ATSC, ATSC M/H, ISDB-T, DVB-H, DTMB, CMMB</listitem>
<listitem>Cable systems: DVB-C Annex A/C, ClearQAM (DVB-C Annex B), ISDB-C</listitem>
- <listitem>Satellital systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS</listitem>
+ <listitem>Satellite systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS</listitem>
</itemizedlist>
<para>The DVB frontend controls several sub-devices including:</para>
<itemizedlist>
@@ -21,7 +21,7 @@
<para>NOTE: Transmission via the internet (DVB-IP)
is not yet handled by this API but a future extension is possible.</para>
-<para>On Satellital systems, the API support for the Satellite Equipment Control
+<para>On Satellite systems, the API support for the Satellite Equipment Control
(SEC) allows to power control and to send/receive signals to control the
antenna subsystem, selecting the polarization and choosing the Intermediate
Frequency IF) of the Low Noise Block Converter Feed Horn (LNBf). It
--
2.1.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 2/3] DocBook media: xmllint fixes
2015-05-31 12:59 [PATCH 0/3] DocBook media: xmllint/typo fixes Hans Verkuil
2015-05-31 12:59 ` [PATCH 1/3] DocBook media: fix typos Hans Verkuil
@ 2015-05-31 12:59 ` Hans Verkuil
2015-05-31 12:59 ` [PATCH 3/3] DocBook media: rewrite frontend open/close Hans Verkuil
2015-06-01 9:22 ` [PATCH 0/3] DocBook media: xmllint/typo fixes Mauro Carvalho Chehab
3 siblings, 0 replies; 5+ messages in thread
From: Hans Verkuil @ 2015-05-31 12:59 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil
From: Hans Verkuil <hans.verkuil@cisco.com>
Fixes a large number of xmllint errors.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
---
Documentation/DocBook/media/dvb/dvbproperty.xml | 20 ++++++++---------
.../media/dvb/fe-diseqc-recv-slave-reply.xml | 2 +-
.../DocBook/media/dvb/fe-diseqc-send-burst.xml | 8 +++----
.../media/dvb/fe-diseqc-send-master-cmd.xml | 2 +-
.../media/dvb/fe-enable-high-lnb-voltage.xml | 6 ++---
Documentation/DocBook/media/dvb/fe-get-info.xml | 8 +++----
.../DocBook/media/dvb/fe-get-property.xml | 26 +++++++++++-----------
Documentation/DocBook/media/dvb/fe-read-status.xml | 4 ++--
.../media/dvb/fe-set-frontend-tune-mode.xml | 6 ++---
Documentation/DocBook/media/dvb/fe-set-tone.xml | 8 +++----
Documentation/DocBook/media/dvb/fe-set-voltage.xml | 6 ++---
Documentation/DocBook/media/dvb/frontend.xml | 16 ++++++-------
.../DocBook/media/dvb/frontend_legacy_api.xml | 3 +--
13 files changed, 56 insertions(+), 59 deletions(-)
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml
index 00bf3ed..5dfde52 100644
--- a/Documentation/DocBook/media/dvb/dvbproperty.xml
+++ b/Documentation/DocBook/media/dvb/dvbproperty.xml
@@ -27,13 +27,13 @@
rate of 5.217 Mbauds, those properties should be sent to
<link linkend="FE_GET_PROPERTY"><constant>FE_SET_PROPERTY</constant></link> ioctl:</para>
<itemizedlist>
- <listitem>&DTV-DELIVERY-SYSTEM; = SYS_DVBC_ANNEX_A</listitem>
- <listitem>&DTV-FREQUENCY; = 651000000</listitem>
- <listitem>&DTV-MODULATION; = QAM_256</listitem>
- <listitem>&DTV-INVERSION; = INVERSION_AUTO</listitem>
- <listitem>&DTV-SYMBOL-RATE; = 5217000</listitem>
- <listitem>&DTV-INNER-FEC; = FEC_3_4</listitem>
- <listitem>&DTV-TUNE;</listitem>
+ <listitem><para>&DTV-DELIVERY-SYSTEM; = SYS_DVBC_ANNEX_A</para></listitem>
+ <listitem><para>&DTV-FREQUENCY; = 651000000</para></listitem>
+ <listitem><para>&DTV-MODULATION; = QAM_256</para></listitem>
+ <listitem><para>&DTV-INVERSION; = INVERSION_AUTO</para></listitem>
+ <listitem><para>&DTV-SYMBOL-RATE; = 5217000</para></listitem>
+ <listitem><para>&DTV-INNER-FEC; = FEC_3_4</para></listitem>
+ <listitem><para>&DTV-TUNE;</para></listitem>
</itemizedlist>
<para>The code that would do the above is:</para>
@@ -394,7 +394,6 @@ get/set up to 64 properties. The actual meaning of each property is described on
</row><row>
<entry>FEC_3_5</entry>
<entry>Forward Error Correction Code 3/5</entry>
- </row><row>
</row>
</tbody>
</tgroup>
@@ -916,7 +915,6 @@ typedef enum atscmh_sccc_code_mode {
</tbody>
</tgroup>
</table>
-</section>
<para>Notes:</para>
<para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
@@ -924,6 +922,7 @@ typedef enum atscmh_sccc_code_mode {
in the missing parameters.</para>
<para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
<para>3) DTMB specifies PN420, PN595 and PN945.</para>
+</section>
</section>
<section id="DTV-TRANSMISSION-MODE">
<title><constant>DTV_TRANSMISSION_MODE</constant></title>
@@ -975,12 +974,10 @@ typedef enum atscmh_sccc_code_mode {
</row><row>
<entry>TRANSMISSION_MODE_C3780</entry>
<entry>Multi Carrier (C=3780) transmission mode (DTMB)</entry>
- </row><row>
</row>
</tbody>
</tgroup>
</table>
-</section>
<para>Notes:</para>
@@ -993,6 +990,7 @@ typedef enum atscmh_sccc_code_mode {
<para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
<para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
<para>5) DTMB specifies C1 and C3780.</para>
+</section>
</section>
<section id="DTV-HIERARCHY">
<title><constant>DTV_HIERARCHY</constant></title>
diff --git a/Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml b/Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
index de68b5b..4595dbf 100644
--- a/Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
+++ b/Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
@@ -15,7 +15,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&dvb-diseqc-slave-reply; *<parameter>argp</parameter></paramdef>
+ <paramdef>struct dvb_diseqc_slave_reply *<parameter>argp</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
diff --git a/Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml b/Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
index f79c3f2..91dd207 100644
--- a/Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
+++ b/Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
@@ -15,7 +15,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&fe-sec-mini-cmd; *<parameter>tone</parameter></paramdef>
+ <paramdef>enum fe_sec_mini_cmd *<parameter>tone</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -58,11 +58,11 @@
&return-value-dvb;
</refsect1>
-<section id="fe-sec-mini-cmd-t">
+<refsect1 id="fe-sec-mini-cmd-t">
<title>enum fe_sec_mini_cmd</title>
<table pgwide="1" frame="none" id="fe-sec-mini-cmd">
- <title>enum fe_sec_tone_mode</title>
+ <title>enum fe_sec_mini_cmd</title>
<tgroup cols="2">
&cs-def;
<thead>
@@ -84,6 +84,6 @@
</tbody>
</tgroup>
</table>
-</section>
+</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml b/Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml
index d4d6cd8..38cf313 100644
--- a/Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml
+++ b/Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml
@@ -15,7 +15,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&dvb-diseqc-master-cmd; *<parameter>argp</parameter></paramdef>
+ <paramdef>struct dvb_diseqc_master_cmd *<parameter>argp</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
diff --git a/Documentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml b/Documentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml
index 3ee08a8..c11890b 100644
--- a/Documentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml
+++ b/Documentation/DocBook/media/dvb/fe-enable-high-lnb-voltage.xml
@@ -41,9 +41,9 @@
<listitem>
<para>Valid flags:</para>
<itemizedlist>
- <listitem>0 - normal 13V and 18V.</listitem>
- <listitem>>0 - enables slightly higher voltages instead of
- 13/18V, in order to compensate for long antena cables.</listitem>
+ <listitem><para>0 - normal 13V and 18V.</para></listitem>
+ <listitem><para>>0 - enables slightly higher voltages instead of
+ 13/18V, in order to compensate for long antenna cables.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
diff --git a/Documentation/DocBook/media/dvb/fe-get-info.xml b/Documentation/DocBook/media/dvb/fe-get-info.xml
index 4400790..0e0245e 100644
--- a/Documentation/DocBook/media/dvb/fe-get-info.xml
+++ b/Documentation/DocBook/media/dvb/fe-get-info.xml
@@ -16,7 +16,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&dvb-frontend-info; *<parameter>argp</parameter></paramdef>
+ <paramdef>struct dvb_frontend_info *<parameter>argp</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -112,12 +112,12 @@ driver is not compatible with this specification the ioctl returns an error.
</tbody>
</tgroup>
</table>
- </refsect1>
<para>NOTE: The frequencies are specified in Hz for Terrestrial and Cable
systems. They're specified in kHz for Satellite systems</para>
+ </refsect1>
-<section id="fe-caps-t">
+<refsect1 id="fe-caps-t">
<title>frontend capabilities</title>
<para>Capabilities describe what a frontend can do. Some capabilities are
@@ -262,5 +262,5 @@ driver is not compatible with this specification the ioctl returns an error.
</tbody>
</tgroup>
</table>
-</section>
+</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/fe-get-property.xml b/Documentation/DocBook/media/dvb/fe-get-property.xml
index 456ed92..7d0bd78 100644
--- a/Documentation/DocBook/media/dvb/fe-get-property.xml
+++ b/Documentation/DocBook/media/dvb/fe-get-property.xml
@@ -17,7 +17,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&dtv-properties; *<parameter>argp</parameter></paramdef>
+ <paramdef>struct dtv_property *<parameter>argp</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -57,25 +57,25 @@ and on the device:</para>
<listitem>
<para><constant>FE_SET_PROPERTY:</constant></para>
<itemizedlist>
-<listitem>This ioctl is used to set one or more
- frontend properties.</listitem>
-<listitem>This is the basic command to request the frontend to tune into some
- frequency and to start decoding the digital TV signal.</listitem>
-<listitem>This call requires read/write access to the device.</listitem>
-<listitem>At return, the values are updated to reflect the
- actual parameters used.</listitem>
+<listitem><para>This ioctl is used to set one or more
+ frontend properties.</para></listitem>
+<listitem><para>This is the basic command to request the frontend to tune into some
+ frequency and to start decoding the digital TV signal.</para></listitem>
+<listitem><para>This call requires read/write access to the device.</para></listitem>
+<listitem><para>At return, the values are updated to reflect the
+ actual parameters used.</para></listitem>
</itemizedlist>
</listitem>
<listitem>
<para><constant>FE_GET_PROPERTY:</constant></para>
<itemizedlist>
-<listitem>This ioctl is used to get properties and
-statistics from the frontend.</listitem>
-<listitem>No properties are changed, and statistics aren't reset.</listitem>
-<listitem>This call only requires read-only access to the device.</listitem>
+<listitem><para>This ioctl is used to get properties and
+statistics from the frontend.</para></listitem>
+<listitem><para>No properties are changed, and statistics aren't reset.</para></listitem>
+<listitem><para>This call only requires read-only access to the device.</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
-&return-value-dvb;.
+&return-value-dvb;
</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/fe-read-status.xml b/Documentation/DocBook/media/dvb/fe-read-status.xml
index bbd0b5b..3e4c794 100644
--- a/Documentation/DocBook/media/dvb/fe-read-status.xml
+++ b/Documentation/DocBook/media/dvb/fe-read-status.xml
@@ -59,7 +59,7 @@ pointer to an integer where the status will be written.
&return-value-dvb;
</refsect1>
-<section id="fe-status-t">
+<refsect1 id="fe-status-t">
<title>int fe_status</title>
<para>The fe_status parameter is used to indicate the current state
@@ -103,5 +103,5 @@ pointer to an integer where the status will be written.
</tbody>
</tgroup>
</table>
-</section>
+</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml b/Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml
index 30bc99d..99fa8a0 100644
--- a/Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml
+++ b/Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml
@@ -40,14 +40,14 @@
<listitem>
<para>Valid flags:</para>
<itemizedlist>
- <listitem>0 - normal tune mode</listitem>
- <listitem>FE_TUNE_MODE_ONESHOT - When set, this flag will
+ <listitem><para>0 - normal tune mode</para></listitem>
+ <listitem><para>FE_TUNE_MODE_ONESHOT - When set, this flag will
disable any zigzagging or other "normal" tuning behaviour.
Additionally, there will be no automatic monitoring of the
lock status, and hence no frontend events will be
generated. If a frontend device is closed, this flag will
be automatically turned off when the device is reopened
- read-write.</listitem>
+ read-write.</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
diff --git a/Documentation/DocBook/media/dvb/fe-set-tone.xml b/Documentation/DocBook/media/dvb/fe-set-tone.xml
index 4ef6c74..12cd4dd 100644
--- a/Documentation/DocBook/media/dvb/fe-set-tone.xml
+++ b/Documentation/DocBook/media/dvb/fe-set-tone.xml
@@ -15,7 +15,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&fe-sec-tone-mode; *<parameter>tone</parameter></paramdef>
+ <paramdef>enum fe_sec_tone_mode *<parameter>tone</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -61,8 +61,8 @@
&return-value-dvb;
</refsect1>
-<section id="fe-sec-tone-mode-t">
-<title>enum fe_sec_voltage</title>
+<refsect1 id="fe-sec-tone-mode-t">
+<title>enum fe_sec_tone_mode</title>
<table pgwide="1" frame="none" id="fe-sec-tone-mode">
<title>enum fe_sec_tone_mode</title>
@@ -86,6 +86,6 @@
</tbody>
</tgroup>
</table>
-</section>
+</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/fe-set-voltage.xml b/Documentation/DocBook/media/dvb/fe-set-voltage.xml
index 688fbc2..73710f8 100644
--- a/Documentation/DocBook/media/dvb/fe-set-voltage.xml
+++ b/Documentation/DocBook/media/dvb/fe-set-voltage.xml
@@ -15,7 +15,7 @@
<funcdef>int <function>ioctl</function></funcdef>
<paramdef>int <parameter>fd</parameter></paramdef>
<paramdef>int <parameter>request</parameter></paramdef>
- <paramdef>&fe-sec-voltage; *<parameter>voltage</parameter></paramdef>
+ <paramdef>enum fe_sec_voltage *<parameter>voltage</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@@ -65,7 +65,7 @@
&return-value-dvb;
</refsect1>
-<section id="fe-sec-voltage-t">
+<refsect1 id="fe-sec-voltage-t">
<title>enum fe_sec_voltage</title>
<table pgwide="1" frame="none" id="fe-sec-voltage">
@@ -92,6 +92,6 @@
</tbody>
</tgroup>
</table>
-</section>
+</refsect1>
</refentry>
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index 9eda6c0..ab42d8c 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -2,16 +2,16 @@
<para>The DVB frontend API was designed to support three types of delivery systems:</para>
<itemizedlist>
- <listitem>Terrestrial systems: DVB-T, DVB-T2, ATSC, ATSC M/H, ISDB-T, DVB-H, DTMB, CMMB</listitem>
- <listitem>Cable systems: DVB-C Annex A/C, ClearQAM (DVB-C Annex B), ISDB-C</listitem>
- <listitem>Satellite systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS</listitem>
+ <listitem><para>Terrestrial systems: DVB-T, DVB-T2, ATSC, ATSC M/H, ISDB-T, DVB-H, DTMB, CMMB</para></listitem>
+ <listitem><para>Cable systems: DVB-C Annex A/C, ClearQAM (DVB-C Annex B), ISDB-C</para></listitem>
+ <listitem><para>Satellite systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS</para></listitem>
</itemizedlist>
<para>The DVB frontend controls several sub-devices including:</para>
<itemizedlist>
- <listitem>Tuner</listitem>,
- <listitem>Digital TV demodulator</listitem>
- <listitem>Low noise amplifier (LNA)</listitem>
- <listitem>Satellite Equipment Control (SEC) hardware (only for Satellite).</listitem>
+ <listitem><para>Tuner</para></listitem>
+ <listitem><para>Digital TV demodulator</para></listitem>
+ <listitem><para>Low noise amplifier (LNA)</para></listitem>
+ <listitem><para>Satellite Equipment Control (SEC) hardware (only for Satellite).</para></listitem>
</itemizedlist>
<para>The frontend can be accessed through
<emphasis role="bold">/dev/dvb/adapter?/frontend?</emphasis>. Data types and
@@ -50,7 +50,7 @@ specification is available at
<para>Signal statistics are provided via <link linkend="FE_GET_PROPERTY"><constant>FE_GET_PROPERTY</constant></link>.
Please notice that several statistics require the demodulator to be fully
locked (e. g. with FE_HAS_LOCK bit set). See
- <xref linkend="frontend-stat-properties">Frontend statistics indicators</xref>
+ <link linkend="frontend-stat-properties">Frontend statistics indicators</link>
for more details.</para>
</section>
diff --git a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
index cb2e183..3005cec 100644
--- a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
+++ b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml
@@ -95,7 +95,6 @@ supported via the new <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET
</row><row>
<entry>BANDWIDTH_10_MHZ</entry>
<entry>10 MHz</entry>
- </row><row>
</row>
</tbody>
</tgroup>
@@ -200,7 +199,7 @@ struct dvb_vsb_parameters {
</section>
</section>
-<section id="frontend_fcalls">
+<section id="frontend_legacy_fcalls">
<title>Frontend Legacy Function Calls</title>
<para>Those functions are defined at DVB version 3. The support is kept in
--
2.1.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PATCH 3/3] DocBook media: rewrite frontend open/close
2015-05-31 12:59 [PATCH 0/3] DocBook media: xmllint/typo fixes Hans Verkuil
2015-05-31 12:59 ` [PATCH 1/3] DocBook media: fix typos Hans Verkuil
2015-05-31 12:59 ` [PATCH 2/3] DocBook media: xmllint fixes Hans Verkuil
@ 2015-05-31 12:59 ` Hans Verkuil
2015-06-01 9:22 ` [PATCH 0/3] DocBook media: xmllint/typo fixes Mauro Carvalho Chehab
3 siblings, 0 replies; 5+ messages in thread
From: Hans Verkuil @ 2015-05-31 12:59 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil
From: Hans Verkuil <hans.verkuil@cisco.com>
To fix the last xmllint errors the open and close function reference
description was rewritten based on the v4l2 open and close functions.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
---
Documentation/DocBook/media/dvb/frontend.xml | 281 +++++++++++++++------------
1 file changed, 159 insertions(+), 122 deletions(-)
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
index ab42d8c..c7fa3d8 100644
--- a/Documentation/DocBook/media/dvb/frontend.xml
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -59,11 +59,54 @@ specification is available at
<section id="frontend_fcalls">
<title>Frontend Function Calls</title>
-<section id="frontend_f_open">
-<title>open()</title>
-<para>DESCRIPTION</para>
-<informaltable><tgroup cols="1"><tbody><row>
-<entry align="char">
+<refentry id="frontend_f_open">
+ <refmeta>
+ <refentrytitle>open()</refentrytitle>
+ &manvol;
+ </refmeta>
+
+ <refnamediv>
+ <refname>fe-open</refname>
+ <refpurpose>Open a frontend device</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>#include <fcntl.h></funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>int <function>open</function></funcdef>
+ <paramdef>const char *<parameter>device_name</parameter></paramdef>
+ <paramdef>int <parameter>flags</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Arguments</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>device_name</parameter></term>
+ <listitem>
+ <para>Device to be opened.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>flags</parameter></term>
+ <listitem>
+ <para>Open flags. Access mode must be
+<constant>O_RDWR</constant>. This is just a technicality, input devices
+still support only reading and output devices only writing.</para>
+ <para>When the <constant>O_NONBLOCK</constant> flag is
+given, the read() function will return the &EAGAIN; when no data is available,
+otherwise these functions block until data becomes
+available. Other flags have no effect.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
<para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
for subsequent use. Usually the first thing to do after a successful open is to
find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
@@ -82,127 +125,121 @@ specification is available at
for use in the specified mode. This implies that the corresponding hardware is
powered up, and that other front-ends may have been powered down to make
that possible.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-
-<para>SYNOPSIS</para>
-<informaltable><tgroup cols="1"><tbody><row><entry
- align="char">
-<para>int open(const char ⋆deviceName, int flags);</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>PARAMETERS
-</para>
-<informaltable><tgroup cols="2"><tbody><row><entry
- align="char">
-<para>const char
- *deviceName</para>
-</entry><entry
- align="char">
-<para>Name of specific video device.</para>
-</entry>
- </row><row><entry
- align="char">
-<para>int flags</para>
-</entry><entry
- align="char">
-<para>A bit-wise OR of the following flags:</para>
-</entry>
- </row><row><entry
- align="char">
-</entry><entry
- align="char">
-<para>O_RDONLY read-only access</para>
-</entry>
- </row><row><entry
- align="char">
-</entry><entry
- align="char">
-<para>O_RDWR read/write access</para>
-</entry>
- </row><row><entry
- align="char">
-</entry><entry
- align="char">
-<para>O_NONBLOCK open in non-blocking mode</para>
-</entry>
- </row><row><entry
- align="char">
-</entry><entry
- align="char">
-<para>(blocking mode is the default)</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>RETURN VALUE</para>
-<informaltable><tgroup cols="2"><tbody><row><entry
- align="char">
-<para>ENODEV</para>
-</entry><entry
- align="char">
-<para>Device driver not loaded/available.</para>
-</entry>
- </row><row><entry
- align="char">
-<para>EINTERNAL</para>
-</entry><entry
- align="char">
-<para>Internal error.</para>
-</entry>
- </row><row><entry
- align="char">
-<para>EBUSY</para>
-</entry><entry
- align="char">
-<para>Device or resource busy.</para>
-</entry>
- </row><row><entry
- align="char">
-<para>EINVAL</para>
-</entry><entry
- align="char">
-<para>Invalid argument.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-</section>
+ </refsect1>
-<section id="frontend_f_close">
-<title>close()</title>
-<para>DESCRIPTION
-</para>
-<informaltable><tgroup cols="1"><tbody><row><entry
- align="char">
+ <refsect1>
+ <title>Return Value</title>
+
+ <para>On success <function>open</function> returns the new file
+descriptor. On error -1 is returned, and the <varname>errno</varname>
+variable is set appropriately. Possible error codes are:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><errorcode>EACCES</errorcode></term>
+ <listitem>
+ <para>The caller has no permission to access the
+device.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><errorcode>EBUSY</errorcode></term>
+ <listitem>
+ <para>The driver does not support multiple opens and the
+device is already in use.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><errorcode>ENXIO</errorcode></term>
+ <listitem>
+ <para>No device corresponding to this device special file
+exists.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><errorcode>ENOMEM</errorcode></term>
+ <listitem>
+ <para>Not enough kernel memory was available to complete the
+request.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><errorcode>EMFILE</errorcode></term>
+ <listitem>
+ <para>The process already has the maximum number of
+files open.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><errorcode>ENFILE</errorcode></term>
+ <listitem>
+ <para>The limit on the total number of files open on the
+system has been reached.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+</refentry>
+
+<refentry id="frontend_f_close">
+ <refmeta>
+ <refentrytitle>close()</refentrytitle>
+ &manvol;
+ </refmeta>
+
+ <refnamediv>
+ <refname>fe-close</refname>
+ <refpurpose>Close a frontend device</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>#include <unistd.h></funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>int <function>close</function></funcdef>
+ <paramdef>int <parameter>fd</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Arguments</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>fd</parameter></term>
+ <listitem>
+ <para>&fd;</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
<para>This system call closes a previously opened front-end device. After closing
a front-end device, its corresponding hardware might be powered down
automatically.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>SYNOPSIS
-</para>
-<informaltable><tgroup cols="1"><tbody><row><entry
- align="char">
-<para>int close(int fd);</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>PARAMETERS
-</para>
-<informaltable><tgroup cols="2"><tbody><row><entry
- align="char">
-<para>int fd</para>
-</entry><entry
- align="char">
-<para>File descriptor returned by a previous call to open().</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-<para>RETURN VALUE</para>
-<informaltable><tgroup cols="2"><tbody><row><entry
- align="char">
-<para>EBADF</para>
-</entry><entry
- align="char">
-<para>fd is not a valid open file descriptor.</para>
-</entry>
- </row></tbody></tgroup></informaltable>
-</section>
+</refsect1>
+ <refsect1>
+ <title>Return Value</title>
+
+ <para>The function returns <returnvalue>0</returnvalue> on
+success, <returnvalue>-1</returnvalue> on failure and the
+<varname>errno</varname> is set appropriately. Possible error
+codes:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><errorcode>EBADF</errorcode></term>
+ <listitem>
+ <para><parameter>fd</parameter> is not a valid open file
+descriptor.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+</refentry>
&sub-fe-get-info;
&sub-fe-read-status;
--
2.1.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH 0/3] DocBook media: xmllint/typo fixes
2015-05-31 12:59 [PATCH 0/3] DocBook media: xmllint/typo fixes Hans Verkuil
` (2 preceding siblings ...)
2015-05-31 12:59 ` [PATCH 3/3] DocBook media: rewrite frontend open/close Hans Verkuil
@ 2015-06-01 9:22 ` Mauro Carvalho Chehab
3 siblings, 0 replies; 5+ messages in thread
From: Mauro Carvalho Chehab @ 2015-06-01 9:22 UTC (permalink / raw)
To: Hans Verkuil; +Cc: linux-media
Em Sun, 31 May 2015 14:59:09 +0200
Hans Verkuil <hverkuil@xs4all.nl> escreveu:
> From: Hans Verkuil <hans.verkuil@cisco.com>
>
> Hi Mauro,
>
> Here are three patches that fix typos and xmllint errors.
>
> The first patch fixes typos, the second a large number of xmllint
> errors and the last fixes a final xmllint error, but it does that by
> copying most of the v4l2 open/close text and you should check whether
> I didn't remove anything that is relevant for DVB.
>
> Note that I use the following 'gitdocs.sh' script to build the documentation:
Patches applied. I had to add two extra patches in order to fix a few
issues (one at the open() conversion and another one that it is likely
a cut-and-past mistake that I introduced).
>
> --------------------------------
> #!/bin/sh
>
> make DOCBOOKS=media_api.xml htmldocs 2>&1 | grep -v "element.*: validity error : ID .* already defined"
> xmllint --noent --postvalid "$PWD/Documentation/DocBook/media_api.xml" >/tmp/x.xml 2>/dev/null
> xmllint --noent --postvalid --noout /tmp/x.xml
> xmlto html-nochunks -m ./Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/media Documentation/DocBook/media_api.xml >/dev/null 2>&1
Updated my scripts to use this more pedantic variation.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2015-06-01 9:22 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-05-31 12:59 [PATCH 0/3] DocBook media: xmllint/typo fixes Hans Verkuil
2015-05-31 12:59 ` [PATCH 1/3] DocBook media: fix typos Hans Verkuil
2015-05-31 12:59 ` [PATCH 2/3] DocBook media: xmllint fixes Hans Verkuil
2015-05-31 12:59 ` [PATCH 3/3] DocBook media: rewrite frontend open/close Hans Verkuil
2015-06-01 9:22 ` [PATCH 0/3] DocBook media: xmllint/typo fixes Mauro Carvalho Chehab
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.