All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@osg.samsung.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>
Subject: [PATCH 12/39] [media] v4l2-subdev: reorder the v4l2_subdev_video_ops comments
Date: Sat, 22 Aug 2015 14:27:57 -0300	[thread overview]
Message-ID: <02be051204e880a8277d80734e788ee645d1ef14.1440264165.git.mchehab@osg.samsung.com> (raw)
In-Reply-To: <cover.1440264165.git.mchehab@osg.samsung.com>
In-Reply-To: <cover.1440264165.git.mchehab@osg.samsung.com>

The comments for struct v4l2_subdev_video_ops are out of the
order as the parameter would appear at struct. This is not
a problem for DocBook, but humans find harder to mentally
reorder ;)

So, put them at the right order. That makes easier to check
what's missing, and to put the comments in the right place.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index d9315e5e8957..884a8d7c1368 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -309,6 +309,15 @@ struct v4l2_mbus_frame_desc {
 /**
  * struct v4l2_subdev_video_ops - Callbacks used when v4l device was opened
  * 				  in video mode.
+ *
+ * @s_routing: see s_routing in audio_ops, except this version is for video
+ *	devices.
+ *
+ * @s_crystal_freq: sets the frequency of the crystal used to generate the
+ *	clocks in Hz. An extra flags field allows device specific configuration
+ *	regarding clock frequency dividers, etc. If not used, then set flags
+ *	to 0. If the frequency is not supported, then -EINVAL is returned.
+ *
  * @s_std_output: set v4l2_std_id for video OUTPUT devices. This is ignored by
  *	video input devices.
  *
@@ -321,22 +330,15 @@ struct v4l2_mbus_frame_desc {
  * @g_tvnorms_output: get v4l2_std_id with all standards supported by the video
  *	OUTPUT device. This is ignored by video capture devices.
  *
- * @s_crystal_freq: sets the frequency of the crystal used to generate the
- *	clocks in Hz. An extra flags field allows device specific configuration
- *	regarding clock frequency dividers, etc. If not used, then set flags
- *	to 0. If the frequency is not supported, then -EINVAL is returned.
- *
  * @g_input_status: get input status. Same as the status field in the v4l2_input
  *	struct.
  *
- * @s_routing: see s_routing in audio_ops, except this version is for video
- *	devices.
- *
  * @s_dv_timings(): Set custom dv timings in the sub device. This is used
  *	when sub device is capable of setting detailed timing information
  *	in the hardware to generate/detect the video signal.
  *
  * @g_dv_timings(): Get custom dv timings in the sub device.
+ *
  * @g_mbus_config: get supported mediabus configurations
  *
  * @s_mbus_config: set a certain mediabus configuration. This operation is added
-- 
2.4.3


  parent reply	other threads:[~2015-08-22 17:28 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-22 17:27 [PATCH 00/39] Document the kABI for the media subsystem Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 01/39] [media] DocBook: fix an unbalanced <para> tag Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 02/39] [media] DocBook/device-drivers: Add drivers/media core stuff Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 03/39] [media] Docbook: Fix description of struct media_devnode Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 04/39] [media] DocBook/media/Makefile: Avoid make htmldocs to fail Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 05/39] [media] Docbook: Fix comments at v4l2-async.h Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 06/39] [media] Docbook: Fix s_rx_carrier_range parameter description Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 07/39] [media] Docbook: fix comments at v4l2-flash-led-class.h Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 08/39] [media] Docbook: Fix comments at v4l2-mem2mem.h Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 09/39] [media] v4l2-subdev: convert documentation to the right format Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 10/39] [media] v4l2-subdev: Add description for core ioctl handlers Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 11/39] [media] v4l2-subdev: Add description for radio " Mauro Carvalho Chehab
2015-08-22 17:27 ` Mauro Carvalho Chehab [this message]
2015-08-22 17:27 ` [PATCH 13/39] [media] v4l2_subdev: describe ioctl parms at v4l2_subdev_video_ops Mauro Carvalho Chehab
2015-08-22 17:27 ` [PATCH 14/39] [media] v4l2_subdev: describe ioctl parms at the remaining structs Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 15/39] [media] v4l2-subdev: add remaining argument descriptions Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 16/39] [media] DocBook: add dvb_ca_en50221.h to documentation Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 17/39] [media] DocBook: add dvb_frontend.h " Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 18/39] [media] DocBook: add dvb_math.h " Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 19/39] [media] DocBook: add dvb_ringbuffer.h " Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 20/39] [media] v4l2-ctrls.h: add to device-drivers DocBook Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 21/39] [media] v4l2-ctls: don't document v4l2_ctrl_fill() Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 22/39] [media] v4l2-ctrls.h: Document a few missing arguments Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 23/39] [media] v4l2-event.h: fix comments and add to DocBook Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 24/39] [media] v4l-dv-timings.h: Add to device-drivers DocBook Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 25/39] [media] videobuf2-core: Add it " Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 26/39] [media] videobuf2-memops.h: add " Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 27/39] [media] v4l2-mediabus: Add to DocBook Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 28/39] [media] DocBook: Better organize media devices Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 29/39] [media] dvb_frontend: document dvb_frontend_tune_settings Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 30/39] [media] add documentation for struct dvb_tuner_info Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 31/39] [media] dvb_frontend.h: get rid of dvbfe_modcod Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 32/39] [media] Docbook: Document struct analog_parameters Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 33/39] fixup: dvb_tuner_info Mauro Carvalho Chehab
2015-08-22 17:52   ` Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 34/39] [media] dvb_frontend.h: Document struct dvb_tuner_ops Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 35/39] [media] dvb_frontend.h: document struct analog_demod_ops Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 36/39] [media] dvb: Use DVBFE_ALGO_HW where applicable Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 37/39] [media] dvb-frontend.h: document struct dvb_frontend_ops Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 38/39] [media] dvb-frontend.h: document struct dtv_frontend_properties Mauro Carvalho Chehab
2015-08-22 17:28 ` [PATCH 39/39] [media] dvb_frontend.h: document the struct dvb_frontend Mauro Carvalho Chehab
2015-08-23  9:43 ` [PATCH 00/39] Document the kABI for the media subsystem Jonathan Corbet

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=02be051204e880a8277d80734e788ee645d1ef14.1440264165.git.mchehab@osg.samsung.com \
    --to=mchehab@osg.samsung.com \
    --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 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.