[PATCH 02/12] binman: mkimage: Remove extra colon

[Lukas Funke]

On 29.06.2023 17:08, Quentin Schulz wrote:
> Hi Lukas,
>
> On 6/29/23 16:59, lukas.funke-oss at weidmueller.com wrote:
>> [You don't often get email from lukas.funke-oss at weidmueller.com. 
>> Learn why this is important at 
>> https://aka.ms/LearnAboutSenderIdentification ]
>>
>> From: Lukas Funke <lukas.funke at weidmueller.com>
>>
>> Remove extra colon typo
>>
>> Signed-off-by: Lukas Funke <lukas.funke at weidmueller.com>
>> ---
>>
>>   tools/binman/etype/mkimage.py | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/tools/binman/etype/mkimage.py 
>> b/tools/binman/etype/mkimage.py
>> index e028c44070..dd734fc779 100644
>> --- a/tools/binman/etype/mkimage.py
>> +++ b/tools/binman/etype/mkimage.py
>> @@ -24,7 +24,7 @@ class Entry_mkimage(Entry):
>>           - filename: filename of output binary generated by mkimage
>>
>>       The data passed to mkimage via the -d flag is collected from 
>> subnodes of the
>> -    mkimage node, e.g.::
>> +    mkimage node, e.g.:
>>
>
> This is by far not the only occurrence in the docstrings, see:
>
> $ ag -c :: tools/binman/**/*.py
> tools/binman/btool/btool_gzip.py:2
> tools/binman/btool/bzip2.py:2
> tools/binman/btool/lz4.py:2
> tools/binman/btool/lzma_alone.py:2
> tools/binman/btool/lzop.py:2
> tools/binman/btool/xz.py:2
> tools/binman/btool/zstd.py:2
> tools/binman/cbfs_util.py:1
> tools/binman/etype/atf_fip.py:3
> tools/binman/etype/cbfs.py:5
> tools/binman/etype/fdtmap.py:1
> tools/binman/etype/fit.py:7
> tools/binman/etype/mkimage.py:7
> tools/binman/etype/pre_load.py:1
> tools/binman/etype/section.py:1
> tools/binman/etype/tee_os.py:2
> tools/binman/etype/text.py:3
> tools/binman/ftest.py:15
> tools/binman/setup.py:3
> tools/binman/state.py:1
>
> If I'm not mistaken, we (manually) populate the docstring from the 
> docs written in rST where `::` does actually mean something (start of 
> a literal block, c.f. 
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks). 
> I think it's fine to keep it as is (and maybe we could use the 
> docstring directly from within sphinx instead of duplicating it, but I 
> don't have experience with that so I don't know if it's possible, 
> desirable and reasonably easy to implement and maintain).
>
> Cheers,
> Quentin

Hi Quentin,

I wasn't aware of that, thanks for pointing it out. I'll drop the patch 
in the next iteration.

Best regards

Lukas