summaryrefslogtreecommitdiff
path: root/Documentation/media/dvb-drivers
AgeCommit message (Collapse)AuthorFilesLines
2019-03-01media: Documentation: fix several typosMauro Carvalho Chehab1-1/+1
Use codespell to fix lots of typos over frontends. Manually verified to avoid false-positives. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Philipp Zabel <p.zabel@pengutronix.de> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-12-05media: docs: brainless mass add SPDX headers to all media filesMauro Carvalho Chehab15-0/+30
All Documentation files outside the uAPI are all licensed with, at least, GPL 2.0. So, mark them as such. The ondes at media/uapi are at least GFDL 1.1+. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2018-12-05media: remove text encoding from rst filesMauro Carvalho Chehab1-2/+0
This is not needed there. Also, the same UTF-8 encoding should be used on all documents. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2017-11-30media: docs: add documentation for frontend attach infoMauro Carvalho Chehab2-0/+31
Add to the media book the attachment kAPI for the DVB frontend drivers that have already some kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-10-12Documentation: fix media related doc refsTom Saeger1-4/+4
Make media doc refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-09-05media: docs: don't show ToC for each part on PDF outputMauro Carvalho Chehab1-1/+3
The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05media: ca.h: get rid of CA_SET_PIDMauro Carvalho Chehab1-1/+0
This ioctl seems to be some attempt to support a feature at the bt8xx dst_ca driver. Yet, as said there, it "needs more work". Right now, the code there is just a boilerplate. At the end of the day, no driver uses this ioctl, nor it is documented anywhere (except for "needs more work"). So, get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-02-28scripts/spelling.txt: add "an user" pattern and fix typo instancesMasahiro Yamada1-1/+1
Fix typos and add the following to the scripts/spelling.txt: an user||a user an userspace||a userspace I also added "userspace" to the list since it is a common word in Linux. I found some instances for "an userfaultfd", but I did not add it to the list. I felt it is endless to find words that start with "user" such as "userland" etc., so must draw a line somewhere. Link: http://lkml.kernel.org/r/1481573103-11329-4-git-send-email-yamada.masahiro@socionext.com Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2016-12-01Doc: Correct typo, "Introdution" => "Introduction"Sanjeev1-2/+2
This corrects a set of spelling mistakes, probably from an automated conversion. Signed-off-by: Sanjeev Gupta <ghane0@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-07-23[media] doc-rst: Fix license for the media booksMauro Carvalho Chehab1-5/+10
The kAPI, v4l-drivers and dvb-drivers never used the GNU FDL license. The addition of such license header were just due to copy-and-paste. So, let's fix it. As the media_kapi were part of device-drivers.tmp, it is under GPL v2+. The other two books is an agregation of files without any license explicitly specified. So, they're all bound to the Kernel's COPYING license. So, they're GPL v2 only. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-19[media] doc-rst: backward compatibility with older Sphinx versionsMauro Carvalho Chehab1-2/+3
Sphinx is really evil when an older version finds an extra attribute for the :toctree: tag: it simply ignores everything and produce documents without any chapter inside! As we're now using tags available only on Sphinx 1.4.x, we need to use some creative ways to add a title before the table of contents. Do that by using a css class. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: better name the media booksMauro Carvalho Chehab1-3/+6
The titles at the media books were misleading, and some books were not numbered. Rename the kAPI book to better reflect its contents, be more consistent on the initial rst file for each book and better name them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: convert udev chapter to rstMauro Carvalho Chehab2-8/+24
This chapter is outdated. I almost removed, but, as we're lacking documentation about how to make DVB devices persistent, I opted, instead, to keep it, and add a note about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: convert ttusb-dev to rstMauro Carvalho Chehab2-24/+23
There are some things that needed to be done to convert it to ReST. Also, there are some obsolete info there related to Kernels 2.4 and 2.6. Update them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Convert technisat document to ReSTMauro Carvalho Chehab2-52/+73
This document need some changes to be properly parsed by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: add opera-firmware.rst to DVB docsMauro Carvalho Chehab2-5/+10
This file is shown OK with ReST. Yet, as we changed the place where the get_dvb_firmware script is, we need to update it. While here, move the author's name to the beginning of the file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Convert lmedm04 to rst formatMauro Carvalho Chehab2-24/+49
This file was missing a name for the index, and weren't using any markup language. Make it looks better and convert to ReST. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: convert DVB FAQ to ReST formatMauro Carvalho Chehab2-5/+14
Convert the DVB FAQ to ReST format and add a note that this is outdated. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Convert dvb-usb to ReST formatMauro Carvalho Chehab2-97/+221
This file is not on any markup language. Convert it to ReST format. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Convert contributors list to ReSTMauro Carvalho Chehab2-68/+102
The contributors list needs some adjustments to be properly formatted. Also, this list has not been updated for a while. So, add a notice about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Convert ci.txt to a rst fileMauro Carvalho Chehab2-84/+103
The old ci.txt file had a very peculiar format, with doesn't match any markup language I know. Change it to be on ReST format, for it to be parsed by Sphinx. Also, as this is an old document, add a note about it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: convert cards to rst formatMauro Carvalho Chehab2-25/+47
This file is using a markup-like language, but it is not quite ReST. Convert it, and add a note pointing to the Wiki page with the known supported hardware devices. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: convert bt8xx doc to rstMauro Carvalho Chehab2-48/+73
This document almost follows a markup language, but it is not ReST. Fix it to be handled by Sphinx. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: Fix format of avermedia.rstMauro Carvalho Chehab2-279/+246
This file is almost at the ReST format, but some things need to be fixed for it to be parsed. Also, the documentation there is old. So, add a notice about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: move DVB introduction to a separate fileMauro Carvalho Chehab2-55/+35
Instead of keeping the introduction together with the index, move it to a separate file, and add it via toctree at the index. The information there are outdated, so update it to point to the right links. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: move DVB avulse docs to Documentation/mediaMauro Carvalho Chehab13-0/+1560
There are several documentation stuff under Documentation/dvb. Move them to Documentation/media/dvb-drivers and rename them to rst, as they'll soon be converted to rst files. No changes at the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>