[1/1] doc: Chromebook Coral: fix build warnings
diff mbox series

Message ID 20200109193332.27577-1-xypron.glpk@gmx.de
State Accepted
Delegated to: Bin Meng
Headers show
Series
  • [1/1] doc: Chromebook Coral: fix build warnings
Related show

Commit Message

Heinrich Schuchardt Jan. 9, 2020, 7:33 p.m. UTC
Use valid restructured text to avoid warnings like

WARNING: Title underline too short.
WARNING: Block quote ends without a blank line; unexpected unindent.

when building with `make htmldocs`.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/board/google/chromebook_coral.rst | 90 ++++++++++++++-------------
 1 file changed, 46 insertions(+), 44 deletions(-)

--
2.24.1

Comments

Simon Glass Jan. 10, 2020, 9:39 a.m. UTC | #1
On Fri, 10 Jan 2020 at 08:33, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Use valid restructured text to avoid warnings like
>
> WARNING: Title underline too short.
> WARNING: Block quote ends without a blank line; unexpected unindent.
>
> when building with `make htmldocs`.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  doc/board/google/chromebook_coral.rst | 90 ++++++++++++++-------------
>  1 file changed, 46 insertions(+), 44 deletions(-)

Thanks

Reviewed-by: Simon Glass <sjg@chromium.org>
Bin Meng Feb. 3, 2020, 4:54 a.m. UTC | #2
On Fri, Jan 10, 2020 at 3:33 AM Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Use valid restructured text to avoid warnings like
>
> WARNING: Title underline too short.
> WARNING: Block quote ends without a blank line; unexpected unindent.
>
> when building with `make htmldocs`.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  doc/board/google/chromebook_coral.rst | 90 ++++++++++++++-------------
>  1 file changed, 46 insertions(+), 44 deletions(-)
>

Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Tested-by: Bin Meng <bmeng.cn@gmail.com>
Bin Meng Feb. 3, 2020, 4:54 a.m. UTC | #3
On Mon, Feb 3, 2020 at 12:54 PM Bin Meng <bmeng.cn@gmail.com> wrote:
>
> On Fri, Jan 10, 2020 at 3:33 AM Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
> >
> > Use valid restructured text to avoid warnings like
> >
> > WARNING: Title underline too short.
> > WARNING: Block quote ends without a blank line; unexpected unindent.
> >
> > when building with `make htmldocs`.
> >
> > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> > ---
> >  doc/board/google/chromebook_coral.rst | 90 ++++++++++++++-------------
> >  1 file changed, 46 insertions(+), 44 deletions(-)
> >
>
> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
> Tested-by: Bin Meng <bmeng.cn@gmail.com>

applied to u-boot-x86, thanks!

Patch
diff mbox series

diff --git a/doc/board/google/chromebook_coral.rst b/doc/board/google/chromebook_coral.rst
index 515fd06d76..5dc3c97c3d 100644
--- a/doc/board/google/chromebook_coral.rst
+++ b/doc/board/google/chromebook_coral.rst
@@ -112,7 +112,7 @@  U-Boot then shuts down CAR and jumps to its relocated version.


 Boot flow - U-Boot post-relocation
----------------------------------
+----------------------------------

 U-Boot starts up normally, running near the top of RAM. After driver model is
 running, arch_fsp_init_r() is called which loads and runs the FSP-S binary.
@@ -142,54 +142,56 @@  Performance
 -----------

 Bootstage is used through all phases of U-Boot to keep accurate timimgs for
-boot. Use 'bootstage report' in U-Boot to see the report, e.g.:
-
-Timer summary in microseconds (16 records):
-       Mark    Elapsed  Stage
-          0          0  reset
-    155,325    155,325  TPL
-    204,014     48,689  end TPL
-    204,385        371  SPL
-    738,633    534,248  end SPL
-    739,161        528  board_init_f
-    842,764    103,603  board_init_r
-  1,166,233    323,469  main_loop
-  1,166,283         50  id=175
-
-Accumulated time:
-                    62  fast_spi
-                   202  dm_r
-                 7,779  dm_spl
-                15,555  dm_f
-               208,357  fsp-m
-               239,847  fsp-s
-               292,143  mmap_spi
-
-CPU performance is about 3500 DMIPS:
-
-=> dhry
-1000000 iterations in 161 ms: 6211180/s, 3535 DMIPS
+boot. Use 'bootstage report' in U-Boot to see the report, e.g.::
+
+    Timer summary in microseconds (16 records):
+           Mark    Elapsed  Stage
+              0          0  reset
+        155,325    155,325  TPL
+        204,014     48,689  end TPL
+        204,385        371  SPL
+        738,633    534,248  end SPL
+        739,161        528  board_init_f
+        842,764    103,603  board_init_r
+      1,166,233    323,469  main_loop
+      1,166,283         50  id=175
+
+    Accumulated time:
+                        62  fast_spi
+                       202  dm_r
+                     7,779  dm_spl
+                    15,555  dm_f
+                   208,357  fsp-m
+                   239,847  fsp-s
+                   292,143  mmap_spi
+
+CPU performance is about 3500 DMIPS::
+
+    => dhry
+    1000000 iterations in 161 ms: 6211180/s, 3535 DMIPS


 Partial memory map
 ------------------

-ffffffff	Top of ROM (and last byte of 32-bit address space)
-ffff8000	TPL loaded here (from IFWI)
-ff000000	Bottom of ROM
-fefc000		 Top of CAR region
-fef96000	Stack for FSP-M
-fef40000 59000	FSP-M
-fef11000	SPL loaded here
-fef10000	CONFIG_BLOBLIST_ADDR
-fef10000	Stack top in TPL, SPL and U-Boot before relocation
-fef00000  1000	CONFIG_BOOTSTAGE_STASH_ADDR
-fef00000	Base of CAR region
-
-   f0000	CONFIG_ROM_TABLE_ADDR
-  120000	BSS (defined in u-boot-spl.lds)
-  200000	FSP-S (which is run after U-Boot is relocated)
- 1110000	CONFIG_SYS_TEXT_BASE
+::
+
+    ffffffff       Top of ROM (and last byte of 32-bit address space)
+    ffff8000       TPL loaded here (from IFWI)
+    ff000000       Bottom of ROM
+     fefc000       Top of CAR region
+    fef96000       Stack for FSP-M
+    fef40000 59000 FSP-M
+    fef11000       SPL loaded here
+    fef10000       CONFIG_BLOBLIST_ADDR
+    fef10000       Stack top in TPL, SPL and U-Boot before relocation
+    fef00000  1000 CONFIG_BOOTSTAGE_STASH_ADDR
+    fef00000       Base of CAR region
+
+       f0000       CONFIG_ROM_TABLE_ADDR
+      120000       BSS (defined in u-boot-spl.lds)
+      200000       FSP-S (which is run after U-Boot is relocated)
+     1110000       CONFIG_SYS_TEXT_BASE


 Supported peripherals