Commit Graph

11 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab 33fc918ab8 media: admin-guide: split driver-specific indexes to new files
In order to better organize the main admin-guide index,
place the driver-specific indexes on separate files.

This ensures a more consistent numbering at the main index.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:29:45 +02:00
Mauro Carvalho Chehab a79a0e71ae media: admin-guide: reorganize the guide
Separate the generic documentation from the driver-specific
parts, and use a better title for the documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:29:23 +02:00
Mauro Carvalho Chehab d3cb083207 media: admin-guide: split DVB cards.rst
The DVB cards.rst file is old and outdated. It also contains
data that are contained on other cardlists. Remove the
duplicated information and split frontends and PCI cards on
separate files.

As all USB cards already have their own card lists, just drop
the old USB data there.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:26:12 +02:00
Mauro Carvalho Chehab 2aca74c8b1 media: admin-guide: add a generic building guide
Several of the existing documents under the media admin-guide
contain build procedures.

Add an specific chapter describing it. This document was
partially inspired on the modifications I made to the bttv.rst
file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 07:48:36 +02:00
Mauro Carvalho Chehab d9d43617bb media: admin-guide: Add an introduction chapter
The media's admin guide is currently just a group of
not-connected docs.

Add an introduction chapter for it to start making sense
to a random reader.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 07:47:53 +02:00
Mauro Carvalho Chehab 63735af86d media: docs: add cros-references to the other media guides
In order to make easier for people to navigate between the
three media guides, add cross-references between them

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15 15:51:24 +02:00
Mauro Carvalho Chehab cc5d250e5a media: docs: move copyrights to the end and update them
The copyright info is not the most valuable information
there. Move them to the end.

While here, change the copyright to cover up to this
year (2020).

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15 15:51:24 +02:00
Mauro Carvalho Chehab 1c9eeba232 media: docs: get rid of obsoleted udev documentation
This file is very old, and doesn't match the current udev
behavior.

I wanted to preserve it, because we'll need some udev
description some day about how to keep names unique,
but there's nothing here to help with that...

So, be it: let's just discard this document, as it doesn't
provide anything useful anymore.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15 15:51:23 +02:00
Mauro Carvalho Chehab 03693a5a23 media: docs: intro.rst actually contain DVB references
This document doesn't describe the DVB subsystem. Instead, it
just contain references to some places.

Better name it and improve its contents.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15 15:51:23 +02:00
Mauro Carvalho Chehab c4b89166d2 media: docs: split avermedia.rst contents on two files
Part of this document has nothing to do with the Avermedia
driver. It is generic to the entire subsystem. So, split it
on a separate file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15 15:51:23 +02:00
Mauro Carvalho Chehab 32e2eae23f media: docs: move user-facing docs to the admin guide
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 <mchehab+huawei@kernel.org>
2020-04-14 10:34:58 +02:00