diff mbox series

[v1] doc: Update path to source_file_format.rst

Message ID 20230907205045.15406-1-jmcosta944@gmail.com
State Accepted, archived
Delegated to: Heinrich Schuchardt
Headers show
Series [v1] doc: Update path to source_file_format.rst | expand

Commit Message

João Marcos Costa Sept. 7, 2023, 8:50 p.m. UTC
Previously, the file extension was .txt, and it referenced the uImage.FIT
directory, which no longer exists. This commit updates the path accordingly.

Signed-off-by: Joao Marcos Costa <jmcosta944@gmail.com>
---
 doc/usage/fit/howto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Heinrich Schuchardt Sept. 8, 2023, 7:29 p.m. UTC | #1
On 9/7/23 22:50, Joao Marcos Costa wrote:
> Previously, the file extension was .txt, and it referenced the uImage.FIT
> directory, which no longer exists. This commit updates the path accordingly.
>
> Signed-off-by: Joao Marcos Costa <jmcosta944@gmail.com>
> ---
>   doc/usage/fit/howto.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/usage/fit/howto.rst b/doc/usage/fit/howto.rst
> index c933703d1d..8b38cd534d 100644
> --- a/doc/usage/fit/howto.rst
> +++ b/doc/usage/fit/howto.rst
> @@ -22,7 +22,7 @@ for its latest version. mkimage (together with dtc) takes as input
>   an image source file, which describes the contents of the image and defines
>   its various properties used during booting. By convention, image source file
>   has the ".its" extension, also, the details of its format are given in
> -doc/uImage.FIT/source_file_format.txt. The actual data that is to be included in
> +doc/usage/fit/source_file_format.rst. The actual data that is to be included in

Thank you for updating the reference.

In the HTML documentation we want to generate a link here using:

     :doc:`source_file_format`

Best regards

Heinrich

>   the uImage (kernel, ramdisk, etc.) is specified in the image source file in the
>   form of paths to appropriate data files. The outcome of the image creation
>   process is a binary file (by convention with the ".itb" extension) that
Simon Glass Sept. 10, 2023, 7:13 p.m. UTC | #2
On Fri, 8 Sept 2023 at 13:28, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> On 9/7/23 22:50, Joao Marcos Costa wrote:
> > Previously, the file extension was .txt, and it referenced the uImage.FIT
> > directory, which no longer exists. This commit updates the path accordingly.
> >
> > Signed-off-by: Joao Marcos Costa <jmcosta944@gmail.com>
> > ---
> >   doc/usage/fit/howto.rst | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/doc/usage/fit/howto.rst b/doc/usage/fit/howto.rst
> > index c933703d1d..8b38cd534d 100644
> > --- a/doc/usage/fit/howto.rst
> > +++ b/doc/usage/fit/howto.rst
> > @@ -22,7 +22,7 @@ for its latest version. mkimage (together with dtc) takes as input
> >   an image source file, which describes the contents of the image and defines
> >   its various properties used during booting. By convention, image source file
> >   has the ".its" extension, also, the details of its format are given in
> > -doc/uImage.FIT/source_file_format.txt. The actual data that is to be included in
> > +doc/usage/fit/source_file_format.rst. The actual data that is to be included in
>
> Thank you for updating the reference.
>
> In the HTML documentation we want to generate a link here using:
>
>      :doc:`source_file_format`
>
> Best regards
>
> Heinrich
>
> >   the uImage (kernel, ramdisk, etc.) is specified in the image source file in the
> >   form of paths to appropriate data files. The outcome of the image creation
> >   process is a binary file (by convention with the ".itb" extension) that
>

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

Patch

diff --git a/doc/usage/fit/howto.rst b/doc/usage/fit/howto.rst
index c933703d1d..8b38cd534d 100644
--- a/doc/usage/fit/howto.rst
+++ b/doc/usage/fit/howto.rst
@@ -22,7 +22,7 @@  for its latest version. mkimage (together with dtc) takes as input
 an image source file, which describes the contents of the image and defines
 its various properties used during booting. By convention, image source file
 has the ".its" extension, also, the details of its format are given in
-doc/uImage.FIT/source_file_format.txt. The actual data that is to be included in
+doc/usage/fit/source_file_format.rst. The actual data that is to be included in
 the uImage (kernel, ramdisk, etc.) is specified in the image source file in the
 form of paths to appropriate data files. The outcome of the image creation
 process is a binary file (by convention with the ".itb" extension) that