Skip to contentSkip to conversation

input: fix input-mt kernel-doc warning

PATCH In review Randy Dunlap 3 participants 5 messages Nov 7, 2012 – Nov 14, 2012

Subsystems (3)
HID Input drivers Input multitouch (mt) protocol
lore
Share & tools
lore

Randy Dunlap

author
#0 lore raw

PATCH 1/1 input: fix input-mt kernel-doc warning

From: Randy Dunlap <[email protected]>

Fix new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Signed-off-by Randy Dunlap <[email protected]>
Cc Henrik Rydberg <[email protected]>
Cc [email protected]
---
 drivers/input/input-mt.c |    1 +
 1 file changed, 1 insertion(+)
drivers/input/input-mt.c +1 -0
@@ -26,6 +26,7 @@ static void copy_abs(struct input_dev *d
  * input_mt_init_slots() - initialize MT input slots
  * @dev: input device supporting MT events and finger tracking
  * @num_slots: number of slots used by the device
+ * @flags: device flags (see include/linux/input/mt.h)
  *
  * This function allocates all necessary memory for MT slot handling
  * in the input device, prepares the ABS_MT_SLOT and
#1 lore raw

Hi Randy,

Quoted 5 lines

From: Randy Dunlap <[email protected]>

Fix new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Thanks for the patch. It seemed reasonable to expand the function documentation a bit as well, hope you are alright with the patch below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it for 3.8.

Thanks,
Henrik

---

Quoted 1 line

From a96b3a67eefba05d7e6de3afa1b51d17728d45d3 Mon Sep 17 00:00:00 2001

From: Henrik Rydberg <[email protected]>
Date: Wed, 7 Nov 2012 20:40:24 +0100
Subject: [PATCH] Input: MT - Document undocumented init argument

Fixes new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Reported-by Randy Dunlap <[email protected]>
Signed-off-by Henrik Rydberg <[email protected]>
---
 drivers/input/input-mt.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/input/input-mt.c +4 -0
index c0ec7d4..1abbc17 100644
@@ -26,10 +26,14 @@ static void copy_abs(struct input_dev *dev, unsigned int dst, unsigned int src)
  * input_mt_init_slots() - initialize MT input slots
  * @dev: input device supporting MT events and finger tracking
  * @num_slots: number of slots used by the device
+ * @flags: mt tasks to handle in core
  *
  * This function allocates all necessary memory for MT slot handling
  * in the input device, prepares the ABS_MT_SLOT and
  * ABS_MT_TRACKING_ID events for use and sets up appropriate buffers.
+ * Depending on the flags set, it also performs pointer emulation and
+ * frame synchronization.
+ *
  * May be called repeatedly. Returns -EINVAL if attempting to
  * reinitialize with a different number of slots.
  */
Signature · 1 line
1.8.0
maintainer
#2 lore raw
Quoted 4 lines · Henrik Rydberg

Hi Randy,

Quoted 2 lines

From: Randy Dunlap <[email protected]>

Quoted 8 lines
Quoted 3 lines

Fix new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Thanks for the patch. It seemed reasonable to expand the function documentation a bit as well, hope you are alright with the patch below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it for 3.8.

Randy, Henrik,

I'll try getting it in 3.7.

Thanks.

Signature · 1 line
Dmitry
#3 lore raw

Hi Dmitry,

Quoted 6 lines
Quoted 6 lines
Quoted 5 lines

From: Randy Dunlap <[email protected]>

Fix new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Quoted 8 lines
Quoted 4 lines

Thanks for the patch. It seemed reasonable to expand the function documentation a bit as well, hope you are alright with the patch below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it for 3.8.

Randy, Henrik,

I'll try getting it in 3.7.

Seems there were more warnings introduced in 3.7-rc1... adding the patch below seems to fix all of them. I guess you want to merge the former patch into this one.

Thanks,
Henrik

Quoted 1 line

From 1ba1d5e18057260a3203625eaee22cc94393fda3 Mon Sep 17 00:00:00 2001

From: Henrik Rydberg <[email protected]>
Date: Thu, 8 Nov 2012 18:48:22 +0100
Subject: [PATCH] Input: Document new struct members

Fixes kernel-doc warnings for the members added in 3.7-rc1.

Signed-off-by Henrik Rydberg <[email protected]>
---
 include/linux/input.h | 3 +++
 1 file changed, 3 insertions(+)
include/linux/input.h +3 -0
index cab994b..2d55e55 100644
@@ -112,6 +112,9 @@ struct input_value {
  * @h_list: list of input handles associated with the device. When
  *	accessing the list dev->mutex must be held
  * @node: used to place the device onto input_dev_list
+ * @num_vals: number of values queued in the current frame
+ * @max_vals: maximum number of values queued in a frame
+ * @vals: array of values queued in the current frame
  */
 struct input_dev {
 	const char *name;
Signature · 1 line
1.8.0
maintainer
#4 lore raw
Quoted 13 lines · Henrik Rydberg

Hi Dmitry,

Quoted 11 lines
Quoted 10 lines
Quoted 5 lines

From: Randy Dunlap <[email protected]>

Fix new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Thanks for the patch. It seemed reasonable to expand the function documentation a bit as well, hope you are alright with the patch below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it for 3.8.

Quoted 7 lines
Quoted 3 lines

Randy, Henrik,

I'll try getting it in 3.7.

Seems there were more warnings introduced in 3.7-rc1... adding the patch below seems to fix all of them. I guess you want to merge the former patch into this one.

Ended up on putting all in 3.8 queue as it clashed with some other data members I added to struct inptu_dev.

Thanks.

Signature · 1 line
Dmitry