linux/Documentation/media/uapi/dvb/frontend_f_close.rst
Mauro Carvalho Chehab 9a721b9b4b media: dvb uAPI docs: adjust return value ioctl descriptions
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>
2017-09-05 06:16:37 -04:00

51 lines
797 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _frontend_f_close:
********************
DVB frontend close()
********************
Name
====
fe-close - Close a frontend device
Synopsis
========
.. code-block:: c
#include <unistd.h>
.. c:function:: int close( int fd )
:name: dvb-fe-close
Arguments
=========
``fd``
File descriptor returned by :c:func:`open() <dvb-fe-open>`.
Description
===========
This system call closes a previously opened front-end device. After
closing a front-end device, its corresponding hardware might be powered
down automatically.
Return Value
============
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.