diff mbox series

[2/2] migration-guides: document ZSTD_COMPRESSION_LEVEL change

Message ID 20241121123227.681233-2-alex@linutronix.de
State New
Headers show
Series [1/2] ref-manual: merge two separate descriptions of RECIPE_UPGRADE_EXTRA_TASKS | expand

Commit Message

Alexander Kanavin Nov. 21, 2024, 12:32 p.m. UTC
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
 documentation/migration-guides/migration-5.2.rst | 3 +++
 1 file changed, 3 insertions(+)

Comments

Quentin Schulz Nov. 21, 2024, 1:20 p.m. UTC | #1
Hi Alex,

On 11/21/24 1:32 PM, Alexander Kanavin via lists.yoctoproject.org wrote:
> Signed-off-by: Alexander Kanavin <alex@linutronix.de>
> ---
>   documentation/migration-guides/migration-5.2.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
> index 73d52460f..99330a0b9 100644
> --- a/documentation/migration-guides/migration-5.2.rst
> +++ b/documentation/migration-guides/migration-5.2.rst
> @@ -57,3 +57,6 @@ The following classes have been removed in this release:
>   
>   Miscellaneous changes
>   ~~~~~~~~~~~~~~~~~~~~~
> +
> +- :term:`ZSTD_COMPRESSION_LEVEL` is now a plain integer number instead of a dash-prefixed

standards.md says we want two white spaces after the dash for lists.

ZSTD_COMPRESSION_LEVEL is not yet documented so :term: cannot be used 
here. Either remove :term:, or better yet, add an entry to the glossary 
for it :)

> +command-line option (e.g. it should be set to ``3`` rather than ``-3``).

Please align with the first character of the first sentence in the 
bulleted list (so three spaces).

Looks good to me otherwise,

Thanks for sending the update!

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
index 73d52460f..99330a0b9 100644
--- a/documentation/migration-guides/migration-5.2.rst
+++ b/documentation/migration-guides/migration-5.2.rst
@@ -57,3 +57,6 @@  The following classes have been removed in this release:
 
 Miscellaneous changes
 ~~~~~~~~~~~~~~~~~~~~~
+
+- :term:`ZSTD_COMPRESSION_LEVEL` is now a plain integer number instead of a dash-prefixed 
+command-line option (e.g. it should be set to ``3`` rather than ``-3``).