From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: "Mauro Carvalho Chehab" <mchehab@s-opensource.com>,
"Mauro Carvalho Chehab" <mchehab@infradead.org>,
"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Laurent Pinchart" <laurent.pinchart+renesas@ideasonboard.com>,
"Kyungmin Park" <kyungmin.park@samsung.com>,
"Mats Randgaard" <matrandg@cisco.com>,
"Janusz Krzysztofik" <jmkrzyszt@gmail.com>,
"Hans Verkuil" <hverkuil@xs4all.nl>,
"Robert Jarzmik" <robert.jarzmik@free.fr>,
"Laurent Pinchart" <laurent.pinchart@ideasonboard.com>,
"Geliang Tang" <geliangtang@gmail.com>,
"Benoit Parrot" <bparrot@ti.com>, "Arnd Bergmann" <arnd@arndb.de>,
"Devin Heitmueller" <dheitmueller@kernellabs.com>,
"Marek Szyprowski" <m.szyprowski@samsung.com>,
"Arvind Yadav" <arvind.yadav.cs@gmail.com>,
"Philipp Zabel" <p.zabel@pengutronix.de>,
"Santosh Kumar Singh" <kumar.san1093@gmail.com>,
"Bhumika Goyal" <bhumirks@gmail.com>,
"Andrey Utkin" <andrey_utkin@fastmail.com>,
"Julia Lawall" <Julia.Lawall@lip6.fr>,
"Elena Reshetova" <elena.reshetova@intel.com>,
"Hans Verkuil" <hans.verkuil@cisco.com>,
"Sakari Ailus" <sakari.ailus@linux.intel.com>,
"Petr Cvek" <petr.cvek@tul.cz>,
"Lars-Peter Clausen" <lars@metafoo.de>,
"Pawel Osciak" <pawel@osciak.com>, "Pavel Machek" <pavel@ucw.cz>,
"Ricardo Ribalda Delgado" <ricardo.ribalda@gmail.com>,
"Kees Cook" <keescook@chromium.org>,
"Helen Koike" <helen.koike@collabora.com>,
"Niklas Söderlund" <niklas.soderlund@ragnatech.se>,
"Christophe JAILLET" <christophe.jaillet@wanadoo.fr>,
"Rob Herring" <robh@kernel.org>,
"Gustavo A. R. Silva" <garsilva@embeddedor.com>,
"Sebastian Reichel" <sre@kernel.org>,
linux-renesas-soc@vger.kernel.org,
"Guennadi Liakhovetski" <g.liakhovetski@gmx.de>,
"Mike Isely" <isely@pobox.com>,
"Hans Liljestrand" <ishkamiel@gmail.com>
Subject: [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2
Date: Mon, 9 Oct 2017 07:19:06 -0300 [thread overview]
Message-ID: <cover.1507544011.git.mchehab@s-opensource.com> (raw)
That's the second part of my V4L2 kAPI documentation improvements.
It is meant to reduce the gap between the kAPI media headers
and documentation, at least with regards to kernel-doc markups.
We should likely write more things at the ReST files under Documentation/
to better describe some of those APIs (VB2 being likely the first candidate),
but at least let's be sure that all V4L2 bits have kernel-doc markups.
Mauro Carvalho Chehab (24):
media: v4l2-dev.h: add kernel-doc to two macros
media: v4l2-flash-led-class.h: add kernel-doc to two ancillary funcs
media: v4l2-mediabus: use BIT() macro for flags
media: v4l2-mediabus: convert flags to enums and document them
media: v4l2-dev: convert VFL_TYPE_* into an enum
media: i2c-addr.h: get rid of now unused defines
media: get rid of i2c-addr.h
media: v4l2-dev: document VFL_DIR_* direction defines
media: v4l2-dev: document video_device flags
media: v4l2-subdev: use kernel-doc markups to document subdev flags
media: v4l2-subdev: create cross-references for ioctls
media: v4l2-subdev: fix description of tuner.s_radio ops
media: v4l2-subdev: better document IO pin configuration flags
media: v4l2-subdev: convert frame description to enum
media: v4l2-subdev: get rid of __V4L2_SUBDEV_MK_GET_TRY() macro
media: v4l2-subdev: document remaining undocumented functions
media: v4l2-subdev: fix a typo
media: vb2-core: use bitops for bits
media: vb2-core: Improve kernel-doc markups
media: vb2-core: document remaining functions
media: vb2-core: fix descriptions for VB2-only functions
media: vb2: add cross references at memops and v4l2 kernel-doc markups
media: v4l2-tpg*.h: move headers to include/media/tpg and merge them
media: v4l2-tpg.h: rename color structs
Documentation/media/kapi/v4l2-dev.rst | 17 +-
drivers/media/common/v4l2-tpg/v4l2-tpg-colors.c | 8 +-
drivers/media/common/v4l2-tpg/v4l2-tpg-core.c | 2 +-
drivers/media/i2c/adv7180.c | 10 +-
drivers/media/i2c/ml86v7667.c | 5 +-
drivers/media/i2c/mt9m111.c | 8 +-
drivers/media/i2c/ov6650.c | 19 +-
drivers/media/i2c/soc_camera/imx074.c | 6 +-
drivers/media/i2c/soc_camera/mt9m001.c | 10 +-
drivers/media/i2c/soc_camera/mt9t031.c | 11 +-
drivers/media/i2c/soc_camera/mt9t112.c | 11 +-
drivers/media/i2c/soc_camera/mt9v022.c | 16 +-
drivers/media/i2c/soc_camera/ov5642.c | 5 +-
drivers/media/i2c/soc_camera/ov772x.c | 10 +-
drivers/media/i2c/soc_camera/ov9640.c | 10 +-
drivers/media/i2c/soc_camera/ov9740.c | 10 +-
drivers/media/i2c/soc_camera/rj54n1cb0c.c | 12 +-
drivers/media/i2c/soc_camera/tw9910.c | 13 +-
drivers/media/i2c/tc358743.c | 10 +-
drivers/media/i2c/tda7432.c | 1 -
drivers/media/i2c/tvaudio.c | 2 -
drivers/media/i2c/tvp5150.c | 6 +-
drivers/media/pci/bt8xx/bttv-cards.c | 7 +
drivers/media/pci/bt8xx/bttv.h | 1 -
drivers/media/pci/cx88/cx88-blackbird.c | 3 +-
drivers/media/pci/cx88/cx88-video.c | 10 +-
drivers/media/pci/cx88/cx88.h | 4 +-
drivers/media/pci/saa7134/saa7134-video.c | 2 +
drivers/media/platform/pxa_camera.c | 8 +-
drivers/media/platform/rcar-vin/rcar-core.c | 4 +-
drivers/media/platform/rcar-vin/rcar-dma.c | 4 +-
.../platform/soc_camera/sh_mobile_ceu_camera.c | 2 +-
drivers/media/platform/soc_camera/soc_camera.c | 3 +-
.../platform/soc_camera/soc_camera_platform.c | 2 +-
drivers/media/platform/soc_camera/soc_mediabus.c | 2 +-
drivers/media/platform/vimc/vimc-sensor.c | 2 +-
drivers/media/platform/vivid/vivid-core.h | 2 +-
drivers/media/usb/cx231xx/cx231xx-video.c | 2 +
drivers/media/usb/em28xx/em28xx-cards.c | 1 -
drivers/media/usb/pvrusb2/pvrusb2-v4l2.c | 2 +
drivers/media/usb/tm6000/tm6000-cards.c | 1 -
drivers/media/usb/tm6000/tm6000-video.c | 2 +
drivers/media/v4l2-core/v4l2-dev.c | 10 +-
drivers/media/v4l2-core/v4l2-fwnode.c | 5 +-
include/media/i2c-addr.h | 42 --
include/media/i2c/tvaudio.h | 17 +-
include/media/{ => tpg}/v4l2-tpg.h | 45 +-
include/media/v4l2-dev.h | 124 ++++--
include/media/v4l2-flash-led-class.h | 12 +
include/media/v4l2-fwnode.h | 4 +-
include/media/v4l2-mediabus.h | 176 ++++++--
include/media/v4l2-subdev.h | 293 +++++++++----
include/media/v4l2-tpg-colors.h | 68 ---
include/media/videobuf2-core.h | 483 ++++++++++++---------
include/media/videobuf2-memops.h | 8 +-
include/media/videobuf2-v4l2.h | 112 ++---
56 files changed, 1006 insertions(+), 659 deletions(-)
delete mode 100644 include/media/i2c-addr.h
rename include/media/{ => tpg}/v4l2-tpg.h (93%)
delete mode 100644 include/media/v4l2-tpg-colors.h
--
2.13.6
next reply other threads:[~2017-10-09 10:19 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-09 10:19 Mauro Carvalho Chehab [this message]
2017-10-09 10:19 ` [PATCH 01/24] media: v4l2-dev.h: add kernel-doc to two macros Mauro Carvalho Chehab
2017-10-09 11:14 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 02/24] media: v4l2-flash-led-class.h: add kernel-doc to two ancillary funcs Mauro Carvalho Chehab
2017-10-09 11:15 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 03/24] media: v4l2-mediabus: use BIT() macro for flags Mauro Carvalho Chehab
2017-10-09 11:16 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 04/24] media: v4l2-mediabus: convert flags to enums and document them Mauro Carvalho Chehab
2017-10-09 10:56 ` Hans Verkuil
2017-10-11 21:26 ` Pavel Machek
2017-12-18 18:43 ` Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 05/24] media: v4l2-dev: convert VFL_TYPE_* into an enum Mauro Carvalho Chehab
2017-10-09 10:59 ` Hans Verkuil
2017-10-09 13:38 ` Mike Isely
2017-10-10 20:47 ` Andrey Utkin
2017-12-18 16:48 ` Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 06/24] media: i2c-addr.h: get rid of now unused defines Mauro Carvalho Chehab
2017-10-09 10:59 ` Hans Verkuil
2017-10-09 10:19 ` [PATCH 07/24] media: get rid of i2c-addr.h Mauro Carvalho Chehab
2017-10-09 11:00 ` Hans Verkuil
2017-10-09 10:19 ` [PATCH 08/24] media: v4l2-dev: document VFL_DIR_* direction defines Mauro Carvalho Chehab
2017-10-09 11:00 ` Hans Verkuil
2017-10-09 10:19 ` [PATCH 09/24] media: v4l2-dev: document video_device flags Mauro Carvalho Chehab
2017-10-09 11:02 ` Hans Verkuil
2017-10-09 10:19 ` [PATCH 10/24] media: v4l2-subdev: use kernel-doc markups to document subdev flags Mauro Carvalho Chehab
2017-10-09 20:24 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 11/24] media: v4l2-subdev: create cross-references for ioctls Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 12/24] media: v4l2-subdev: fix description of tuner.s_radio ops Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 13/24] media: v4l2-subdev: better document IO pin configuration flags Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 14/24] media: v4l2-subdev: convert frame description to enum Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 15/24] media: v4l2-subdev: get rid of __V4L2_SUBDEV_MK_GET_TRY() macro Mauro Carvalho Chehab
2017-10-09 20:23 ` Sakari Ailus
2017-12-18 19:27 ` Mauro Carvalho Chehab
2017-12-19 8:24 ` Sakari Ailus
2017-12-19 11:03 ` Mauro Carvalho Chehab
2017-12-19 11:56 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 16/24] media: v4l2-subdev: document remaining undocumented functions Mauro Carvalho Chehab
2017-10-09 20:45 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 17/24] media: v4l2-subdev: fix a typo Mauro Carvalho Chehab
2017-10-09 20:26 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 18/24] media: vb2-core: use bitops for bits Mauro Carvalho Chehab
2017-10-10 14:01 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 19/24] media: vb2-core: Improve kernel-doc markups Mauro Carvalho Chehab
2017-10-10 13:32 ` Sakari Ailus
2017-12-18 17:20 ` Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 20/24] media: vb2-core: document remaining functions Mauro Carvalho Chehab
2017-10-09 10:19 ` [PATCH 21/24] media: vb2-core: fix descriptions for VB2-only functions Mauro Carvalho Chehab
2017-10-10 13:49 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 22/24] media: vb2: add cross references at memops and v4l2 kernel-doc markups Mauro Carvalho Chehab
2017-10-10 13:51 ` Sakari Ailus
2017-10-09 10:19 ` [PATCH 23/24] media: v4l2-tpg*.h: move headers to include/media/tpg and merge them Mauro Carvalho Chehab
2017-10-09 10:28 ` Hans Verkuil
2017-10-09 10:19 ` [PATCH 24/24] media: v4l2-tpg.h: rename color structs Mauro Carvalho Chehab
2017-10-09 10:29 ` Hans Verkuil
2017-10-09 12:35 ` [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2 Mauro Carvalho Chehab
2017-12-18 17:30 ` 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.1507544011.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=Julia.Lawall@lip6.fr \
--cc=andrey_utkin@fastmail.com \
--cc=arnd@arndb.de \
--cc=arvind.yadav.cs@gmail.com \
--cc=bhumirks@gmail.com \
--cc=bparrot@ti.com \
--cc=christophe.jaillet@wanadoo.fr \
--cc=corbet@lwn.net \
--cc=dheitmueller@kernellabs.com \
--cc=elena.reshetova@intel.com \
--cc=g.liakhovetski@gmx.de \
--cc=garsilva@embeddedor.com \
--cc=geliangtang@gmail.com \
--cc=hans.verkuil@cisco.com \
--cc=helen.koike@collabora.com \
--cc=hverkuil@xs4all.nl \
--cc=isely@pobox.com \
--cc=ishkamiel@gmail.com \
--cc=jmkrzyszt@gmail.com \
--cc=keescook@chromium.org \
--cc=kumar.san1093@gmail.com \
--cc=kyungmin.park@samsung.com \
--cc=lars@metafoo.de \
--cc=laurent.pinchart+renesas@ideasonboard.com \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-renesas-soc@vger.kernel.org \
--cc=m.szyprowski@samsung.com \
--cc=matrandg@cisco.com \
--cc=mchehab@infradead.org \
--cc=niklas.soderlund@ragnatech.se \
--cc=p.zabel@pengutronix.de \
--cc=pavel@ucw.cz \
--cc=pawel@osciak.com \
--cc=petr.cvek@tul.cz \
--cc=ricardo.ribalda@gmail.com \
--cc=robert.jarzmik@free.fr \
--cc=robh@kernel.org \
--cc=sakari.ailus@linux.intel.com \
--cc=sre@kernel.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).