leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1473c75e9a
linux/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst

50 lines
890 B
ReStructuredText
Raw Normal View History

doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
.. -*- coding: utf-8; mode: rst -*-
.. _FE_DISEQC_SEND_MASTER_CMD:
*******************************
ioctl FE_DISEQC_SEND_MASTER_CMD
*******************************
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:14:35 +00:00
Name
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:58:48 +00:00
====
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:58:48 +00:00
FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:14:35 +00:00
Synopsis
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
========
[media] docs-rst: Convert DVB uAPI to use C function references Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-19 19:56:15 +00:00
.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp )
:name: FE_DISEQC_SEND_MASTER_CMD
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: reformat all syscall pages The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 10:58:48 +00:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:14:35 +00:00
Arguments
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
=========
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``argp``
pointer to struct
[media] docs-rst: convert uAPI structs to C domain instead of declaring the uAPI structs using usual refs, e. g.: .. _foo-struct: Use the C domain way: .. c:type:: foo_struct This way, the kAPI documentation can use cross-references to point to the uAPI symbols. That solves about ~100 undefined warnings like: WARNING: c:type reference target not found: foo_struct Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-29 20:37:59 +00:00
:c:type:`dvb_diseqc_master_cmd`
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
doc-rst: linux_tv: don't use uppercases for syscall sections On the syscall conversions, we used uppercase for the sections, but this is too bold. So, convert them to Camel Case, as it looks visually better. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:14:35 +00:00
Description
doc-rst: linux_tv DocBook to reST migration (docs-next) This is the restructuredText (reST) migration of the ``media`` DocBook-XML set from the linux_tv project. Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-06-30 13:18:56 +00:00
===========
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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-01 16:21:49 +00:00
Sends the DiSEqC command pointed by :c:type:`dvb_diseqc_master_cmd`
to the antenna subsystem.
doc-rst: linux_tv: use :cpp:function:: on all syscalls Now that we have one syscall per page, using :cpp:function:: cleans up almost all warnings, with is a great thing. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:22:59 +00:00
Return Value
============
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-01 16:15:43 +00:00
On success 0 is returned.
On error -1 is returned, and the ``errno`` variable is set
appropriately.
Generic error codes are described at the
doc-rst: linux_tv: use :cpp:function:: on all syscalls Now that we have one syscall per page, using :cpp:function:: cleans up almost all warnings, with is a great thing. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-05 18:22:59 +00:00
:ref:`Generic Error Codes <gen-errors>` chapter.
Reference in New Issue Copy Permalink