diff mbox series

[RFC,v3,2/2] doc: add missing table of content links

Message ID 20240708153941.1045588-3-sam.povilus@amd.com
State Superseded, archived
Delegated to: Heinrich Schuchardt
Headers show
Series FIT documentation link vs copy | expand

Commit Message

Sam Povilus July 8, 2024, 3:39 p.m. UTC
add missing table of content links, make alphabetical 

Signed-off-by: Sam Povilus <sam.povilus@amd.com>
---
 doc/usage/fit/index.rst | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

Comments

Heinrich Schuchardt July 8, 2024, 4:04 p.m. UTC | #1
On 08.07.24 17:39, Sam Povilus wrote:
> add missing table of content links, make alphabetical
>
> Signed-off-by: Sam Povilus <sam.povilus@amd.com>
> ---
>   doc/usage/fit/index.rst | 21 ++++++++++++++++++---
>   1 file changed, 18 insertions(+), 3 deletions(-)
>
> diff --git a/doc/usage/fit/index.rst b/doc/usage/fit/index.rst
> index af2e481212..ed28dc89ae 100644
> --- a/doc/usage/fit/index.rst
> +++ b/doc/usage/fit/index.rst
> @@ -10,9 +10,24 @@ images that it it reads and boots. Documentation about FIT is available in
>   .. toctree::
>       :maxdepth: 1
>
> +    beaglebone_vboot
>       howto
> -    x86-fit-boot
> +    kernel_fdt
> +    kernel_fdts_compressed
> +    kernel
> +    multi
> +    multi_spl
> +    multi-with-fpga
> +    multi-with-loadables
> +    overlay-fdt-boot
> +    sec_firmware_ppa
>       signature
> +    sign-configs
> +    sign-images
> +    source_file_format

In patch 1 you delete this page.

Run 'make html' fails on this.

When changing documentation, please, build it.

> +    uefi
> +    update3
> +    update_uboot
>       verified-boot
> -    beaglebone_vboot
> -    overlay-fdt-boot
> +    x86-fit-boot
> +

We should avoid trailing blank lines at the end of files.

Otherwise looks good to me.

Best regards

Heinrich
Heinrich Schuchardt July 8, 2024, 4:08 p.m. UTC | #2
On 08.07.24 18:04, Heinrich Schuchardt wrote:
> On 08.07.24 17:39, Sam Povilus wrote:
>> add missing table of content links, make alphabetical
>>
>> Signed-off-by: Sam Povilus <sam.povilus@amd.com>
>> ---
>>   doc/usage/fit/index.rst | 21 ++++++++++++++++++---
>>   1 file changed, 18 insertions(+), 3 deletions(-)
>>
>> diff --git a/doc/usage/fit/index.rst b/doc/usage/fit/index.rst
>> index af2e481212..ed28dc89ae 100644
>> --- a/doc/usage/fit/index.rst
>> +++ b/doc/usage/fit/index.rst
>> @@ -10,9 +10,24 @@ images that it it reads and boots. Documentation
>> about FIT is available in
>>   .. toctree::
>>       :maxdepth: 1
>>
>> +    beaglebone_vboot
>>       howto
>> -    x86-fit-boot
>> +    kernel_fdt
>> +    kernel_fdts_compressed
>> +    kernel
>> +    multi
>> +    multi_spl
>> +    multi-with-fpga
>> +    multi-with-loadables
>> +    overlay-fdt-boot
>> +    sec_firmware_ppa
>>       signature
>> +    sign-configs
>> +    sign-images
>> +    source_file_format
>
> In patch 1 you delete this page.
>
> Run 'make html' fails on this.
>
> When changing documentation, please, build it.

Got that wrong.

The trailing blank line can be removed when merging.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

>
>> +    uefi
>> +    update3
>> +    update_uboot
>>       verified-boot
>> -    beaglebone_vboot
>> -    overlay-fdt-boot
>> +    x86-fit-boot
>> +
>
> We should avoid trailing blank lines at the end of files.
>
> Otherwise looks good to me.
>
> Best regards
>
> Heinrich
>
diff mbox series

Patch

diff --git a/doc/usage/fit/index.rst b/doc/usage/fit/index.rst
index af2e481212..ed28dc89ae 100644
--- a/doc/usage/fit/index.rst
+++ b/doc/usage/fit/index.rst
@@ -10,9 +10,24 @@  images that it it reads and boots. Documentation about FIT is available in
 .. toctree::
     :maxdepth: 1
 
+    beaglebone_vboot
     howto
-    x86-fit-boot
+    kernel_fdt
+    kernel_fdts_compressed
+    kernel
+    multi
+    multi_spl
+    multi-with-fpga
+    multi-with-loadables
+    overlay-fdt-boot
+    sec_firmware_ppa
     signature
+    sign-configs
+    sign-images
+    source_file_format
+    uefi
+    update3
+    update_uboot
     verified-boot
-    beaglebone_vboot
-    overlay-fdt-boot
+    x86-fit-boot
+