[PATCH] dev-manual: disk-space: improve wording for obsolete sstate cache files

[PATCH] dev-manual: disk-space: improve wording for obsolete sstate cache files

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Replace "duplicate" by "obsolete", more appropriate.
"duplicate" probably comes from the "--remove-duplicated"
option of the sstate-cache-management.sh script.

Improve other sentences too.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/dev-manual/disk-space.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/documentation/dev-manual/disk-space.rst b/documentation/dev-manual/disk-space.rst
index a84bef4511..5b6702f594 100644
--- a/documentation/dev-manual/disk-space.rst
+++ b/documentation/dev-manual/disk-space.rst
@@ -23,12 +23,12 @@ final disk usage of 22 Gbytes instead of &MIN_DISK_SPACE; Gbytes. However,
 &MIN_DISK_SPACE_RM_WORK; Gbytes of initial free disk space are still needed to
 create temporary files before they can be deleted.
 
-Purging Duplicate Shared State Cache Files
-==========================================
+Purging Obsolete Shared State Cache Files
+=========================================
 
 After multiple build iterations, the Shared State (sstate) cache can contain
-duplicate cache files for a given package, consuming a substantial amount of
-disk space. However, only the most recent cache files are likeky to be reusable.
+multiple cache files for a given package, consuming a substantial amount of
+disk space. However, only the most recent ones are likeky to be reusable.
 
 The following command is a quick way to purge all the cache files which
 haven't been used for a least a specified number of days::
-- 
2.34.1

Re: [docs] [PATCH] dev-manual: disk-space: improve wording for obsolete sstate cache files

[Quentin Schulz]

Hi Michael,

On 9/18/23 17:09, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Replace "duplicate" by "obsolete", more appropriate.
> "duplicate" probably comes from the "--remove-duplicated"
> option of the sstate-cache-management.sh script.
> 
> Improve other sentences too.
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> ---
>   documentation/dev-manual/disk-space.rst | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/documentation/dev-manual/disk-space.rst b/documentation/dev-manual/disk-space.rst
> index a84bef4511..5b6702f594 100644
> --- a/documentation/dev-manual/disk-space.rst
> +++ b/documentation/dev-manual/disk-space.rst
> @@ -23,12 +23,12 @@ final disk usage of 22 Gbytes instead of &MIN_DISK_SPACE; Gbytes. However,
>   &MIN_DISK_SPACE_RM_WORK; Gbytes of initial free disk space are still needed to
>   create temporary files before they can be deleted.
>   
> -Purging Duplicate Shared State Cache Files
> -==========================================
> +Purging Obsolete Shared State Cache Files
> +=========================================
>   
>   After multiple build iterations, the Shared State (sstate) cache can contain
> -duplicate cache files for a given package, consuming a substantial amount of
> -disk space. However, only the most recent cache files are likeky to be reusable.
> +multiple cache files for a given package, consuming a substantial amount of
> +disk space. However, only the most recent ones are likeky to be reusable.
>   

s/likeky/likely/

s/reusable/reused/

?

Cheers,
Quentin

Re: [docs] [PATCH] dev-manual: disk-space: improve wording for obsolete sstate cache files

[Michael Opdenacker]

Hi Quentin,

Thanks for the review!

On 18.09.23 at 17:14, Quentin Schulz wrote:
> Hi Michael,
>
> On 9/18/23 17:09, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Replace "duplicate" by "obsolete", more appropriate.
>> "duplicate" probably comes from the "--remove-duplicated"
>> option of the sstate-cache-management.sh script.
>>
>> Improve other sentences too.
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
>> ---
>>   documentation/dev-manual/disk-space.rst | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/documentation/dev-manual/disk-space.rst 
>> b/documentation/dev-manual/disk-space.rst
>> index a84bef4511..5b6702f594 100644
>> --- a/documentation/dev-manual/disk-space.rst
>> +++ b/documentation/dev-manual/disk-space.rst
>> @@ -23,12 +23,12 @@ final disk usage of 22 Gbytes instead of 
>> &MIN_DISK_SPACE; Gbytes. However,
>>   &MIN_DISK_SPACE_RM_WORK; Gbytes of initial free disk space are 
>> still needed to
>>   create temporary files before they can be deleted.
>>   -Purging Duplicate Shared State Cache Files
>> -==========================================
>> +Purging Obsolete Shared State Cache Files
>> +=========================================
>>     After multiple build iterations, the Shared State (sstate) cache 
>> can contain
>> -duplicate cache files for a given package, consuming a substantial 
>> amount of
>> -disk space. However, only the most recent cache files are likeky to 
>> be reusable.
>> +multiple cache files for a given package, consuming a substantial 
>> amount of
>> +disk space. However, only the most recent ones are likeky to be 
>> reusable.
>
> s/likeky/likely/


Oops, fixed!

>
> s/reusable/reused/

I was going to say that I prefer "reusable", but I guess you meant that 
the combination of "likely" and "reusable" is applying the possibility 
twice.

OK for "reused" too.

Thanks again!
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] dev-manual: disk-space: improve wording for obsolete sstate cache files

[Quentin Schulz]

Hi Michael,

On 9/18/23 17:28, Michael Opdenacker wrote:
> Hi Quentin,
> 
> Thanks for the review!
> 
> On 18.09.23 at 17:14, Quentin Schulz wrote:
>> Hi Michael,
>>
>> On 9/18/23 17:09, Michael Opdenacker via lists.yoctoproject.org wrote:
>>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>>
>>> Replace "duplicate" by "obsolete", more appropriate.
>>> "duplicate" probably comes from the "--remove-duplicated"
>>> option of the sstate-cache-management.sh script.
>>>
>>> Improve other sentences too.
>>>
>>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
>>> ---
>>>   documentation/dev-manual/disk-space.rst | 8 ++++----
>>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/documentation/dev-manual/disk-space.rst 
>>> b/documentation/dev-manual/disk-space.rst
>>> index a84bef4511..5b6702f594 100644
>>> --- a/documentation/dev-manual/disk-space.rst
>>> +++ b/documentation/dev-manual/disk-space.rst
>>> @@ -23,12 +23,12 @@ final disk usage of 22 Gbytes instead of 
>>> &MIN_DISK_SPACE; Gbytes. However,
>>>   &MIN_DISK_SPACE_RM_WORK; Gbytes of initial free disk space are 
>>> still needed to
>>>   create temporary files before they can be deleted.
>>>   -Purging Duplicate Shared State Cache Files
>>> -==========================================
>>> +Purging Obsolete Shared State Cache Files
>>> +=========================================
>>>     After multiple build iterations, the Shared State (sstate) cache 
>>> can contain
>>> -duplicate cache files for a given package, consuming a substantial 
>>> amount of
>>> -disk space. However, only the most recent cache files are likeky to 
>>> be reusable.
>>> +multiple cache files for a given package, consuming a substantial 
>>> amount of
>>> +disk space. However, only the most recent ones are likeky to be 
>>> reusable.
>>
>> s/likeky/likely/
> 
> 
> Oops, fixed!
> 
>>
>> s/reusable/reused/
> 
> I was going to say that I prefer "reusable", but I guess you meant that 
> the combination of "likely" and "reusable" is applying the possibility 
> twice.
>

All sstate-cache files are reusable, that's the purpose of a cache. 
However, only a few are likely to be reused, because the metadata when 
they were created and the current one are more likely to be the same or 
similar enough for the cache file to be reused.

Cheers,
Quentin