linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-media@vger.kernel.org,
	Hans Verkuil <hans.verkuil@cisco.com>,
	Sakari Ailus <sakari.ailus@linux.intel.com>
Subject: [PATCH v10 0/4] Add a glossary for the media subsystem
Date: Thu, 27 Aug 2020 09:21:44 +0200	[thread overview]
Message-ID: <cover.1598512802.git.mchehab+huawei@kernel.org> (raw)

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



             reply	other threads:[~2020-08-27  7:22 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-27  7:21 Mauro Carvalho Chehab [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1598512802.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=hans.verkuil@cisco.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).