lib: Fix first line of kernel-doc for a few functions
Subsystems (11)
PATCH 1/5 lib: Fix first line of kernel-doc for a few functions
The function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- include/linux/list.h | 6 +++--- lib/bitmap.c | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-)
include/linux/list.h +3 -3
@@ -498,7 +498,7 @@ static inline void list_splice_tail_init(struct list_head *list, pos = n, n = list_entry(n->member.next, typeof(*n), member))/** -* list_for_each_entry_safe_continue +* list_for_each_entry_safe_continue - continue list iteration safe against removal * @pos: the type * to use as a loop cursor. * @n: another type * to use as temporary storage * @head: the head for your list.
@@ -514,7 +514,7 @@ static inline void list_splice_tail_init(struct list_head *list, pos = n, n = list_entry(n->member.next, typeof(*n), member))/** -* list_for_each_entry_safe_from +* list_for_each_entry_safe_from - iterate over list from current point safe against removal * @pos: the type * to use as a loop cursor. * @n: another type * to use as temporary storage * @head: the head for your list.
@@ -529,7 +529,7 @@ static inline void list_splice_tail_init(struct list_head *list, pos = n, n = list_entry(n->member.next, typeof(*n), member))/** -* list_for_each_entry_safe_reverse +* list_for_each_entry_safe_reverse - iterate backwards over list safe against removal * @pos: the type * to use as a loop cursor. * @n: another type * to use as temporary storage * @head: the head for your list.
lib/bitmap.c +3 -3
@@ -487,7 +487,7 @@ int __bitmap_parse(const char *buf, unsigned int buflen,EXPORT_SYMBOL (__bitmap_parse);/** -* bitmap_parse_user() +* bitmap_parse_user - convert an ASCII hex string in a user buffer into a bitmap * * @ubuf: pointer to user buffer containing string. * @ulen: buffer size in bytes. If string is smaller than this
@@ -619,7 +619,7 @@ int bitmap_parselist(const char *bp, unsigned long *maskp, int nmaskbits)EXPORT_SYMBOL (bitmap_parselist);/** -* bitmap_pos_to_ord(buf, pos, bits) +* bitmap_pos_to_ord - find ordinal of set bit at given position in bitmap * @buf: pointer to a bitmap * @pos: a bit position in @buf (0 <= @pos < @bits) * @bits: number of valid bit positions in @buf
@@ -655,7 +655,7 @@ static int bitmap_pos_to_ord(const unsigned long *buf, int pos, int bits) }/** -* bitmap_ord_to_pos(buf, ord, bits) +* bitmap_ord_to_pos - find position of n-th set bit in bitmap * @buf: pointer to bitmap * @ord: ordinal bit position (n-th set bit, n >= 0) * @bits: number of valid bit positions in @buf
Signature · 1 line
1.6.6.2
PATCH 2/5 drivers/base: Fix first line of kernel-doc for a few functions
The function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- drivers/base/firmware_class.c | 2 +- drivers/base/platform.c | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-)
drivers/base/firmware_class.c +1 -1
@@ -613,7 +613,7 @@ request_firmware_work_func(void *arg) }/** -* request_firmware_nowait: asynchronous version of request_firmware +* request_firmware_nowait - asynchronous version of request_firmware * @module: module requesting the firmware * @uevent: sends uevent to copy the firmware image if this flag * is non-zero else the firmware copy must be done manually.
drivers/base/platform.c +8 -8
@@ -128,7 +128,7 @@ struct platform_object { };/** -* platform_device_put +* platform_device_put - destroy a platform device * @pdev: platform device to free * * Free all memory associated with a platform device. This function must
@@ -152,7 +152,7 @@ static void platform_device_release(struct device *dev) }/** -* platform_device_alloc +* platform_device_alloc - create a platform device * @name: base name of the device we're adding * @id: instance id *
@@ -177,7 +177,7 @@ struct platform_device *platform_device_alloc(const char *name, int id)EXPORT_SYMBOL_GPL (platform_device_alloc);/** -* platform_device_add_resources +* platform_device_add_resources - add resources to a platform device * @pdev: platform device allocated by platform_device_alloc to add resources to * @res: set of resources that needs to be allocated for the device * @num: number of resources
@@ -202,7 +202,7 @@ int platform_device_add_resources(struct platform_device *pdev,EXPORT_SYMBOL_GPL (platform_device_add_resources);/** -* platform_device_add_data +* platform_device_add_data - add platform-specific data to a platform device * @pdev: platform device allocated by platform_device_alloc to add resources to * @data: platform specific data for this platform device * @size: size of platform specific data
@@ -344,7 +344,7 @@ void platform_device_unregister(struct platform_device *pdev)EXPORT_SYMBOL_GPL (platform_device_unregister);/** -* platform_device_register_simple +* platform_device_register_simple - add a platform-level device and its resources * @name: base name of the device we're adding * @id: instance id * @res: set of resources that needs to be allocated for the device
@@ -396,7 +396,7 @@ error:EXPORT_SYMBOL_GPL (platform_device_register_simple);/** -* platform_device_register_data +* platform_device_register_data - add a platform-level device with platform-specific data * @parent: parent device for the device we're adding * @name: base name of the device we're adding * @id: instance id
@@ -473,7 +473,7 @@ static void platform_drv_shutdown(struct device *_dev) }/** -* platform_driver_register +* platform_driver_register - register a driver for platform-level devices * @drv: platform driver structure */ int platform_driver_register (struct platform_driver *drv)
@@ -491,7 +491,7 @@ int platform_driver_register(struct platform_driver *drv)EXPORT_SYMBOL_GPL (platform_driver_register);/** -* platform_driver_unregister +* platform_driver_unregister - unregister a driver for platform-level devices * @drv: platform driver structure */ void platform_driver_unregister (struct platform_driver *drv)
Signature · 1 line
1.6.6.2
PATCH 3/5 net: Fix first line of kernel-doc for a few functions
In reply to Ben HutchingsThe function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- include/linux/skbuff.h | 4 ++-- include/net/sock.h | 2 +- net/sunrpc/rpc_pipe.c | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-)
include/linux/skbuff.h +2 -2
@@ -738,7 +738,7 @@ static inline struct sk_buff *skb_unshare(struct sk_buff *skb, }/** -* skb_peek +* skb_peek - peek at the head of an &sk_buff_head * @list_: list to peek at * * Peek an &sk_buff. Unlike most other operations you _MUST_
@@ -759,7 +759,7 @@ static inline struct sk_buff *skb_peek(struct sk_buff_head *list_) }/** -* skb_peek_tail +* skb_peek_tail - peek at the tail of an &sk_buff_head * @list_: list to peek at * * Peek an &sk_buff. Unlike most other operations you _MUST_
include/net/sock.h +1 -1
@@ -1049,7 +1049,7 @@ extern void sk_common_release(struct sock *sk);extern void sock_init_data (struct socket *sock,struct sock *sk);/** -* sk_filter_release: Release a socket filter +* sk_filter_release - release a socket filter * @fp: filter to remove * * Remove a filter from a socket and release its resources.
net/sunrpc/rpc_pipe.c +1 -1
@@ -78,7 +78,7 @@ rpc_timeout_upcall_queue(struct work_struct *work) }/** -* rpc_queue_upcall +* rpc_queue_upcall - queue an upcall message to userspace * @inode: inode of upcall pipe on which to queue given message * @msg: message to queue *
Signature · 1 line
1.6.6.2
PATCH 4/5 video: Fix first line of kernel-doc for a few functions
In reply to Ben HutchingsThe function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- drivers/video/modedb.c | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-)
drivers/video/modedb.c +4 -4
@@ -893,7 +893,7 @@ const struct fb_videomode *fb_match_mode(const struct fb_var_screeninfo *var, }/** -* fb_add_videomode: adds videomode entry to modelist +* fb_add_videomode - adds videomode entry to modelist * @mode: videomode to add * @head: struct list_head of modelist *
@@ -928,7 +928,7 @@ int fb_add_videomode(const struct fb_videomode *mode, struct list_head *head) }/** -* fb_delete_videomode: removed videomode entry from modelist +* fb_delete_videomode - removed videomode entry from modelist * @mode: videomode to remove * @head: struct list_head of modelist *
@@ -953,7 +953,7 @@ void fb_delete_videomode(const struct fb_videomode *mode, }/** -* fb_destroy_modelist: destroy modelist +* fb_destroy_modelist - destroy modelist * @head: struct list_head of modelist */ void fb_destroy_modelist (struct list_head *head)
@@ -968,7 +968,7 @@ void fb_destroy_modelist(struct list_head *head)EXPORT_SYMBOL_GPL (fb_destroy_modelist);/** -* fb_videomode_to_modelist: convert mode array to mode list +* fb_videomode_to_modelist - convert mode array to mode list * @modedb: array of struct fb_videomode * @num: number of entries in array * @head: struct list_head of modelist
Signature · 1 line
1.6.6.2
PATCH 5/5 mptscsih: Fix first line of kernel-doc for a few functions
In reply to Ben HutchingsThe function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- drivers/message/fusion/mptscsih.c | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-)
drivers/message/fusion/mptscsih.c +2 -4
@@ -2560,9 +2560,7 @@ mptscsih_getclear_scsi_lookup(MPT_ADAPTER *ioc, int i) }/** -* mptscsih_set_scsi_lookup -* -* writes a scmd entry into the ScsiLookup[] array list +* mptscsih_set_scsi_lookup - write a scmd entry into the ScsiLookup[] array list * * @ioc: Pointer to MPT_ADAPTER structure * @i: index into the array
@@ -2725,7 +2723,7 @@ mptscsih_scandv_complete(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req,/** -* mptscsih_get_completion_code - +* mptscsih_get_completion_code - get completion code from MPT request * @ioc: Pointer to MPT_ADAPTER structure * @req: Pointer to original MPT request frame * @reply: Pointer to MPT reply frame (NULL if TurboReply)
Signature · 1 line
1.6.6.2
David Miller
maintainerRe: [PATCH 3/5] net: Fix first line of kernel-doc for a few functions
In reply to Ben HutchingsFrom: Ben Hutchings <[email protected]>
Date: Sun, 14 Feb 2010 14:19:14 +0000
Quoted 4 lines
The function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
Looks good, applied to net-next-2.6, thanks Ben.
PATCH RESEND 1/1 mptscsih: Fix first line of kernel-doc for a few functions
In reply to Ben HutchingsThe function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
--- drivers/message/fusion/mptscsih.c | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-)
drivers/message/fusion/mptscsih.c +2 -4
@@ -2560,9 +2560,7 @@ mptscsih_getclear_scsi_lookup(MPT_ADAPTER *ioc, int i) }/** -* mptscsih_set_scsi_lookup -* -* writes a scmd entry into the ScsiLookup[] array list +* mptscsih_set_scsi_lookup - write a scmd entry into the ScsiLookup[] array list * * @ioc: Pointer to MPT_ADAPTER structure * @i: index into the array
@@ -2725,7 +2723,7 @@ mptscsih_scandv_complete(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req,/** -* mptscsih_get_completion_code - +* mptscsih_get_completion_code - get completion code from MPT request * @ioc: Pointer to MPT_ADAPTER structure * @req: Pointer to original MPT request frame * @reply: Pointer to MPT reply frame (NULL if TurboReply)
Signature · 1 line
1.6.6.2
Re: [PATCH RESEND] mptscsih: Fix first line of kernel-doc for a few functions
Quoted 4 lines · On Wed, 24 Mar 2010 04:27:59 +0000 Ben Hutchings wrote:
The function name must be followed by a space, hypen, space, and a short description.
Signed-off-by Ben Hutchings <[email protected]>
Acked-by Randy Dunlap <[email protected]>
James, will you be handling this patch or should I?
Quoted 21 lines
--- drivers/message/fusion/mptscsih.c | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-)drivers/message/fusion/mptscsih.c +1
-3@@ -2560,9 +2560,7 @@ mptscsih_getclear_scsi_lookup(MPT_ADAPTER *ioc, int i) }/** -* mptscsih_set_scsi_lookup -* -* writes a scmd entry into the ScsiLookup[] array list +* mptscsih_set_scsi_lookup - write a scmd entry into the ScsiLookup[] array list * * @ioc: Pointer to MPT_ADAPTER structure * @i: index into the array
drivers/message/fusion/mptscsih.c mptscsih_scandv_complete(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req, · line 2729
Quoted 8 lines
drivers/message/fusion/mptscsih.c +1
-1@@ -2725,7 +2723,7 @@ mptscsih_scandv_complete(MPT_ADAPTER *ioc, MPT_FRAME_HDR *req,/** -* mptscsih_get_completion_code - +* mptscsih_get_completion_code - get completion code from MPT request * @ioc: Pointer to MPT_ADAPTER structure * @req: Pointer to original MPT request frame * @reply: Pointer to MPT reply frame (NULL if TurboReply)
Thanks,
---
~Randy