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@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: Re: [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2
Date: Mon, 9 Oct 2017 09:35:27 -0300 [thread overview]
Message-ID: <20171009093527.32f8d976@vento.lan> (raw)
In-Reply-To: <cover.1507544011.git.mchehab@s-opensource.com>
Em Mon, 9 Oct 2017 07:19:06 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> escreveu:
> 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.
Forgot to mention:
This series, together with the part1 one is on this tree:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=v4l-docs-part2-v1
As I may not have time to address the remaining kAPI bits for
a while, let me document what kAPIs at include/media main dir
are still out of sync:
- cec-pin.h: struct cec_pin;
- cec.h: several structs;
- media-device.h, media-devnode.h: a couple of defines;
- rc-core.h: ancillary functions;
- soc-camera.h, v4l2-clk.h, videobuf-*.h - probably not
worth the efforts, as those are obsolete kAPI;
- v4l2-common.h: print macros. IMHO, we should try to get
rid of them, and use dev_foo() everywhere;
- v4l2-fwnode.h: In this specific case, Sakari has a patch
series addressing it, moving existing documentation from
v4l2-fwnode.c;
- v4l2-mem2mem.h: v4l2 ioctl helpers aren't documented;
- videobuf2-*.h: This series contain several documentation
improvements there for VB2 core and V4L2, with are the
most important ones - as they're used by the drivers.
The other headers are either undocumented or barely
documented.
PS.: It should be noticed that there are other files under
include/media and inside their sub-directories that aren't
part of the media kAPI, but are driver-specific stuff,
like, for example, imx.h, vsp1.h and i2c/ subdir.
Thanks,
Mauro
next prev parent reply other threads:[~2017-10-09 12:35 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-09 10:19 [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2 Mauro Carvalho Chehab
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 12:35 ` Mauro Carvalho Chehab [this message]
2017-12-18 17:30 ` [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2 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=20171009093527.32f8d976@vento.lan \
--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