Skip to contentSkip to conversation

doc: fit: Make data-size a conditionally mandatory property

PATCH In review Bastian Germann 2 participants 4 messages Jun 24, 2024 – Jun 27, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: fit: Make data-size a conditionally mandatory property

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.

---
 doc/usage/fit/source_file_format.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
doc/usage/fit/source_file_format.rst +3 -3
index 7727ab77c5..15990e3ff5 100644
@@ -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:
 
Signature · 1 line
2.45.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · 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.

Quoted 7 lines

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

---
 doc/usage/fit/source_file_format.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Can you please add a PR here?

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

Quoted 26 lines
doc/usage/fit/source_file_format.rst +3 -4
index 7727ab77c5..15990e3ff5 100644
@@ -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:
 
--
Quoted 2 lines

2.45.2

Regards,
Simon