linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Hans Verkuil <hverkuil@xs4all.nl>
Subject: [PATCH 0/8] Document more parts of V4L2 kAPI part 1
Date: Fri, 22 Sep 2017 18:46:58 -0300	[thread overview]
Message-ID: <cover.1506116720.git.mchehab@s-opensource.com> (raw)

There are several  functions and structs at V4L2 that aren't documented.

This is an effort to document some of those. My plan is to work on other
similar patch series until we have the kAPI in sync with the current
implementation.

Mauro Carvalho Chehab (8):
  media: tuner-types: add kernel-doc markups for struct tunertype
  media: v4l2-common: get rid of v4l2_routing dead struct
  media: v4l2-common: get rid of struct v4l2_discrete_probe
  media: v4l2-common.h: document ancillary functions
  media: v4l2-device.h: document ancillary macros
  media: v4l2-dv-timings.h: convert comment into kernel-doc markup
  media: v4l2-event.rst: improve events description
  media: v4l2-ioctl.h: convert debug macros into enum and document

 Documentation/media/kapi/v4l2-event.rst      |  64 +++++--
 drivers/media/platform/vivid/vivid-vid-cap.c |   9 +-
 drivers/media/v4l2-core/v4l2-common.c        |  27 +--
 include/media/tuner-types.h                  |  15 ++
 include/media/v4l2-common.h                  | 130 ++++++++++++---
 include/media/v4l2-device.h                  | 238 +++++++++++++++++++++++----
 include/media/v4l2-dv-timings.h              |  14 +-
 include/media/v4l2-event.h                   |  34 ----
 include/media/v4l2-ioctl.h                   |  33 ++--
 9 files changed, 411 insertions(+), 153 deletions(-)

-- 
2.13.5

             reply	other threads:[~2017-09-22 21:47 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-22 21:46 Mauro Carvalho Chehab [this message]
2017-09-22 21:46 ` [PATCH 1/8] media: tuner-types: add kernel-doc markups for struct tunertype Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 2/8] media: v4l2-common: get rid of v4l2_routing dead struct Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 3/8] media: v4l2-common: get rid of struct v4l2_discrete_probe Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 4/8] media: v4l2-common.h: document ancillary functions Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 5/8] media: v4l2-device.h: document ancillary macros Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 6/8] media: v4l2-dv-timings.h: convert comment into kernel-doc markup Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 7/8] media: v4l2-event.rst: improve events description Mauro Carvalho Chehab
2017-09-22 21:47 ` [PATCH 8/8] media: v4l2-ioctl.h: convert debug macros into enum and document Mauro Carvalho Chehab

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.1506116720.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=hverkuil@xs4all.nl \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /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).