From: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
To: linux-media@vger.kernel.org, dafna.hirschfeld@collabora.com,
helen.koike@collabora.com, ezequiel@collabora.com,
hverkuil@xs4all.nl, kernel@collabora.com, dafna3@gmail.com,
mchehab@kernel.org, laurent.pinchart@ideasonboard.com
Subject: [PATCH 4/5] media: vimc: fix issues in documentation in vimc-common.h
Date: Sat, 28 Mar 2020 08:52:53 +0100 [thread overview]
Message-ID: <20200328075254.4616-5-dafna.hirschfeld@collabora.com> (raw)
In-Reply-To: <20200328075254.4616-1-dafna.hirschfeld@collabora.com>
There are some missing and extra fields and typos in
structs documentations in vimc-common.h. Fix it.
Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
---
drivers/media/platform/vimc/vimc-common.h | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/drivers/media/platform/vimc/vimc-common.h b/drivers/media/platform/vimc/vimc-common.h
index 616d5a6b0754..40a58f1cb18f 100644
--- a/drivers/media/platform/vimc/vimc-common.h
+++ b/drivers/media/platform/vimc/vimc-common.h
@@ -63,7 +63,8 @@ do { \
*
* @code: media bus format code defined by MEDIA_BUS_FMT_* macros
* @bbp: number of bytes each pixel occupies
- * @pixelformat: pixel format devined by V4L2_PIX_FMT_* macros
+ * @pixelformat: pixel format defined by V4L2_PIX_FMT_* macros
+ * @bayer true if this is a bayer format
*
* Struct which matches the MEDIA_BUS_FMT_* codes with the corresponding
* V4L2_PIX_FMT_* fourcc pixelformat and its bytes per pixel (bpp)
@@ -90,7 +91,7 @@ struct vimc_pix_map {
* the node it will be of an instance of v4l2_subdev or video_device struct
* where both contains a struct media_entity.
* Those structures should embedded the vimc_ent_device struct through
- * v4l2_set_subdevdata() and video_set_drvdata() respectivaly, allowing the
+ * v4l2_set_subdevdata() and video_set_drvdata() respectively, allowing the
* vimc_ent_device struct to be retrieved from the corresponding struct
* media_entity
*/
@@ -123,10 +124,8 @@ struct vimc_device {
* configuration for each entity
*
* @name entity name
- * @ved pointer to vimc_ent_device (a node in the
- * topology)
* @add initializes and registers
- * vim entity - called from vimc-core
+ * vimc entity - called from vimc-core
* @unregister unregisters vimc entity - called from vimc-core
* @release releases vimc entity - called from the v4l2_dev
* release callback
@@ -182,7 +181,7 @@ const struct vimc_pix_map *vimc_pix_map_by_code(u32 code);
/**
* vimc_pix_map_by_pixelformat - get vimc_pix_map struct by v4l2 pixel format
*
- * @pixelformat: pixel format devined by V4L2_PIX_FMT_* macros
+ * @pixelformat: pixel format defined by V4L2_PIX_FMT_* macros
*/
const struct vimc_pix_map *vimc_pix_map_by_pixelformat(u32 pixelformat);
--
2.17.1
next prev parent reply other threads:[~2020-03-28 7:53 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-28 7:52 [PATCH 0/5] media: vimc: various fixes Dafna Hirschfeld
2020-03-28 7:52 ` [PATCH 1/5] media: vimc: remove the function vimc_unregister Dafna Hirschfeld
2020-03-28 7:52 ` [PATCH 2/5] media: vimc: handle error in vimc_add_subdevs Dafna Hirschfeld
2020-03-28 7:52 ` [PATCH 3/5] media: vimc: keep the error value when adding an entity fails Dafna Hirschfeld
2020-03-28 7:52 ` Dafna Hirschfeld [this message]
2020-03-28 7:52 ` [PATCH 5/5] media: vimc: add vimc_ent_type struct for the callbacks of entities Dafna Hirschfeld
2020-03-30 12:10 ` Hans Verkuil
2020-03-30 12:11 ` Hans Verkuil
2020-03-30 15:57 ` Dafna Hirschfeld
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=20200328075254.4616-5-dafna.hirschfeld@collabora.com \
--to=dafna.hirschfeld@collabora.com \
--cc=dafna3@gmail.com \
--cc=ezequiel@collabora.com \
--cc=helen.koike@collabora.com \
--cc=hverkuil@xs4all.nl \
--cc=kernel@collabora.com \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.