linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v10 0/4] Add a glossary for the media subsystem
@ 2020-08-27  7:21 Mauro Carvalho Chehab
  2020-08-27  7:21 ` [PATCH v10 1/4] media: open.rst: better document device node naming Mauro Carvalho Chehab
                   ` (3 more replies)
  0 siblings, 4 replies; 11+ messages in thread
From: Mauro Carvalho Chehab @ 2020-08-27  7:21 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet, linux-media,
	Hans Verkuil, Sakari Ailus

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.

On version 10, I addressed the comments from Hans (minor adjustments
and typos). Also, two patches were folded together.

Mauro Carvalho Chehab (4):
  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: open.rst: document mc-centric and video-node-centric

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

-- 
2.26.2



^ permalink raw reply	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2020-08-28 10:50 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-08-27  7:21 [PATCH v10 0/4] Add a glossary for the media subsystem Mauro Carvalho Chehab
2020-08-27  7:21 ` [PATCH v10 1/4] media: open.rst: better document device node naming Mauro Carvalho Chehab
2020-08-27  9:54   ` Sakari Ailus
2020-08-27  7:21 ` [PATCH v10 2/4] media: open.rst: remove the minor number range Mauro Carvalho Chehab
2020-08-27  7:21 ` [PATCH v10 3/4] media: docs: add glossary.rst with common terms used at V4L2 spec Mauro Carvalho Chehab
2020-08-27 11:08   ` Sakari Ailus
2020-08-27 12:48     ` Mauro Carvalho Chehab
2020-08-28  9:11     ` Mauro Carvalho Chehab
2020-08-28 10:50       ` Sakari Ailus
2020-08-27  7:21 ` [PATCH v10 4/4] media: open.rst: document mc-centric and video-node-centric Mauro Carvalho Chehab
2020-08-27 12:23   ` Sakari Ailus

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).