leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

media: admin-guide: avoid using ReST :doc:foo markup

Browse Source 
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2021-06-05 14:40:12 +02:00
parent a169c44e58
commit 6ef43d273e
3 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/admin-guide/media/bt8xx.rst
View File

@ -15,11 +15,12 @@ Authors:
General information General information
------------------- -------------------
This class of cards has a bt878a as the PCI interface, and require the bttv driver This class of cards has a bt878a as the PCI interface, and require the bttv
for accessing the i2c bus and the gpio pins of the bt8xx chipset. driver for accessing the i2c bus and the gpio pins of the bt8xx chipset.
Please see :doc:`bttv-cardlist` for a complete list of Cards based on the Please see Documentation/admin-guide/media/bttv-cardlist.rst for a complete
Conexant Bt8xx PCI bridge supported by the Linux Kernel. list of Cards based on the Conexant Bt8xx PCI bridge supported by the
Linux Kernel.
In order to be able to compile the kernel, some config options should be In order to be able to compile the kernel, some config options should be
enabled:: enabled::
@ -80,7 +81,7 @@ for dvb-bt8xx drivers by passing modprobe parameters may be necessary.
Running TwinHan and Clones Running TwinHan and Clones
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
As shown at :doc:`bttv-cardlist`, TwinHan and As shown at Documentation/admin-guide/media/bttv-cardlist.rst, TwinHan and
clones use ``card=113`` modprobe parameter. So, in order to properly clones use ``card=113`` modprobe parameter. So, in order to properly
detect it for devices without EEPROM, you should use:: detect it for devices without EEPROM, you should use::
@ -105,12 +106,12 @@ The autodetected values are determined by the cards' "response string".
In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI]. In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI].
For bug reports please send in a complete log with verbose=4 activated. For bug reports please send in a complete log with verbose=4 activated.
Please also see :doc:`ci`. Please also see Documentation/admin-guide/media/ci.rst.
Running multiple cards Running multiple cards
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
See :doc:`bttv-cardlist` for a complete list of See Documentation/admin-guide/media/bttv-cardlist.rst for a complete list of
Card ID. Some examples: Card ID. Some examples:
=========================== === =========================== ===

21
Documentation/admin-guide/media/bttv.rst
View File

@ -24,7 +24,8 @@ If your board has digital TV, you'll also need::
./scripts/config -m DVB_BT8XX ./scripts/config -m DVB_BT8XX
In this case, please see :doc:`bt8xx` for additional notes. In this case, please see Documentation/admin-guide/media/bt8xx.rst
for additional notes.
Make bttv work with your card Make bttv work with your card
----------------------------- -----------------------------
@ -39,7 +40,7 @@ If it doesn't bttv likely could not autodetect your card and needs some
insmod options. The most important insmod option for bttv is "card=n" insmod options. The most important insmod option for bttv is "card=n"
to select the correct card type. If you get video but no sound you've to select the correct card type. If you get video but no sound you've
very likely specified the wrong (or no) card type. A list of supported very likely specified the wrong (or no) card type. A list of supported
cards is in :doc:`bttv-cardlist`. cards is in Documentation/admin-guide/media/bttv-cardlist.rst.
If bttv takes very long to load (happens sometimes with the cheap If bttv takes very long to load (happens sometimes with the cheap
cards which have no tuner), try adding this to your modules configuration cards which have no tuner), try adding this to your modules configuration
@ -57,8 +58,8 @@ directory should be enough for it to be autoload during the driver's
probing mode (e. g. when the Kernel boots or when the driver is probing mode (e. g. when the Kernel boots or when the driver is
manually loaded via ``modprobe`` command). manually loaded via ``modprobe`` command).
If your card isn't listed in :doc:`bttv-cardlist` or if you have If your card isn't listed in Documentation/admin-guide/media/bttv-cardlist.rst
trouble making audio work, please read :ref:`still_doesnt_work`. or if you have trouble making audio work, please read :ref:`still_doesnt_work`.
Autodetecting cards Autodetecting cards
@ -77,8 +78,8 @@ the Subsystem ID in the second line, looks like this:
only bt878-based cards can have a subsystem ID (which does not mean only bt878-based cards can have a subsystem ID (which does not mean
that every card really has one). bt848 cards can't have a Subsystem that every card really has one). bt848 cards can't have a Subsystem
ID and therefore can't be autodetected. There is a list with the ID's ID and therefore can't be autodetected. There is a list with the ID's
at :doc:`bttv-cardlist` (in case you are interested or want to mail at Documentation/admin-guide/media/bttv-cardlist.rst
patches with updates). (in case you are interested or want to mail patches with updates).
.. _still_doesnt_work: .. _still_doesnt_work:
@ -259,15 +260,15 @@ bug. It is very helpful if you can tell where exactly it broke
With a hard freeze you probably doesn't find anything in the logfiles. With a hard freeze you probably doesn't find anything in the logfiles.
The only way to capture any kernel messages is to hook up a serial The only way to capture any kernel messages is to hook up a serial
console and let some terminal application log the messages. /me uses console and let some terminal application log the messages. /me uses
screen. See :doc:`/admin-guide/serial-console` for details on setting screen. See Documentation/admin-guide/serial-console.rst for details on
up a serial console. setting up a serial console.
Read :doc:`/admin-guide/bug-hunting` to learn how to get any useful Read Documentation/admin-guide/bug-hunting.rst to learn how to get any useful
information out of a register+stack dump printed by the kernel on information out of a register+stack dump printed by the kernel on
protection faults (so-called "kernel oops"). protection faults (so-called "kernel oops").
If you run into some kind of deadlock, you can try to dump a call trace If you run into some kind of deadlock, you can try to dump a call trace
for each process using sysrq-t (see :doc:`/admin-guide/sysrq`). for each process using sysrq-t (see Documentation/admin-guide/sysrq.rst).
This way it is possible to figure where *exactly* some process in "D" This way it is possible to figure where *exactly* some process in "D"
state is stuck. state is stuck.

3
Documentation/admin-guide/media/saa7134.rst
View File

@ -50,7 +50,8 @@ To build and install, you should run::
Once the new Kernel is booted, saa7134 driver should be loaded automatically. Once the new Kernel is booted, saa7134 driver should be loaded automatically.
Depending on the card you might have to pass ``card=<nr>`` as insmod option. Depending on the card you might have to pass ``card=<nr>`` as insmod option.
If so, please check :doc:`saa7134-cardlist` for valid choices. If so, please check Documentation/admin-guide/media/saa7134-cardlist.rst
for valid choices.
Once you have your card type number, you can pass a modules configuration Once you have your card type number, you can pass a modules configuration
via a file (usually, it is either ``/etc/modules.conf`` or some file at via a file (usually, it is either ``/etc/modules.conf`` or some file at