diff mbox series

binman: doc: fix reference tag placement for Logging section

Message ID 20230909135235.21242-1-massimo.pegorer+oss@gmail.com
State Accepted, archived
Commit 8bd7d08407f986fe3c69f3e198f6f7152e12dea8
Delegated to: Heinrich Schuchardt
Headers show
Series binman: doc: fix reference tag placement for Logging section | expand

Commit Message

Massimo Pegorer Sept. 9, 2023, 1:52 p.m. UTC
Move BinmanLogging reference tag after section "Signing FIT container
with private key in an image" and just before section "Logging".

Fixes: 0f40e23fd22 ("binman: add documentation for binman sign option")
Signed-off-by: Massimo Pegorer <massimo.pegorer+oss@gmail.com>

---
Note that at the end of section "Replacing files in an image" and just
before section "Signing FIT container with private key in an image"
there is a line which seems a typo or an incomplete sentence:

 Repacking an image involves

---
 tools/binman/binman.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Heinrich Schuchardt Sept. 10, 2023, 5:17 a.m. UTC | #1
On 9/9/23 15:52, Massimo Pegorer wrote:
> Move BinmanLogging reference tag after section "Signing FIT container
> with private key in an image" and just before section "Logging".
>
> Fixes: 0f40e23fd22 ("binman: add documentation for binman sign option")
> Signed-off-by: Massimo Pegorer <massimo.pegorer+oss@gmail.com>

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Massimo Pegorer Sept. 10, 2023, 3:35 p.m. UTC | #2
Hi Simon, Heinrich,

Il giorno sab 9 set 2023 alle ore 15:52 Massimo Pegorer
<massimo.pegorer+oss@gmail.com> ha scritto:
>
> Move BinmanLogging reference tag after section "Signing FIT container
> with private key in an image" and just before section "Logging".
>
> Fixes: 0f40e23fd22 ("binman: add documentation for binman sign option")
> Signed-off-by: Massimo Pegorer <massimo.pegorer+oss@gmail.com>
>
> ---
> Note that at the end of section "Replacing files in an image" and just
> before section "Signing FIT container with private key in an image"
> there is a line which seems a typo or an incomplete sentence:
>
>  Repacking an image involves

Any comment about this note? Should I remove this line in a v2?

Regards,
Massimo

> ---
>  tools/binman/binman.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst
> index aeea33fddb..8945b19446 100644
> --- a/tools/binman/binman.rst
> +++ b/tools/binman/binman.rst
> @@ -1482,7 +1482,6 @@ when it was created.
>
>   Repacking an image involves
>
> -.. _`BinmanLogging`:
>
>  Signing FIT container with private key in an image
>  --------------------------------------------------
> @@ -1501,6 +1500,7 @@ If you want to sign and replace FIT container in place::
>  which will sign FIT container with private key and replace it immediately
>  inside your image.
>
> +.. _`BinmanLogging`:
>
>  Logging
>  -------
> --
> 2.34.1
>
Simon Glass Sept. 10, 2023, 7:13 p.m. UTC | #3
Hi Massimo,

On Sun, 10 Sept 2023 at 09:35, Massimo Pegorer
<massimo.pegorer+oss@gmail.com> wrote:
>
> Hi Simon, Heinrich,
>
> Il giorno sab 9 set 2023 alle ore 15:52 Massimo Pegorer
> <massimo.pegorer+oss@gmail.com> ha scritto:
> >
> > Move BinmanLogging reference tag after section "Signing FIT container
> > with private key in an image" and just before section "Logging".
> >
> > Fixes: 0f40e23fd22 ("binman: add documentation for binman sign option")
> > Signed-off-by: Massimo Pegorer <massimo.pegorer+oss@gmail.com>
> >
> > ---
> > Note that at the end of section "Replacing files in an image" and just
> > before section "Signing FIT container with private key in an image"
> > there is a line which seems a typo or an incomplete sentence:
> >
> >  Repacking an image involves
>
> Any comment about this note? Should I remove this line in a v2?

Yes you can remove it. I suspect I was starting to explain what binman
does to repack...

Regards,
Simon
diff mbox series

Patch

diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst
index aeea33fddb..8945b19446 100644
--- a/tools/binman/binman.rst
+++ b/tools/binman/binman.rst
@@ -1482,7 +1482,6 @@  when it was created.
 
  Repacking an image involves
 
-.. _`BinmanLogging`:
 
 Signing FIT container with private key in an image
 --------------------------------------------------
@@ -1501,6 +1500,7 @@  If you want to sign and replace FIT container in place::
 which will sign FIT container with private key and replace it immediately
 inside your image.
 
+.. _`BinmanLogging`:
 
 Logging
 -------