mbox

[v9,0/5] Add a glossary for the media subsystem

Message ID cover.1588943181.git.mchehab+huawei@kernel.org (mailing list archive)
Headers

Message

Mauro Carvalho Chehab May 8, 2020, 1:10 p.m. UTC 
  There are too many technical terms at the media subsystem, and sometimes
the same thing is refered differently at the documentation and on the ML
and IRC discussions.

Let's add a glossary to the uAPI documentation, in order to start using
a common vocabulary at the subsystem's discussion and to let things
clearer for people trying to understand the subsystem.

I'm pretty sure that this document doesn't cover everything, but it can
(and should) be improved overtime.

At version 9 (and hopefully the final version), I simplified how things were
described, avoiding to define things that may not be needed for this
initial version, in order to try reach a consensus when merging.

If something is not ok, or other terms need to be added, feel free to
submit other patches addressing it.

Mauro Carvalho Chehab (5):
  media: open.rst: better document device node naming
  media: open.rst: remove the minor number range
  media: docs: add glossary.rst with common terms used at V4L2 spec
  media: glossary.rst: add terms for MC-centric video-node-centric
  media: open.rst: document mc-centric and video-node-centric

 .../userspace-api/media/glossary.rst          | 214 ++++++++++++++++++
 Documentation/userspace-api/media/index.rst   |   3 +
 .../userspace-api/media/v4l/open.rst          | 106 +++++++--
 3 files changed, 309 insertions(+), 14 deletions(-)
 create mode 100644 Documentation/userspace-api/media/glossary.rst