kernel/linux.git/Documentation/userspace-api/media/cec, branch v6.6.131

media: admin-guide: cec.rst

2022-11-25T07:39:21+00:00

Document administration details about CEC devices. This was formerly documented in a cec-status.txt I kept on my website, but this really belongs here as an admin guide. Updated the original cec-status.txt, and converted it to .rst. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: cec-ioc-receive.rst: clarify sequence and status fields

2021-11-15T08:12:03+00:00

Improve the documentation for CEC_RECEIVE/TRANSMIT w.r.t. the sequence and tx/rx_status fields. Also remove a duplicate tx_status description. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: cec/core: clarify rx-arb-lost usage message

2021-04-06T14:08:38+00:00

The rx-arb-lost error injection command only works with set to 'any'. Explicitly say so in the usage message. Also use [] to indicate that the argument is optional. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: docs: uAPI: fix table output in LaTeX/PDF format

2021-03-11T10:59:40+00:00

There are lots of tables that are not properly displayed in LaTeX/PDF. Fix the tablecolumns, add longtable where needed and LaTeX formatting macros, in order to address such issues. Signed-off-by: Mauro Carvalho Chehab

media: cec-core.rst/cec-ioc-g-mode.rst: fix typos in monitor-all description

2020-11-16T09:31:09+00:00

cec-core.rst was missing 'are', and cec-ioc-g-mode.rst was missing a comma. In both cases this made the description of the Monitor All functionality hard to read. Signed-off-by: Hans Verkuil Signed-off-by: Mauro Carvalho Chehab

media: docs: make CEC documents compatible with Sphinx 3.1+

2020-10-15T05:49:39+00:00

Sphinx 3.x broke support for the cdomain.py extension, as the c domain code was rewritten. Due to that, the c tags need to be re-written, in order to use the new c domain notation. Signed-off-by: Mauro Carvalho Chehab

media: docs: use the new SPDX header for GFDL-1.1 on *.rst files

2020-09-01T12:13:30+00:00

SPDX v3.10 gained support for GFDL-1.1 with no invariant sections: https://spdx.org/licenses/GFDL-1.1-no-invariants-or-later.html So, remove the license text, replacing them by this new SPDX license. Signed-off-by: Mauro Carvalho Chehab

media: cec-ioc-adap-g-caps.rst: document available_log_addrs

2020-06-23T13:10:51+00:00

The CEC_ADAP_G_CAPS documentation of the cec_caps struct was missing the available_log_addrs field. Add this. Signed-off-by: Hans Verkuil 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