diff options
author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-09-24 09:15:55 +0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-15 08:49:39 +0300 |
commit | 01fae02d8d67116f5b9bc36a8571356aa76f02f0 (patch) | |
tree | f0cc6ef1d294deb7820c78d43dee5a9bb024b144 /Documentation/userspace-api/media/cec/cec-func-close.rst | |
parent | c51d9b046f907b7c96760700c6bdda6fbe38de60 (diff) | |
download | linux-01fae02d8d67116f5b9bc36a8571356aa76f02f0.tar.xz |
media: docs: make CEC documents compatible with Sphinx 3.1+
Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Diffstat (limited to 'Documentation/userspace-api/media/cec/cec-func-close.rst')
-rw-r--r-- | Documentation/userspace-api/media/cec/cec-func-close.rst | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/Documentation/userspace-api/media/cec/cec-func-close.rst b/Documentation/userspace-api/media/cec/cec-func-close.rst index 33c563f414a8..409e70a5f80f 100644 --- a/Documentation/userspace-api/media/cec/cec-func-close.rst +++ b/Documentation/userspace-api/media/cec/cec-func-close.rst @@ -1,4 +1,5 @@ .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. c:namespace:: CEC .. _cec-func-close: @@ -11,7 +12,6 @@ Name cec-close - Close a cec device - Synopsis ======== @@ -19,16 +19,13 @@ Synopsis #include <unistd.h> - .. c:function:: int close( int fd ) - :name: cec-close Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() <cec-open>`. - + File descriptor returned by :c:func:`open()`. Description =========== @@ -36,11 +33,10 @@ Description Closes the cec device. Resources associated with the file descriptor are freed. The device configuration remain unchanged. - Return Value ============ -:c:func:`close() <cec-close>` returns 0 on success. On error, -1 is returned, and +:c:func:`close()` returns 0 on success. On error, -1 is returned, and ``errno`` is set appropriately. Possible error codes are: ``EBADF`` |