summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst
AgeCommit message (Collapse)Author
2017-09-05media: dvb uAPI docs: adjust return value ioctl descriptionsMauro Carvalho Chehab
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-05media: dvb frontend docs: use kernel-doc documentationMauro Carvalho Chehab
Now that frontend.h contains most documentation for the frontend, remove the duplicated information from Documentation/ and use the kernel-doc auto-generated one instead. That should simplify maintainership of DVB frontend uAPI, as most of the documentation will stick with the header file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-06-23[media] dvb uapi docs: enums are passed by value, not referenceMauro Carvalho Chehab
Since 2015, the documentation for FE_DISEQC_SEND_BURST, FE_SET_TONE and FE_SET_VOLTAGE are incorrectly saying that the enums are passed by reference. They aren't: they're passed by value. Fix the documentation to reflect reality. Fixes: 81959d996a3b ("[media] DocBook: better document FE_DISEQC_SEND_BURST ioctl") Fixes: d6b6d346e560 ("[media] DocBook: better document FE_SET_VOLTAGE ioctl") Fixes: 6dc59e7a195f ("[media] DocBook: better document FE_SET_TONE ioctl") Reported-by: Thierry Lelegard <thierry.lelegard@free.fr> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] docs-rst exceptions: use C domain references for DVB headersMauro Carvalho Chehab
Now that we moved away from the :ref: type of references, we need to update the exceptions lists. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22[media] docs-rst: Convert DVB uAPI to use C function referencesMauro Carvalho Chehab
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-22[media] docs-next: stop abusing on the cpp domainMauro Carvalho Chehab
Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>