Commit Graph

26 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
adf48e3f1f media: Documentation: fix several typos
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>
2019-03-01 09:54:06 -05:00
Mauro Carvalho Chehab
f2ac8ce823 media: docs: brainless mass add SPDX headers to all media files
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-05 10:40:34 -05:00
Mauro Carvalho Chehab
18e6830a63 media: remove text encoding from rst files
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>
2018-12-05 10:37:18 -05:00
Mauro Carvalho Chehab
e61edeb155 media: docs: add documentation for frontend attach info
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-11-30 04:19:04 -05:00
Tom Saeger
a405ed85ca Documentation: fix media related doc refs
Make media doc refs valid.

Signed-off-by: Tom Saeger <tom.saeger@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-10-12 11:15:06 -06:00
Mauro Carvalho Chehab
1b41d94bb5 media: docs: don't show ToC for each part on PDF output
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-05 06:27:50 -04:00
Mauro Carvalho Chehab
833ff5e7fe media: ca.h: get rid of CA_SET_PID
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-09-05 06:06:56 -04:00
Masahiro Yamada
9332ef9dbd scripts/spelling.txt: add "an user" pattern and fix typo instances
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>
2017-02-27 18:43:46 -08:00
Sanjeev
7d56f0facd Doc: Correct typo, "Introdution" => "Introduction"
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-12-01 10:44:08 -07:00
Mauro Carvalho Chehab
d888f8d7d8 [media] doc-rst: Fix license for the media books
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-23 08:03:24 -03:00
Mauro Carvalho Chehab
ef88f10eb8 [media] doc-rst: backward compatibility with older Sphinx versions
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-19 12:35:08 -03:00
Mauro Carvalho Chehab
e1813eda8e [media] doc-rst: better name the media books
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-18 15:01:20 -03:00
Mauro Carvalho Chehab
70e8d3e999 [media] doc-rst: convert udev chapter to rst
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 14:02:54 -03:00
Mauro Carvalho Chehab
d91b11bfdb [media] doc-rst: convert ttusb-dev to rst
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 14:02:53 -03:00
Mauro Carvalho Chehab
63dd837ec0 [media] doc-rst: Convert technisat document to ReST
This document need some changes to be properly parsed by
Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 14:02:53 -03:00
Mauro Carvalho Chehab
6e31b7c117 [media] doc-rst: add opera-firmware.rst to DVB docs
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 14:02:52 -03:00
Mauro Carvalho Chehab
683ac0ea8e [media] doc-rst: Convert lmedm04 to rst format
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 14:02:51 -03:00
Mauro Carvalho Chehab
c0be9f7952 [media] doc-rst: convert DVB FAQ to ReST format
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 14:02:51 -03:00
Mauro Carvalho Chehab
9bb2c55a79 [media] doc-rst: Convert dvb-usb to ReST format
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 14:02:50 -03:00
Mauro Carvalho Chehab
dee74db3d1 [media] doc-rst: Convert contributors list to ReST
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 14:02:49 -03:00
Mauro Carvalho Chehab
c1eaa6c478 [media] doc-rst: Convert ci.txt to a rst file
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 14:02:49 -03:00
Mauro Carvalho Chehab
986fd9a9ed [media] doc-rst: convert cards to rst format
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 14:02:48 -03:00
Mauro Carvalho Chehab
d61da478b3 [media] doc-rst: convert bt8xx doc to rst
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 14:02:47 -03:00
Mauro Carvalho Chehab
d3686003e0 [media] doc-rst: Fix format of avermedia.rst
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 14:02:47 -03:00
Mauro Carvalho Chehab
f8cd359895 [media] doc-rst: move DVB introduction to a separate file
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 14:02:46 -03:00
Mauro Carvalho Chehab
fcbf5ca0b8 [media] doc-rst: move DVB avulse docs to Documentation/media
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>
2016-07-17 14:02:45 -03:00