linux-toradex.git/Documentation/media/index.rst, branch master

media: docs: get rid of Documentation/media/

2020-04-14T08:36:50+00:00

Now that everything got moved, we can get rid of the
old media directory.

Signed-off-by: Mauro Carvalho Chehab

media: docs: add an uAPI chapter for driver-specific stuff

2020-04-14T08:36:50+00:00

There are some uAPI stuff that are driver-specific. Add them
to the main media uAPI body.

Signed-off-by: Mauro Carvalho Chehab

media: docs: move driver-specific info to driver-api

2020-04-14T08:36:18+00:00

Those documents don't really describe the driver API.

Instead, they contain development-specific information.

Yet, as the main index file describes the content of it as:

	"how specific kernel subsystems work
	 from the point of view of a kernel developer"

It seems to be the better fit.

Signed-off-by: Mauro Carvalho Chehab

media: docs: move user-facing docs to the admin guide

2020-04-14T08:34:58+00:00

Most of the driver-specific documentation is meant to help
users of the media subsystem.

Move them to the admin-guide.

It should be noticed, however, that several of those files
are outdated and will require further work in order to make
them useful again.

Signed-off-by: Mauro Carvalho Chehab

media: docs: kAPI docs: move them to driver-api

2020-04-14T08:32:45+00:00

All those documents describe the media driver API. So, move
them to the right place within the Kernel documentation.

Signed-off-by: Mauro Carvalho Chehab

media: docs: move uAPI book to userspace-api/media

2020-04-14T08:31:49+00:00

Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee3862 ("docs: Create a user-space API guide").

As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.

Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.

Signed-off-by: Mauro Carvalho Chehab

media: index.rst: exclude Indexes section from latex/pdf output

2019-03-30T13:42:35+00:00

With LaTex, the Index at the end will always be present. Having
an extra chapter for it there will just add extra noise to the
document.

Signed-off-by: Mauro Carvalho Chehab

media: docs: brainless mass add SPDX headers to all media files

2018-12-05T15:40:34+00:00

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

media: index.rst: don't write "Contents:" on PDF output

2017-09-05T10:30:41+00:00

Right now, Sphinx unconditionally creates a blank page with
just "Contents:" on it, on PDF output. While this makes sense
for html, it doesn't o PDF, as LaTeX does what's required
automatically.

Fix it.

Signed-off-by: Mauro Carvalho Chehab

media: pulse8-cec.rst: add documentation for the pulse8-cec driver

2017-07-18T15:59:32+00:00

Document the persistent_config module option.

Signed-off-by: Hans Verkuil 
Signed-off-by: Mauro Carvalho Chehab