Hi Aristo,

On 2026-07-21T15:21:05, Aristo Chen <[email protected]> wrote:
> binman: fit: document how ELF load addresses are determined
>
> The fit,load property confuses users because the load address is
> taken from the ELF file rather than being specified in the binman
> node. Document how to inspect an ELF file to find out where its
> segments will be loaded, using readelf, the linker script or objdump,
> and point at the elf_sections and elf_sections_tee test linker
> scripts as examples of two components placed to avoid overlapping
> memory.
>
> Compared to the previously applied version of this change, the text
> now lives in the fit etype docstring. The entry documentation is
> produced from docstrings by the binman_docs Sphinx extension at
> documentation build time, so no pre-generated file needs updating.
>
> Signed-off-by: Aristo Chen <[email protected]>
>
> tools/binman/etype/fit.py | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)

> diff --git a/tools/binman/etype/fit.py b/tools/binman/etype/fit.py
> @@ -317,6 +317,24 @@ class Entry_fit(Entry_section):
> +            1. Use readelf to examine the program headers:
> +               ``readelf -l your_elf_file.elf``
> +               Look for the LOAD segments and their VirtAddr (Virtual 
> Address)

With no blank lines between them, RST treats these as one paragraph, so
the output collapses to a single run-on line: "Use readelf to examine the
program headers: readelf -l your_elf_file.elf Look for the LOAD segments
...". The same happens in items 2 and 3. Please can you put a blank line
before and after each command so it renders on its own line? It reads
fine as source but the generated docs are what matters.

Regards,
Simon

Reply via email to