[PATCH] doc: fit: Make data-size a conditionally mandatory property

[PATCH] doc: fit: Make data-size a conditionally mandatory property

[Bastian Germann]

Before 9d0750064e (doc: Move external FIT docs into the main body), the
FIT property data-size was not a mandatory property and still it is not
expected to be set alongside the data property.

Move the data-size property to the "Conditionally mandatory property"
section, where it actually belongs.

Signed-off-by: Bastian Germann <bage@debian.org>
---
 doc/usage/fit/source_file_format.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/usage/fit/source_file_format.rst b/doc/usage/fit/source_file_format.rst
index 7727ab77c5..15990e3ff5 100644
--- a/doc/usage/fit/source_file_format.rst
+++ b/doc/usage/fit/source_file_format.rst
@@ -254,9 +254,6 @@ compression
     zstd                  zstd compressed
     ====================  ==================
 
-data-size
-    size of the data in bytes
-
 
 Conditionally mandatory property
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -276,6 +273,9 @@ data-position
     not relative to the loading of the FIT. This is mandatory if external data
     used with a fixed address.
 
+data-size
+    Size of the data in bytes. This is mandatory if external data is used.
+
 os
     OS name, mandatory for types "kernel". Valid OS names are:
 
-- 
2.45.2

Re: [PATCH] doc: fit: Make data-size a conditionally mandatory property

[Simon Glass]

On Mon, 24 Jun 2024 at 20:08, Bastian Germann <bage@debian.org> wrote:
>
> Before 9d0750064e (doc: Move external FIT docs into the main body), the
> FIT property data-size was not a mandatory property and still it is not
> expected to be set alongside the data property.
>
> Move the data-size property to the "Conditionally mandatory property"
> section, where it actually belongs.
>
> Signed-off-by: Bastian Germann <bage@debian.org>
> ---
>  doc/usage/fit/source_file_format.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Reviewed-by: Simon Glass <sjg@chromium.org>

Can you please add a PR here?

https://github.com/open-source-firmware/flat-image-tree

>
> diff --git a/doc/usage/fit/source_file_format.rst b/doc/usage/fit/source_file_format.rst
> index 7727ab77c5..15990e3ff5 100644
> --- a/doc/usage/fit/source_file_format.rst
> +++ b/doc/usage/fit/source_file_format.rst
> @@ -254,9 +254,6 @@ compression
>      zstd                  zstd compressed
>      ====================  ==================
>
> -data-size
> -    size of the data in bytes
> -
>
>  Conditionally mandatory property
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> @@ -276,6 +273,9 @@ data-position
>      not relative to the loading of the FIT. This is mandatory if external data
>      used with a fixed address.
>
> +data-size
> +    Size of the data in bytes. This is mandatory if external data is used.
> +
>  os
>      OS name, mandatory for types "kernel". Valid OS names are:
>
> --
> 2.45.2
>

Regards,
Simon

Re: [PATCH] doc: fit: Make data-size a conditionally mandatory property

[Bastian Germann]

Am 26.06.24 um 10:00 schrieb Simon Glass:
> Can you please add a PR here?
> 
> https://github.com/open-source-firmware/flat-image-tree

In that copy, the property is already conditionally mandatory.

Re: [PATCH] doc: fit: Make data-size a conditionally mandatory property

[Simon Glass]

Hi Bastian,

On Wed, 26 Jun 2024 at 18:37, Bastian Germann <bage@debian.org> wrote:
>
> Am 26.06.24 um 10:00 schrieb Simon Glass:
> > Can you please add a PR here?
> >
> > https://github.com/open-source-firmware/flat-image-tree
>
> In that copy, the property is already conditionally mandatory.

OK. I think we should figure out how to include the copy in U-Boot at
some point. See [1] for an idea.

Regards,
Simon

[1] https://patchwork.ozlabs.org/project/uboot/cover/20240604195256.1820285-1-sam.povilus@amd.com/