Commit 883dfe8a authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: dvb uAPI docs: minor editorial changes 



Do minor editorial changes to improve documentation readability:

- mark literals as such;
- add table markups to hint sizes;
- define what PES means;
- instead of hardcoding devnode numbers to zero (like adapter0/) use a
  question mark, to indicate that multiple devnodes may exist;
- add cross-references where useful.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 8e319510

Documentation/media/uapi/dvb/ca-fopen.rst

+13 −12
Original line number Diff line number Diff line
@@ -28,20 +28,20 @@ Arguments 
``flags``

  A bit-wise OR of the following flags:



.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|



.. flat-table::

    :header-rows:  0

    :stub-columns: 0

    :widths: 1 16



    -

       - O_RDONLY

    -  - ``O_RDONLY``

       - read-only access



    -

       - O_RDWR

    -  - ``O_RDWR``

       - read/write access



    -

       - O_NONBLOCK

    -  - ``O_NONBLOCK``

       - open in non-blocking mode

         (blocking mode is the default)
@@ -52,15 +52,16 @@ Description 
This system call opens a named ca device (e.g. ``/dev/dvb/adapter?/ca?``)

for subsequent use.



When an open() call has succeeded, the device will be ready for use. The

When an ``open()`` call has succeeded, the device will be ready for use. The

significance of blocking or non-blocking mode is described in the

documentation for functions where there is a difference. It does not

affect the semantics of the open() call itself. A device opened in

affect the semantics of the ``open()`` call itself. A device opened in

blocking mode can later be put into non-blocking mode (and vice versa)

using the F_SETFL command of the fcntl system call. This is a standard

system call, documented in the Linux manual page for fcntl. Only one

user can open the CA Device in O_RDWR mode. All other attempts to open

the device in this mode will fail, and an error code will be returned.

using the ``F_SETFL`` command of the ``fcntl`` system call. This is a

standard system call, documented in the Linux manual page for fcntl.

Only one user can open the CA Device in ``O_RDWR`` mode. All other

attempts to open the device in this mode will fail, and an error code

will be returned.





Return Value

Documentation/media/uapi/dvb/dmx-add-pid.rst

+2 −2
Original line number Diff line number Diff line
@@ -33,8 +33,8 @@ Description 
-----------



This ioctl call allows to add multiple PIDs to a transport stream filter

previously set up with DMX_SET_PES_FILTER and output equal to

DMX_OUT_TSDEMUX_TAP.

previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to

:c:type:`DMX_OUT_TSDEMUX_TAP <dmx_output>`.





Return Value

Documentation/media/uapi/dvb/dmx-fclose.rst

+3 −2
Original line number Diff line number Diff line
@@ -23,13 +23,14 @@ Arguments 
---------



``fd``

  File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.

  File descriptor returned by a previous call to

  :c:func:`open() <dvb-dmx-open>`.



Description

-----------



This system call deactivates and deallocates a filter that was

previously allocated via the open() call.

previously allocated via the :c:func:`open() <dvb-dmx-open>` call.





Return Value

Documentation/media/uapi/dvb/dmx-fopen.rst

+13 −10
Original line number Diff line number Diff line
@@ -27,20 +27,23 @@ Arguments 
``flags``

  A bit-wise OR of the following flags:



.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|



.. flat-table::

    :header-rows:  0

    :stub-columns: 0

    :widths: 1 16



    -

       - O_RDONLY

       - ``O_RDONLY``

       - read-only access



    -

       - O_RDWR

       - ``O_RDWR``

       - read/write access



    -

       - O_NONBLOCK

       - ``O_NONBLOCK``

       - open in non-blocking mode

         (blocking mode is the default)
@@ -48,22 +51,22 @@ Arguments 
Description

-----------



This system call, used with a device name of /dev/dvb/adapter0/demux0,

This system call, used with a device name of ``/dev/dvb/adapter?/demux?``,

allocates a new filter and returns a handle which can be used for

subsequent control of that filter. This call has to be made for each

filter to be used, i.e. every returned file descriptor is a reference to

a single filter. /dev/dvb/adapter0/dvr0 is a logical device to be used

a single filter. ``/dev/dvb/adapter?/dvr?`` is a logical device to be used

for retrieving Transport Streams for digital video recording. When

reading from this device a transport stream containing the packets from

all PES filters set in the corresponding demux device

(/dev/dvb/adapter0/demux0) having the output set to DMX_OUT_TS_TAP. A

recorded Transport Stream is replayed by writing to this device.

(``/dev/dvb/adapter?/demux?``) having the output set to ``DMX_OUT_TS_TAP``.

A recorded Transport Stream is replayed by writing to this device.



The significance of blocking or non-blocking mode is described in the

documentation for functions where there is a difference. It does not

affect the semantics of the open() call itself. A device opened in

blocking mode can later be put into non-blocking mode (and vice versa)

using the F_SETFL command of the fcntl system call.

affect the semantics of the ``open()`` call itself. A device opened

in blocking mode can later be put into non-blocking mode (and vice versa)

using the ``F_SETFL`` command of the fcntl system call.





Return Value

Documentation/media/uapi/dvb/dmx-fread.rst

+4 −4
Original line number Diff line number Diff line
@@ -33,10 +33,10 @@ Arguments 
Description

-----------



This system call returns filtered data, which might be section or PES

data. The filtered data is transferred from the driver’s internal

circular buffer to buf. The maximum amount of data to be transferred is

implied by count.

This system call returns filtered data, which might be section or Packetized

Elementary Stream (PES) data. The filtered data is transferred from

the driver’s internal circular buffer to ``buf``. The maximum amount of data

to be transferred is implied by count.



.. note::

CRA Git | Maintained and supported by SUSTech CRA and CCSE