diff mbox series

[v2] sw-description.rst: Fix the 'compressed' string recommendation

Message ID 20220530235253.2181253-1-festevam@gmail.com
State Accepted
Headers show
Series [v2] sw-description.rst: Fix the 'compressed' string recommendation | expand

Commit Message

Fabio Estevam May 30, 2022, 11:52 p.m. UTC
From: Fabio Estevam <festevam@denx.de>

The recommended format for describing 'compressed' as string is:

compressed = "zlib"

Fix it accordingly.

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
Changes since v1:
- Fix typo in the Subject.

 doc/source/sw-description.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Stefano Babic June 5, 2022, 1:55 p.m. UTC | #1
On 31.05.22 01:52, Fabio Estevam wrote:
> From: Fabio Estevam <festevam@denx.de>
> 
> The recommended format for describing 'compressed' as string is:
> 
> compressed = "zlib"
> 
> Fix it accordingly.
> 
> Signed-off-by: Fabio Estevam <festevam@denx.de>
> ---
> Changes since v1:
> - Fix typo in the Subject.
> 
>   doc/source/sw-description.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst
> index e6fe0e20204b..028a4ec11855 100644
> --- a/doc/source/sw-description.rst
> +++ b/doc/source/sw-description.rst
> @@ -1340,7 +1340,7 @@ There are 4 main sections inside sw-description:
>      |             |          |            | and "zstd".                           |
>      +-------------+----------+------------+---------------------------------------+
>      | compressed  | bool (dep| images     | Deprecated. Use the string form. true |
> -   |             | recated) | files      | is equal to 'compression = "zlib"'.   |
> +   |             | recated) | files      | is equal to 'compressed = "zlib"'.    |
>      +-------------+----------+------------+---------------------------------------+
>      | installed-\ | bool     | images     | flag to indicate that image is        |
>      | directly    |          |            | streamed into the target without any  |


Applied to -master, thanks !

Bext regards,
Stefano Babic
diff mbox series

Patch

diff --git a/doc/source/sw-description.rst b/doc/source/sw-description.rst
index e6fe0e20204b..028a4ec11855 100644
--- a/doc/source/sw-description.rst
+++ b/doc/source/sw-description.rst
@@ -1340,7 +1340,7 @@  There are 4 main sections inside sw-description:
    |             |          |            | and "zstd".                           |
    +-------------+----------+------------+---------------------------------------+
    | compressed  | bool (dep| images     | Deprecated. Use the string form. true |
-   |             | recated) | files      | is equal to 'compression = "zlib"'.   |
+   |             | recated) | files      | is equal to 'compressed = "zlib"'.    |
    +-------------+----------+------------+---------------------------------------+
    | installed-\ | bool     | images     | flag to indicate that image is        |
    | directly    |          |            | streamed into the target without any  |