diff mbox series

[2/7] blktrace: add blk_fill_rwbs documentation comment

Message ID 20210202052544.4108-3-chaitanya.kulkarni@wdc.com (mailing list archive)
State New, archived
Headers show
Series blktrace: few clenaup | expand

Commit Message

Chaitanya Kulkarni Feb. 2, 2021, 5:25 a.m. UTC
blk_fill_rwbs() is an expoted function, add kernel style documentation
comment.

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
---
 kernel/trace/blktrace.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Damien Le Moal Feb. 2, 2021, 9:03 a.m. UTC | #1
On 2021/02/02 14:26, Chaitanya Kulkarni wrote:
> blk_fill_rwbs() is an expoted function, add kernel style documentation
> comment.
> 
> Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
> ---
>  kernel/trace/blktrace.c | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
> index 8a2591c7aa41..1a931afcf5c4 100644
> --- a/kernel/trace/blktrace.c
> +++ b/kernel/trace/blktrace.c
> @@ -1867,6 +1867,16 @@ void blk_trace_remove_sysfs(struct device *dev)
>  
>  #ifdef CONFIG_EVENT_TRACING
>  
> +/**
> + * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
> + * @rwbs	buffer to be filled
> + * @op:		REQ_OP_XXX for the tracepoint
> + *
> + * Description:
> + *     Maps the REQ_OP_XXX to character and fills the buffer provided by the
> + *     caller with resulting string.
> + *
> + **/
>  void blk_fill_rwbs(char *rwbs, unsigned int op)
>  {
>  	int i = 0;
> 

The description is a little redundant: the short description is enough I think.
But OK.

Reviewed-by: Damien Le Moal <damien.lemoal@wdc.com>
Johannes Thumshirn Feb. 2, 2021, 9:55 a.m. UTC | #2
On 02/02/2021 06:26, Chaitanya Kulkarni wrote:
> blk_fill_rwbs() is an expoted function, add kernel style documentation               exported ~^

Otherwise,
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
diff mbox series

Patch

diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
index 8a2591c7aa41..1a931afcf5c4 100644
--- a/kernel/trace/blktrace.c
+++ b/kernel/trace/blktrace.c
@@ -1867,6 +1867,16 @@  void blk_trace_remove_sysfs(struct device *dev)
 
 #ifdef CONFIG_EVENT_TRACING
 
+/**
+ * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
+ * @rwbs	buffer to be filled
+ * @op:		REQ_OP_XXX for the tracepoint
+ *
+ * Description:
+ *     Maps the REQ_OP_XXX to character and fills the buffer provided by the
+ *     caller with resulting string.
+ *
+ **/
 void blk_fill_rwbs(char *rwbs, unsigned int op)
 {
 	int i = 0;