summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/media/uapi/dvb')
-rw-r--r--Documentation/media/uapi/dvb/dvb-fe-read-status.rst11
-rw-r--r--Documentation/media/uapi/dvb/dvbapi.rst4
-rw-r--r--Documentation/media/uapi/dvb/dvbproperty.rst26
-rw-r--r--Documentation/media/uapi/dvb/examples.rst8
-rw-r--r--Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst5
-rw-r--r--Documentation/media/uapi/dvb/fe-get-info.rst4
-rw-r--r--Documentation/media/uapi/dvb/fe-read-status.rst6
-rw-r--r--Documentation/media/uapi/dvb/fe-set-tone.rst8
-rw-r--r--Documentation/media/uapi/dvb/fe-set-voltage.rst10
-rw-r--r--Documentation/media/uapi/dvb/frontend.rst4
10 files changed, 44 insertions, 42 deletions
diff --git a/Documentation/media/uapi/dvb/dvb-fe-read-status.rst b/Documentation/media/uapi/dvb/dvb-fe-read-status.rst
index 1c708c5e6bc0..fcffaa7e1463 100644
--- a/Documentation/media/uapi/dvb/dvb-fe-read-status.rst
+++ b/Documentation/media/uapi/dvb/dvb-fe-read-status.rst
@@ -15,8 +15,9 @@ The information about the frontend tuner locking status can be queried
using :ref:`FE_READ_STATUS`.
Signal statistics are provided via
-:ref:`FE_GET_PROPERTY`. Please note that several
-statistics require the demodulator to be fully locked (e. g. with
-FE_HAS_LOCK bit set). See
-:ref:`Frontend statistics indicators <frontend-stat-properties>` for
-more details.
+:ref:`FE_GET_PROPERTY`.
+
+.. note:: Most statistics require the demodulator to be fully locked
+ (e. g. with FE_HAS_LOCK bit set). See
+ :ref:`Frontend statistics indicators <frontend-stat-properties>` for
+ more details.
diff --git a/Documentation/media/uapi/dvb/dvbapi.rst b/Documentation/media/uapi/dvb/dvbapi.rst
index 60fb3d46b1d6..6c06147f167c 100644
--- a/Documentation/media/uapi/dvb/dvbapi.rst
+++ b/Documentation/media/uapi/dvb/dvbapi.rst
@@ -8,8 +8,8 @@
Digital TV API
##############
-**NOTE:** This API is also known as **DVB API**, although it is generic
-enough to support all digital TV standards.
+.. note:: This API is also known as **DVB API**, although it is generic
+ enough to support all digital TV standards.
**Version 5.10**
diff --git a/Documentation/media/uapi/dvb/dvbproperty.rst b/Documentation/media/uapi/dvb/dvbproperty.rst
index 3c348e585729..cd0511b06c2c 100644
--- a/Documentation/media/uapi/dvb/dvbproperty.rst
+++ b/Documentation/media/uapi/dvb/dvbproperty.rst
@@ -20,13 +20,13 @@ Also, the union didn't have any space left to be expanded without
breaking userspace. So, the decision was to deprecate the legacy
union/struct based approach, in favor of a properties set approach.
-NOTE: on Linux DVB API version 3, setting a frontend were done via
-:ref:`struct dvb_frontend_parameters <dvb-frontend-parameters>`.
-This got replaced on version 5 (also called "S2API", as this API were
-added originally_enabled to provide support for DVB-S2), because the
-old API has a very limited support to new standards and new hardware.
-This section describes the new and recommended way to set the frontend,
-with suppports all digital TV delivery systems.
+.. note:: On Linux DVB API version 3, setting a frontend were done via
+ :ref:`struct dvb_frontend_parameters <dvb-frontend-parameters>`.
+ This got replaced on version 5 (also called "S2API", as this API were
+ added originally_enabled to provide support for DVB-S2), because the
+ old API has a very limited support to new standards and new hardware.
+ This section describes the new and recommended way to set the frontend,
+ with suppports all digital TV delivery systems.
Example: with the properties based approach, in order to set the tuner
to a DVB-C channel at 651 kHz, modulated with 256-QAM, FEC 3/4 and
@@ -93,12 +93,12 @@ Example: Setting digital TV frontend properties
return 0;
}
-NOTE: While it is possible to directly call the Kernel code like the
-above example, it is strongly recommended to use
-`libdvbv5 <https://linuxtv.org/docs/libdvbv5/index.html>`__, as it
-provides abstraction to work with the supported digital TV standards and
-provides methods for usual operations like program scanning and to
-read/write channel descriptor files.
+.. attention:: While it is possible to directly call the Kernel code like the
+ above example, it is strongly recommended to use
+ `libdvbv5 <https://linuxtv.org/docs/libdvbv5/index.html>`__, as it
+ provides abstraction to work with the supported digital TV standards and
+ provides methods for usual operations like program scanning and to
+ read/write channel descriptor files.
.. toctree::
diff --git a/Documentation/media/uapi/dvb/examples.rst b/Documentation/media/uapi/dvb/examples.rst
index ead3ddf764c0..bf0a8617de92 100644
--- a/Documentation/media/uapi/dvb/examples.rst
+++ b/Documentation/media/uapi/dvb/examples.rst
@@ -9,10 +9,10 @@ Examples
In this section we would like to present some examples for using the DVB
API.
-NOTE: This section is out of date, and the code below won't even
-compile. Please refer to the
-`libdvbv5 <https://linuxtv.org/docs/libdvbv5/index.html>`__ for
-updated/recommended examples.
+..note:: This section is out of date, and the code below won't even
+ compile. Please refer to the
+ `libdvbv5 <https://linuxtv.org/docs/libdvbv5/index.html>`__ for
+ updated/recommended examples.
.. _tuning:
diff --git a/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst b/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst
index 9f71b39de0c2..d47e9dbf558a 100644
--- a/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst
+++ b/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst
@@ -36,8 +36,9 @@ Arguments
Description
===========
-WARNING: This is a very obscure legacy command, used only at stv0299
-driver. Should not be used on newer drivers.
+.. warning::
+ This is a very obscure legacy command, used only at stv0299
+ driver. Should not be used on newer drivers.
It provides a non-standard method for selecting Diseqc voltage on the
frontend, for Dish Network legacy switches.
diff --git a/Documentation/media/uapi/dvb/fe-get-info.rst b/Documentation/media/uapi/dvb/fe-get-info.rst
index 9a9ddbcdb1ec..bb6c32e47ce8 100644
--- a/Documentation/media/uapi/dvb/fe-get-info.rst
+++ b/Documentation/media/uapi/dvb/fe-get-info.rst
@@ -144,8 +144,8 @@ struct dvb_frontend_info
- Capabilities supported by the frontend
-NOTE: The frequencies are specified in Hz for Terrestrial and Cable
-systems. They're specified in kHz for Satellite systems
+.. note:: The frequencies are specified in Hz for Terrestrial and Cable
+ systems. They're specified in kHz for Satellite systems
.. _fe-caps-t:
diff --git a/Documentation/media/uapi/dvb/fe-read-status.rst b/Documentation/media/uapi/dvb/fe-read-status.rst
index 339955fbe133..624ed9d06488 100644
--- a/Documentation/media/uapi/dvb/fe-read-status.rst
+++ b/Documentation/media/uapi/dvb/fe-read-status.rst
@@ -40,9 +40,9 @@ used to check about the locking status of the frontend after being
tuned. The ioctl takes a pointer to an integer where the status will be
written.
-NOTE: the size of status is actually sizeof(enum fe_status), with
-varies according with the architecture. This needs to be fixed in the
-future.
+.. note:: The size of status is actually sizeof(enum fe_status), with
+ varies according with the architecture. This needs to be fixed in the
+ future.
.. _fe-status-t:
diff --git a/Documentation/media/uapi/dvb/fe-set-tone.rst b/Documentation/media/uapi/dvb/fe-set-tone.rst
index 763b61d91004..545e2afba2c0 100644
--- a/Documentation/media/uapi/dvb/fe-set-tone.rst
+++ b/Documentation/media/uapi/dvb/fe-set-tone.rst
@@ -42,10 +42,10 @@ 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.
-NOTE: if more than one device is connected to the same antenna, setting
-a tone may interfere on other devices, as they may lose the capability
-of selecting the band. So, it is recommended that applications would
-change to SEC_TONE_OFF when the device is not used.
+.. attention:: If more than one device is connected to the same antenna,
+ setting a tone may interfere on other devices, as they may lose the
+ capability of selecting the band. So, it is recommended that applications
+ would change to SEC_TONE_OFF when the device is not used.
.. _fe-sec-tone-mode-t:
diff --git a/Documentation/media/uapi/dvb/fe-set-voltage.rst b/Documentation/media/uapi/dvb/fe-set-voltage.rst
index 517f79bdbb4b..2b19086b660a 100644
--- a/Documentation/media/uapi/dvb/fe-set-voltage.rst
+++ b/Documentation/media/uapi/dvb/fe-set-voltage.rst
@@ -48,11 +48,11 @@ the ones that implement DISEqC and multipoint LNBf's don't need to
control the voltage level, provided that either 13V or 18V is sent to
power up the LNBf.
-NOTE: if more than one device is connected to the same antenna, setting
-a voltage level may interfere on other devices, as they may lose the
-capability of setting polarization or IF. So, on those cases, setting
-the voltage to SEC_VOLTAGE_OFF while the device is not is used is
-recommended.
+.. attention:: if more than one device is connected to the same antenna,
+ setting a voltage level may interfere on other devices, as they may lose
+ the capability of setting polarization or IF. So, on those cases, setting
+ the voltage to SEC_VOLTAGE_OFF while the device is not is used is
+ recommended.
Return Value
diff --git a/Documentation/media/uapi/dvb/frontend.rst b/Documentation/media/uapi/dvb/frontend.rst
index 8c7e502bff1f..48c5cd487ce7 100644
--- a/Documentation/media/uapi/dvb/frontend.rst
+++ b/Documentation/media/uapi/dvb/frontend.rst
@@ -29,8 +29,8 @@ The frontend can be accessed through ``/dev/dvb/adapter?/frontend?``.
Data types and ioctl definitions can be accessed by including
``linux/dvb/frontend.h`` in your application.
-NOTE: Transmission via the internet (DVB-IP) is not yet handled by this
-API but a future extension is possible.
+.. note:: Transmission via the internet (DVB-IP) is not yet handled by this
+ API but a future extension is possible.
On Satellite systems, the API support for the Satellite Equipment
Control (SEC) allows to power control and to send/receive signals to