diff mbox series

[V2,2/5] blktrace: add blk_fill_rwbs documentation comment

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

Commit Message

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

Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Reviewed-by: Damien Le Moal <damien.lemoal@wdc.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
---
 include/linux/blktrace_api.h |  2 +-
 kernel/trace/blktrace.c      | 10 ++++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)

Comments

Randy Dunlap Feb. 5, 2021, 7:58 p.m. UTC | #1
On 2/4/21 7:50 PM, Chaitanya Kulkarni wrote:
> blk_fill_rwbs() is an expoted function, add kernel style documentation
> comment.
> 
> Signed-off-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
> Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
> Reviewed-by: Damien Le Moal <damien.lemoal@wdc.com>
> Reviewed-by: Christoph Hellwig <hch@lst.de>
> ---
>  include/linux/blktrace_api.h |  2 +-
>  kernel/trace/blktrace.c      | 10 ++++++++++
>  2 files changed, 11 insertions(+), 1 deletion(-)
> 
> diff --git a/include/linux/blktrace_api.h b/include/linux/blktrace_api.h
> index 11484f1d19a1..e17d04abf6a3 100644
> --- a/include/linux/blktrace_api.h
> +++ b/include/linux/blktrace_api.h
> @@ -119,7 +119,7 @@ struct compat_blk_user_trace_setup {
>  
>  #endif
>  
> -extern void blk_fill_rwbs(char *rwbs, unsigned int op);
> +void blk_fill_rwbs(char *rwbs, unsigned int op);
>  
>  static inline sector_t blk_rq_trace_sector(struct request *rq)
>  {
> diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
> index 8a2591c7aa41..d7ebef83771c 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.

Hi,
                for any next time:                    @op

> + * @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;
> 

thanks.
Chaitanya Kulkarni Feb. 6, 2021, 2:01 a.m. UTC | #2
On 2/5/21 11:58, Randy Dunlap wrote:
>>  #ifdef CONFIG_EVENT_TRACING
>>  
>> +/**
>> + * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
> Hi,
>                 for any next time:                    @op
>
Thanks a alot for your comment, it can be done at the time of apply also.

I'll keep in mind.
diff mbox series

Patch

diff --git a/include/linux/blktrace_api.h b/include/linux/blktrace_api.h
index 11484f1d19a1..e17d04abf6a3 100644
--- a/include/linux/blktrace_api.h
+++ b/include/linux/blktrace_api.h
@@ -119,7 +119,7 @@  struct compat_blk_user_trace_setup {
 
 #endif
 
-extern void blk_fill_rwbs(char *rwbs, unsigned int op);
+void blk_fill_rwbs(char *rwbs, unsigned int op);
 
 static inline sector_t blk_rq_trace_sector(struct request *rq)
 {
diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
index 8a2591c7aa41..d7ebef83771c 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;