1. Patchew
  2. linux
  3. [PATCH 0/3] Optimize wbt and update its comments and doc
  4. View patch

[PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface

Tang Yizhou posted 3 patches 2 months, 1 week ago
There is a newer version of this series
[PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface
Posted by Tang Yizhou 2 months, 1 week ago 
From: Tang Yizhou <yizhou.tang@shopee.com>

The symbol wb_window_usec cannot be found. Update the doc to reflect the
latest implementation, in other words, the cur_win_nsec member of struct
rq_wb.

Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com>
---
 Documentation/ABI/stable/sysfs-block | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
index 4ba771b56b3b..7bb4dce73eca 100644
--- a/Documentation/ABI/stable/sysfs-block
+++ b/Documentation/ABI/stable/sysfs-block
@@ -731,11 +731,11 @@ Contact:	linux-block@vger.kernel.org
 Description:
 		[RW] If the device is registered for writeback throttling, then
 		this file shows the target minimum read latency. If this latency
-		is exceeded in a given window of time (see wb_window_usec), then
-		the writeback throttling will start scaling back writes. Writing
-		a value of '0' to this file disables the feature. Writing a
-		value of '-1' to this file resets the value to the default
-		setting.
+		is exceeded in a given window of time (see the cur_win_nsec
+		member of struct rq_wb), then the writeback throttling will
+		start scaling back writes. Writing a value of '0' to this file
+		disables the feature. Writing a value of '-1' to this file
+		resets the value to the default setting.
 
 
 What:		/sys/block/<disk>/queue/write_cache
-- 
2.25.1
Re: [PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface
Posted by Jan Kara 2 months, 1 week ago 
On Thu 24-07-25 16:30:01, Tang Yizhou wrote:
> From: Tang Yizhou <yizhou.tang@shopee.com>
> 
> The symbol wb_window_usec cannot be found. Update the doc to reflect the
> latest implementation, in other words, the cur_win_nsec member of struct
> rq_wb.
> 
> Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com>

I think the name should be actually 'curr_win_nsec' because that's the name
of this value shown in debugfs.

								Honza

> ---
>  Documentation/ABI/stable/sysfs-block | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
> index 4ba771b56b3b..7bb4dce73eca 100644
> --- a/Documentation/ABI/stable/sysfs-block
> +++ b/Documentation/ABI/stable/sysfs-block
> @@ -731,11 +731,11 @@ Contact:	linux-block@vger.kernel.org
>  Description:
>  		[RW] If the device is registered for writeback throttling, then
>  		this file shows the target minimum read latency. If this latency
> -		is exceeded in a given window of time (see wb_window_usec), then
> -		the writeback throttling will start scaling back writes. Writing
> -		a value of '0' to this file disables the feature. Writing a
> -		value of '-1' to this file resets the value to the default
> -		setting.
> +		is exceeded in a given window of time (see the cur_win_nsec
> +		member of struct rq_wb), then the writeback throttling will
> +		start scaling back writes. Writing a value of '0' to this file
> +		disables the feature. Writing a value of '-1' to this file
> +		resets the value to the default setting.
>  
>  
>  What:		/sys/block/<disk>/queue/write_cache
> -- 
> 2.25.1
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR
Re: [PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface
Posted by Yizhou Tang 2 months, 1 week ago 
On Fri, Jul 25, 2025 at 11:49 PM Jan Kara <jack@suse.cz> wrote:
>
> On Thu 24-07-25 16:30:01, Tang Yizhou wrote:
> > From: Tang Yizhou <yizhou.tang@shopee.com>
> >
> > The symbol wb_window_usec cannot be found. Update the doc to reflect the
> > latest implementation, in other words, the cur_win_nsec member of struct
> > rq_wb.
> >
> > Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com>
>
> I think the name should be actually 'curr_win_nsec' because that's the name
> of this value shown in debugfs.
>
>                                                                 Honza

Agreed, I will make the change in the next patch.

Thanks,
Yi

>
> > ---
> >  Documentation/ABI/stable/sysfs-block | 10 +++++-----
> >  1 file changed, 5 insertions(+), 5 deletions(-)
> >
> > diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
> > index 4ba771b56b3b..7bb4dce73eca 100644
> > --- a/Documentation/ABI/stable/sysfs-block
> > +++ b/Documentation/ABI/stable/sysfs-block
> > @@ -731,11 +731,11 @@ Contact:        linux-block@vger.kernel.org
> >  Description:
> >               [RW] If the device is registered for writeback throttling, then
> >               this file shows the target minimum read latency. If this latency
> > -             is exceeded in a given window of time (see wb_window_usec), then
> > -             the writeback throttling will start scaling back writes. Writing
> > -             a value of '0' to this file disables the feature. Writing a
> > -             value of '-1' to this file resets the value to the default
> > -             setting.
> > +             is exceeded in a given window of time (see the cur_win_nsec
> > +             member of struct rq_wb), then the writeback throttling will
> > +             start scaling back writes. Writing a value of '0' to this file
> > +             disables the feature. Writing a value of '-1' to this file
> > +             resets the value to the default setting.
> >
> >
> >  What:                /sys/block/<disk>/queue/write_cache
> > --
> > 2.25.1
> >
> --
> Jan Kara <jack@suse.com>
> SUSE Labs, CR
Re: [PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface
Posted by Yu Kuai 2 months, 1 week ago 
Hi,

在 2025/7/25 23:49, Jan Kara 写道:
> On Thu 24-07-25 16:30:01, Tang Yizhou wrote:
>> From: Tang Yizhou <yizhou.tang@shopee.com>
>>
>> The symbol wb_window_usec cannot be found. Update the doc to reflect the
>> latest implementation, in other words, the cur_win_nsec member of struct
>> rq_wb.
>>
>> Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com>
> I think the name should be actually 'curr_win_nsec' because that's the name
> of this value shown in debugfs.
Agreed, or you can mention both the field in rq_wb and debugfs name.

Thanks,
Kuai
>
> 								Honza
>
>> ---
>>   Documentation/ABI/stable/sysfs-block | 10 +++++-----
>>   1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
>> index 4ba771b56b3b..7bb4dce73eca 100644
>> --- a/Documentation/ABI/stable/sysfs-block
>> +++ b/Documentation/ABI/stable/sysfs-block
>> @@ -731,11 +731,11 @@ Contact:	linux-block@vger.kernel.org
>>   Description:
>>   		[RW] If the device is registered for writeback throttling, then
>>   		this file shows the target minimum read latency. If this latency
>> -		is exceeded in a given window of time (see wb_window_usec), then
>> -		the writeback throttling will start scaling back writes. Writing
>> -		a value of '0' to this file disables the feature. Writing a
>> -		value of '-1' to this file resets the value to the default
>> -		setting.
>> +		is exceeded in a given window of time (see the cur_win_nsec
>> +		member of struct rq_wb), then the writeback throttling will
>> +		start scaling back writes. Writing a value of '0' to this file
>> +		disables the feature. Writing a value of '-1' to this file
>> +		resets the value to the default setting.
>>   
>>   
>>   What:		/sys/block/<disk>/queue/write_cache
>> -- 
>> 2.25.1
>>
Re: [PATCH 3/3] blk-wbt: doc: Update the doc of the wbt_lat_usec interface
Posted by Yizhou Tang 2 months, 1 week ago 
On Sat, Jul 26, 2025 at 2:16 AM Yu Kuai <yukuai@kernel.org> wrote:
>
> Hi,
>
> 在 2025/7/25 23:49, Jan Kara 写道:
> > On Thu 24-07-25 16:30:01, Tang Yizhou wrote:
> >> From: Tang Yizhou <yizhou.tang@shopee.com>
> >>
> >> The symbol wb_window_usec cannot be found. Update the doc to reflect the
> >> latest implementation, in other words, the cur_win_nsec member of struct
> >> rq_wb.
> >>
> >> Signed-off-by: Tang Yizhou <yizhou.tang@shopee.com>
> > I think the name should be actually 'curr_win_nsec' because that's the name
> > of this value shown in debugfs.
> Agreed, or you can mention both the field in rq_wb and debugfs name.
>

I will change it to cur_win_nsec in the next patch.

Thanks,
Yi

> Thanks,
> Kuai
> >
> >                                                               Honza
> >
> >> ---
> >>   Documentation/ABI/stable/sysfs-block | 10 +++++-----
> >>   1 file changed, 5 insertions(+), 5 deletions(-)
> >>
> >> diff --git a/Documentation/ABI/stable/sysfs-block b/Documentation/ABI/stable/sysfs-block
> >> index 4ba771b56b3b..7bb4dce73eca 100644
> >> --- a/Documentation/ABI/stable/sysfs-block
> >> +++ b/Documentation/ABI/stable/sysfs-block
> >> @@ -731,11 +731,11 @@ Contact:       linux-block@vger.kernel.org
> >>   Description:
> >>              [RW] If the device is registered for writeback throttling, then
> >>              this file shows the target minimum read latency. If this latency
> >> -            is exceeded in a given window of time (see wb_window_usec), then
> >> -            the writeback throttling will start scaling back writes. Writing
> >> -            a value of '0' to this file disables the feature. Writing a
> >> -            value of '-1' to this file resets the value to the default
> >> -            setting.
> >> +            is exceeded in a given window of time (see the cur_win_nsec
> >> +            member of struct rq_wb), then the writeback throttling will
> >> +            start scaling back writes. Writing a value of '0' to this file
> >> +            disables the feature. Writing a value of '-1' to this file
> >> +            resets the value to the default setting.
> >>
> >>
> >>   What:              /sys/block/<disk>/queue/write_cache
> >> --
> >> 2.25.1
> >>
>

Patchew 2.1-devel-b67e4c2

© 2016 - 2025 Red Hat, Inc.