]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commitdiff
media: dvb uAPI docs: adjust return value ioctl descriptions
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 1 Sep 2017 16:15:43 +0000 (12:15 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Tue, 5 Sep 2017 10:16:37 +0000 (06:16 -0400)
There are several issues on the return value for ioctls:

- Text is confusing;
- Some error codes don't exist;
- The non-generic error codes should come before the text
  that points to the generic error codes;
- Tables don't contain column size hints;
- Some references are not marked as such.

Correct them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
45 files changed:
Documentation/media/uapi/dvb/ca-fclose.rst
Documentation/media/uapi/dvb/ca-fopen.rst
Documentation/media/uapi/dvb/ca-get-cap.rst
Documentation/media/uapi/dvb/ca-get-msg.rst
Documentation/media/uapi/dvb/ca-get-slot-info.rst
Documentation/media/uapi/dvb/ca-reset.rst
Documentation/media/uapi/dvb/ca-send-msg.rst
Documentation/media/uapi/dvb/ca-set-descr.rst
Documentation/media/uapi/dvb/dmx-add-pid.rst
Documentation/media/uapi/dvb/dmx-fclose.rst
Documentation/media/uapi/dvb/dmx-fopen.rst
Documentation/media/uapi/dvb/dmx-fread.rst
Documentation/media/uapi/dvb/dmx-fwrite.rst
Documentation/media/uapi/dvb/dmx-get-pes-pids.rst
Documentation/media/uapi/dvb/dmx-get-stc.rst
Documentation/media/uapi/dvb/dmx-remove-pid.rst
Documentation/media/uapi/dvb/dmx-set-buffer-size.rst
Documentation/media/uapi/dvb/dmx-set-filter.rst
Documentation/media/uapi/dvb/dmx-set-pes-filter.rst
Documentation/media/uapi/dvb/dmx-start.rst
Documentation/media/uapi/dvb/dmx-stop.rst
Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst
Documentation/media/uapi/dvb/fe-diseqc-reset-overload.rst
Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst
Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst
Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst
Documentation/media/uapi/dvb/fe-enable-high-lnb-voltage.rst
Documentation/media/uapi/dvb/fe-get-event.rst
Documentation/media/uapi/dvb/fe-get-frontend.rst
Documentation/media/uapi/dvb/fe-get-info.rst
Documentation/media/uapi/dvb/fe-get-property.rst
Documentation/media/uapi/dvb/fe-read-ber.rst
Documentation/media/uapi/dvb/fe-read-signal-strength.rst
Documentation/media/uapi/dvb/fe-read-snr.rst
Documentation/media/uapi/dvb/fe-read-status.rst
Documentation/media/uapi/dvb/fe-read-uncorrected-blocks.rst
Documentation/media/uapi/dvb/fe-set-frontend-tune-mode.rst
Documentation/media/uapi/dvb/fe-set-frontend.rst
Documentation/media/uapi/dvb/fe-set-tone.rst
Documentation/media/uapi/dvb/fe-set-voltage.rst
Documentation/media/uapi/dvb/frontend_f_close.rst
Documentation/media/uapi/dvb/frontend_f_open.rst
Documentation/media/uapi/dvb/net-add-if.rst
Documentation/media/uapi/dvb/net-get-if.rst
Documentation/media/uapi/dvb/net-remove-if.rst

index 5ecefa4abc3d29ba5ca4892316cfcefc0e43357a..d97c1957aad560e8f4d29e31bba0265e4b9a3482 100644 (file)
@@ -34,13 +34,10 @@ This system call closes a previously opened CA device.
 Return Value
 ------------
 
-.. flat-table::
-    :header-rows:  0
-    :stub-columns: 0
+On success 0 is returned.
 
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
-    -  .. row 1
-
-       -  ``EBADF``
-
-       -  fd is not a valid open file descriptor.
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 3d281975144670a8dac61e7fa7643fee43332c61..c974a212b618879d617489e0bae122589f94bab7 100644 (file)
@@ -66,33 +66,11 @@ the device in this mode will fail, and an error code will be returned.
 Return Value
 ------------
 
-.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
-.. flat-table::
-    :header-rows:  0
-    :stub-columns: 0
-
-
-    -  .. row 1
-
-       -  ``ENODEV``
-
-       -  Device driver not loaded/available.
-
-    -  .. row 2
-
-       -  ``EINTERNAL``
-
-       -  Internal error.
-
-    -  .. row 3
-
-       -  ``EBUSY``
-
-       -  Device or resource busy.
-
-    -  .. row 4
+On success 0 is returned.
 
-       -  ``EINVAL``
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
-       -  Invalid argument.
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 02d64acfb08765d5af5bca722b097e0ccceaf025..d2d5c135539682733176ebde4f5c9f4702fd8385 100644 (file)
@@ -40,5 +40,7 @@ Return Value
 On success 0 is returned and :c:type:`ca_caps` is filled.
 
 On error, -1 is returned and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 1ee9d667c901e8e41319fcf67028047104e5baaa..bdb116552068b339465104c52239ab500d99bcdc 100644 (file)
@@ -49,6 +49,11 @@ Description
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index d7e41e038ca79b74787d9cf95aabd5de5a45184a..1a1d6f0c71b99a799b9a081a87dbe5d3860d580a 100644 (file)
@@ -43,7 +43,15 @@ On success 0 is returned, and :c:type:`ca_slot_info` is filled.
 On error -1 is returned, and the ``errno`` variable is set
 appropriately.
 
-If the slot is not available, ``errno`` will contain ``-EINVAL``.
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
+
+.. flat-table::
+    :header-rows:  0
+    :stub-columns: 0
+    :widths: 1 16
+
+    -  -  ``ENODEV``
+       -  the slot is not available.
 
 The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index a5dd2797a92f01397b076a5aa2c5754f51a6fc20..29788325f90e58363043ba3225a33c3004486785 100644 (file)
@@ -35,6 +35,10 @@ be called before start using the CA hardware.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 532ef5f9d6acf56610aad9d8e329042b87083e23..644b6bda1aea7e3d630d239bb72833a37e438879 100644 (file)
@@ -38,6 +38,10 @@ Description
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 95de34cf74ba6bb4c2ad6c2e3be70592dfc4d6ce..9c484317d55c170e1cdd29cb46cecd7f1c53c02b 100644 (file)
@@ -48,6 +48,10 @@ Description
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 689cd1fc9142e73df6a4eed18995fb741789c2d1..0aab2fcaacab1ebb284487c884bab3e05bca03fb 100644 (file)
@@ -40,6 +40,10 @@ DMX_OUT_TSDEMUX_TAP.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index ca93c23cde6db2b1bf01ca22a6aa23414161bebc..b4401379e294466e090dc3a520f94e623d87d537 100644 (file)
@@ -35,13 +35,10 @@ previously allocated via the open() call.
 Return Value
 ------------
 
-.. flat-table::
-    :header-rows:  0
-    :stub-columns: 0
+On success 0 is returned.
 
+On error, -1 is returned and the ``errno`` variable is set
+appropriately.
 
-    -  .. row 1
-
-       -  ``EBADF``
-
-       -  fd is not a valid open file descriptor.
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index a697e33c32ea50726e158e66bb5c5631e592c06a..7ed2fda9a7c7a30aa22efdccd235d1762511a5b3 100644 (file)
@@ -69,31 +69,20 @@ using the F_SETFL command of the fcntl system call.
 Return Value
 ------------
 
-.. flat-table::
-    :header-rows:  0
-    :stub-columns: 0
-
-
-    -  .. row 1
-
-       -  ``ENODEV``
-
-       -  Device driver not loaded/available.
+On success 0 is returned.
 
-    -  .. row 2
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
-       -  ``EINVAL``
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
-       -  Invalid argument.
-
-    -  .. row 3
-
-       -  ``EMFILE``
+.. flat-table::
+    :header-rows:  0
+    :stub-columns: 0
+    :widths: 1 16
 
+    -  -  ``EMFILE``
        -  “Too many open files”, i.e. no more filters available.
 
-    -  .. row 4
-
-       -  ``ENOMEM``
-
-       -  The driver failed to allocate enough memory.
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index e8c7f4db353f001decf923f6d58539de6884ef08..8d2fe9839dd3214d5fed6f5384262d172e6f306e 100644 (file)
@@ -41,54 +41,33 @@ implied by count.
 Return Value
 ------------
 
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
 .. flat-table::
     :header-rows:  0
     :stub-columns: 0
+    :widths: 1 16
 
+    -  -  ``EWOULDBLOCK``
+       -  No data to return and ``O_NONBLOCK`` was specified.
 
-    -  .. row 1
-
-       -  ``EWOULDBLOCK``
-
-       -  No data to return and O_NONBLOCK was specified.
-
-    -  .. row 2
-
-       -  ``EBADF``
-
-       -  fd is not a valid open file descriptor.
-
-    -  .. row 3
-
-       -  ``ECRC``
-
-       -  Last section had a CRC error - no data returned. The buffer is
-         flushed.
-
-    -  .. row 4
-
-       -  ``EOVERFLOW``
-
-       -
-
-    -  .. row 5
-
-       -
+    -  -  ``EOVERFLOW``
        -  The filtered data was not read from the buffer in due time,
          resulting in non-read data being lost. The buffer is flushed.
 
-    -  .. row 6
-
-       -  ``ETIMEDOUT``
-
-       -  The section was not loaded within the stated timeout period. See
-         ioctl DMX_SET_FILTER for how to set a timeout.
+    -  -  ``ETIMEDOUT``
+       -  The section was not loaded within the stated timeout period.
+          See ioctl :ref:`DMX_SET_FILTER` for how to set a timeout.
 
-    -  .. row 7
+    -  -  ``EFAULT``
+       -  The driver failed to write to the callers buffer due to an
+          invalid \*buf pointer.
 
-       -  ``EFAULT``
 
-       -  The driver failed to write to the callers buffer due to an invalid
-         \*buf pointer.
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 8a90dfe2830756474b570f88c6ee751583379952..5e82a9ee418fa91dead5ac7b7e1bd1f6dc413f49 100644 (file)
@@ -44,32 +44,29 @@ The amount of data to be transferred is implied by count.
 Return Value
 ------------
 
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
 .. flat-table::
     :header-rows:  0
     :stub-columns: 0
+    :widths: 1 16
 
-    -  .. row 1
-
-       -  ``EWOULDBLOCK``
-
-       -  No data was written. This might happen if O_NONBLOCK was
+    -  -  ``EWOULDBLOCK``
+       -  No data was written. This might happen if ``O_NONBLOCK`` was
          specified and there is no more buffer space available (if
-         O_NONBLOCK is not specified the function will block until buffer
+         ``O_NONBLOCK`` is not specified the function will block until buffer
          space is available).
 
-    -  .. row 2
-
-       -  ``EBUSY``
-
+    -  -  ``EBUSY``
        -  This error code indicates that there are conflicting requests. The
          corresponding demux device is setup to receive data from the
          front- end. Make sure that these filters are stopped and that the
-         filters with input set to DMX_IN_DVR are started.
-
-    -  .. row 3
-
-       -  ``EBADF``
+         filters with input set to ``DMX_IN_DVR`` are started.
 
-       -  fd is not a valid open file descriptor.
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index b31634a1cca4722e941e266e9b419a19ed88304d..20288c11d2793ac2645046681e47d79a71a91fbd 100644 (file)
@@ -37,6 +37,10 @@ Description
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 9fc501e8128a1654961c3998fd566699243c1b71..6d5d069d4e6c1ee060fc94f817c325846c769584 100644 (file)
@@ -42,17 +42,24 @@ the real 90kHz STC value is stc->stc / stc->base .
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
 .. flat-table::
     :header-rows:  0
     :stub-columns: 0
-
+    :widths: 1 16
 
     -  .. row 1
 
        -  ``EINVAL``
 
        -  Invalid stc number.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index e411495c619ca1fad6aa9a34f7409954ea668f78..1faa40ab11bd543ec8a5a2ab2eb73957a3e6a01f 100644 (file)
@@ -41,6 +41,10 @@ DMX_SET_PES_FILTER or DMX_ADD_PID.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index f2f7379f29edc67bae1b91ad04aa366b38095fbd..a659dd7ca7e6260a3f126d79962de1dfb690df6a 100644 (file)
@@ -40,6 +40,11 @@ used.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 1d50c803d69a213bd2b205f832a5f28d8ba57c1c..d6ee52321717129e73479d0f26cd19edc9e87443 100644 (file)
@@ -47,6 +47,11 @@ will be canceled, and the receive buffer will be flushed.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 145451d04f7dd4680d8c0970962c9fd9c5d9adfd..d70e7bf96a41c36c8557f8a2b800164de17d34a8 100644 (file)
@@ -42,15 +42,17 @@ capability is supported.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
 .. flat-table::
     :header-rows:  0
     :stub-columns: 0
+    :widths: 1 16
 
 
     -  .. row 1
@@ -61,3 +63,7 @@ appropriately. The generic error codes are described at the
          There are active filters filtering data from another input source.
          Make sure that these filters are stopped before starting this
          filter.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 641f3e017fb19f152beb5858e864b7ce6c20b21d..36700e7752967209661d8036668226eed478c4ff 100644 (file)
@@ -29,15 +29,16 @@ Description
 -----------
 
 This ioctl call is used to start the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
+via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`.
 
 
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
 .. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
@@ -51,7 +52,7 @@ appropriately. The generic error codes are described at the
        -  ``EINVAL``
 
        -  Invalid argument, i.e. no filtering parameters provided via the
-         DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
+         :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls.
 
     -  .. row 2
 
@@ -61,3 +62,7 @@ appropriately. The generic error codes are described at the
          There are active filters filtering data from another input source.
          Make sure that these filters are stopped before starting this
          filter.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 569a3df44923f55b33d544bff4df9d26705ac26b..5f4bf63868c173e6ffd28fbc4d2005e4d20eadb0 100644 (file)
@@ -36,6 +36,10 @@ started via the DMX_START command.
 Return Value
 ------------
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 473855584d7f0fc8af973abe5d954ba2a5d6ae79..f220ee351e15fc1085c51e42e929bf082395144a 100644 (file)
@@ -39,6 +39,10 @@ The received message is stored at the buffer pointed by ``argp``.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 75116f283faf2798afe50a7c5a0b51090703672f..e1243097c09e4e9ce98535a3a44cb5eb6e81b40b 100644 (file)
@@ -37,6 +37,10 @@ is manually powered off. Not all DVB adapters support this ioctl.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 54d35517e7846c8fa87943fee7134d16eaaa2ae7..a7e05914efae534e02c635ac8a31342b0983799c 100644 (file)
@@ -43,6 +43,10 @@ It provides support for what's specified at
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 7392d6747ad69bf8f1012be497ea7e40448f3486..d274be7316ffea4ee3ea24863a9d73e7b83d8cdc 100644 (file)
@@ -38,7 +38,11 @@ Sends the DiSEqC command pointed by ``argp`` to the antenna subsystem.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
 
index f41371f124562bb189942ff7cb7a66d630dfbfb4..dcf2d20d460fc79444921ecf12cdb1d13ed9bd7b 100644 (file)
@@ -46,6 +46,10 @@ dishes were already legacy in 2004.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index bacafbc462d2aa5d1b2129ab9259cb0b7056c881..b20cb360fe37962a6c75c60c4e7802fcadbfb6cc 100644 (file)
@@ -45,6 +45,10 @@ voltages.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 8a719c33073d3eda33503ee24a8e3ec6e0f82db1..505db94bf1835619478cb392d8773bcab9635a77 100644 (file)
@@ -44,10 +44,10 @@ an event becomes available.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
 
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
 
 .. flat-table::
@@ -66,3 +66,6 @@ appropriately. The generic error codes are described at the
        -  ``EOVERFLOW``
 
        -  Overflow in event queue - one or more events were lost.
+
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index d53a3f8237c334e28d9eead08e1b831eb133f0c3..5db552cedd703019e12f5515a36c72ef924f8b1e 100644 (file)
@@ -42,11 +42,10 @@ this command, read-only access to the device is sufficient.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
+On success 0 is returned.
 
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
 .. flat-table::
     :header-rows:  0
@@ -58,3 +57,6 @@ appropriately. The generic error codes are described at the
        -  ``EINVAL``
 
        -  Maximum supported symbol rate reached.
+
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 30dde8a791f31a792b0eeb81b738cda5adc8b4d3..17e9d9aa5b228bd8911f534498ff9ab3e3e21c2e 100644 (file)
@@ -53,6 +53,10 @@ The frontend capabilities are described at :c:type:`fe_caps`.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index b22e37c4a78749cc227c2302b8c658be69177490..fffa78d17f61527920e756dec10bac277b313d5b 100644 (file)
@@ -64,6 +64,10 @@ depends on the delivery system and on the device:
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index e54972ad52505587a78ecb9f8fc51eede53f6e4a..1e6a79567a4cdf94009b728b65974bc74ca43542 100644 (file)
@@ -41,6 +41,10 @@ access to the device is sufficient.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 4b13c47577442143a982610f92ca16531d7fa6b4..198f6dfb53a17bc0a2086ca3d6e3ef3d05482535 100644 (file)
@@ -41,6 +41,10 @@ to the device is sufficient.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 2aed487f5c993612151d334bb6fcbdffa07b9cb0..6db22c043512554359bd08e6a5f47422c5e52b9d 100644 (file)
@@ -41,6 +41,10 @@ to the device is sufficient.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 21b2db3591fd9edb14451ffa640d24c361deae21..a84b045e81489d314d3abd760a9858dbafb11b5b 100644 (file)
@@ -56,6 +56,10 @@ state changes of the frontend hardware. It is produced using the enum
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 46687c123402e2b9f7dfdb226e5766c2f116f0d3..f2c688bcacb3545652f980b812be5e54006cf9ce 100644 (file)
@@ -43,6 +43,10 @@ sufficient.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 1d5878da2f414caf45d4cac4cdaa98b0cff58687..37a9cef1b6bd86f0a7509aa6e7ee5b94afbae035 100644 (file)
@@ -48,6 +48,10 @@ FE_TUNE_MODE_ONESHOT mode
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 7f97dce9aee6b70acd3170b751def64c5adef017..4f3dcf338254a248a65bd76388ec8deaf97a358a 100644 (file)
@@ -48,17 +48,24 @@ requires read/write access to the device.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
 .. flat-table::
     :header-rows:  0
     :stub-columns: 0
-
+    :widths: 1 16
 
     -  .. row 1
 
        -  ``EINVAL``
 
        -  Maximum supported symbol rate reached.
+
+
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index d0950acbbe640aaab69cae9192f6b3a230346bda..758efa11014cf550dad08baf6ef0c2ca32889535 100644 (file)
@@ -49,6 +49,10 @@ this is done using the DiSEqC ioctls.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 052f316bb4a3d81485abf9fcfff3f7d8012f335c..38d4485290a05b1ecbc908d463ab31a5f02836d7 100644 (file)
@@ -53,6 +53,10 @@ power up the LNBf.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index f3b04b60246c277ac20915982c578d90c8995657..791434bd954804efd8c07682a5d8283ff2d56c6e 100644 (file)
@@ -41,8 +41,10 @@ down automatically.
 Return Value
 ============
 
-The function returns 0 on success, -1 on failure and the ``errno`` is
-set appropriately. Possible error codes:
+On success 0 is returned.
 
-EBADF
-    ``fd`` is not a valid open file descriptor.
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+Generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 690eb375bdc1eeb77c063fa7d3be2fcdb9a466e7..4c25ece73da1f42128ccf0e38367822ca812fcf4 100644 (file)
@@ -79,24 +79,32 @@ On error, -1 is returned, and the ``errno`` variable is set appropriately.
 
 Possible error codes are:
 
-EACCES
-    The caller has no permission to access the device.
 
-EBUSY
-    The the device driver is already in use.
+On success 0 is returned, and :c:type:`ca_slot_info` is filled.
 
-ENXIO
-    No device corresponding to this device special file exists.
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
 
-ENOMEM
-    Not enough kernel memory was available to complete the request.
+.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|
 
-EMFILE
-    The process already has the maximum number of files open.
+.. flat-table::
+    :header-rows:  0
+    :stub-columns: 0
+    :widths: 1 16
 
-ENFILE
-    The limit on the total number of files open on the system has been
-    reached.
+    -  - ``EPERM``
+       -  The caller has no permission to access the device.
 
-ENODEV
-    The device got removed.
+    -  - ``EBUSY``
+       -  The the device driver is already in use.
+
+    -  - ``EMFILE``
+       -  The process already has the maximum number of files open.
+
+    -  - ``ENFILE``
+       -  The limit on the total number of files open on the system has been
+         reached.
+
+
+The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
index 82ce2438213fbbb49520dffe1a9eaaf56decd489..5896bf1b339ba51be39fd2b160066a55603b874c 100644 (file)
@@ -78,6 +78,10 @@ filled with the number of the created interface.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned, and :c:type:`ca_slot_info` is filled.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 1bb8ee0cbced1bf5f75c7be2c5bb9170c7f82fce..3733b34da9db8132ff6d8f8924914d6211150b4c 100644 (file)
@@ -43,6 +43,10 @@ the ``errno`` with ``EINVAL`` error code.
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned, and :c:type:`ca_slot_info` is filled.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.
index 646af23a925ae96839a1c9854091aece17bed1bd..4ebe07a6b79a6eb03705b30396bc2f2a3047c51b 100644 (file)
@@ -39,6 +39,10 @@ The NET_REMOVE_IF ioctl deletes an interface previously created via
 Return Value
 ============
 
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
+On success 0 is returned, and :c:type:`ca_slot_info` is filled.
+
+On error -1 is returned, and the ``errno`` variable is set
+appropriately.
+
+The generic error codes are described at the
 :ref:`Generic Error Codes <gen-errors>` chapter.