]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
binman: Use a reference for binman symbols docs
authorSimon Glass <sjg@chromium.org>
Sat, 7 Jan 2023 21:07:11 +0000 (14:07 -0700)
committerSimon Glass <sjg@chromium.org>
Wed, 18 Jan 2023 18:50:01 +0000 (11:50 -0700)
Several etypes have this reference in their documentation. Now that we are
using rST, link to the section directly.

Signed-off-by: Simon Glass <sjg@chromium.org>
Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
tools/binman/binman.rst
tools/binman/entries.rst
tools/binman/etype/u_boot.py
tools/binman/etype/u_boot_spl.py
tools/binman/etype/u_boot_spl_nodtb.py
tools/binman/etype/u_boot_tpl.py
tools/binman/etype/u_boot_tpl_nodtb.py
tools/binman/etype/u_boot_vpl.py
tools/binman/etype/u_boot_vpl_nodtb.py

index 2899e1c7833622f5d2edb1d8f4ac93dc6f11e122..ef3e5a6d19b258bc19eb3bbf3cabaaf62305e896 100644 (file)
@@ -487,6 +487,7 @@ For x86 devices (with the end-at-4gb property) this base address is not added
 since it is assumed that images are XIP and the offsets already include the
 address.
 
+.. _binman_fdt:
 
 Access to binman entry offsets at run time (fdt)
 ------------------------------------------------
index b2ce7960d3bcd2230ccd36a564f7757b68ead642..5b9eb8b82c7b2733e08476e2dfcf11c79488257d 100644 (file)
@@ -1578,11 +1578,7 @@ This is the U-Boot binary, containing relocation information to allow it
 to relocate itself at runtime. The binary typically includes a device tree
 blob at the end of it.
 
-U-Boot can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (fdt)'
-
-in the binman README for more information.
+U-Boot can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 Note that this entry is automatically replaced with u-boot-expanded unless
 --no-expanded is used or the node has a 'no-expanded' property.
@@ -1712,9 +1708,7 @@ not relocatable so must be loaded to the correct address in SRAM, or written
 to run from the correct address if direct flash execution is possible (e.g.
 on x86 devices).
 
-SPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
+SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 in the binman README for more information.
 
@@ -1817,9 +1811,7 @@ entry after this one, or use a u-boot-spl entry instead' which normally
 expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and
 u-boot-spl-dtb
 
-SPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
+SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 in the binman README for more information.
 
@@ -1855,9 +1847,7 @@ loader. Note that SPL is not relocatable so must be loaded to the correct
 address in SRAM, or written to run from the correct address if direct
 flash execution is possible (e.g. on x86 devices).
 
-SPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
+SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 in the binman README for more information.
 
@@ -1972,9 +1962,7 @@ entry after this one, or use a u-boot-tpl entry instead, which normally
 expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and
 u-boot-tpl-dtb
 
-TPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
+TPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 in the binman README for more information.
 
@@ -2060,9 +2048,7 @@ loader. Note that VPL is not relocatable so must be loaded to the correct
 address in SRAM, or written to run from the correct address if direct
 flash execution is possible (e.g. on x86 devices).
 
-SPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
+SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 in the binman README for more information.
 
@@ -2162,11 +2148,7 @@ entry after this one, or use a u_boot_vpl entry instead, which normally
 expands to a section containing u-boot-vpl-dtb, u-boot-vpl-bss-pad and
 u-boot-vpl-dtb
 
-VPL can access binman symbols at runtime. See:
-
-    'Access to binman entry offsets at run time (symbols)'
-
-in the binman README for more information.
+VPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
 The ELF file 'vpl/u-boot-vpl' must also be available for this to work, since
 binman uses that to look up symbols to write into the VPL binary.
index e8d180a46ddc226b179a5afd4ba0cb7f84db3c86..d5639eef2e429e8ef915f8bf035c9a4333419f2b 100644 (file)
@@ -18,11 +18,7 @@ class Entry_u_boot(Entry_blob):
     to relocate itself at runtime. The binary typically includes a device tree
     blob at the end of it.
 
-    U-Boot can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (fdt)'
-
-    in the binman README for more information.
+    U-Boot can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     Note that this entry is automatically replaced with u-boot-expanded unless
     --no-expanded is used or the node has a 'no-expanded' property.
index d1aa3b4fdad844a58e227ee689da898443c7cf1a..be1610569fcfe8f922281fef0da1e6ea79cdf7d1 100644 (file)
@@ -21,9 +21,7 @@ class Entry_u_boot_spl(Entry_blob):
     to run from the correct address if direct flash execution is possible (e.g.
     on x86 devices).
 
-    SPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
+    SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     in the binman README for more information.
 
index 50a126dc7ef3e60546b67c5ac847492d9383db66..e7ec329c902a1fc004901d44c0ebe3330acd2d0f 100644 (file)
@@ -21,9 +21,7 @@ class Entry_u_boot_spl_nodtb(Entry_blob):
     expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and
     u-boot-spl-dtb
 
-    SPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
+    SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     in the binman README for more information.
 
index 1883a2bd5f1fa79ed1e684c0c329e8fee857ad61..397b9f895313bc7d4984f4cd1b78e0be0ce11ca7 100644 (file)
@@ -21,9 +21,7 @@ class Entry_u_boot_tpl(Entry_blob):
     address in SRAM, or written to run from the correct address if direct
     flash execution is possible (e.g. on x86 devices).
 
-    SPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
+    SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     in the binman README for more information.
 
index 7e08e58f1e5c4df06932d5c339abfaee090e772b..9bb2b5dda3003cf27825b0edbfcd7cdc4127abe7 100644 (file)
@@ -21,9 +21,7 @@ class Entry_u_boot_tpl_nodtb(Entry_blob):
     expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and
     u-boot-tpl-dtb
 
-    TPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
+    TPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     in the binman README for more information.
 
index 62e5969c6ec8ccbdc4a221da261145b228a366ed..31d7e8374e2df188747233ebc75fe8a3d6ce998e 100644 (file)
@@ -21,9 +21,7 @@ class Entry_u_boot_vpl(Entry_blob):
     address in SRAM, or written to run from the correct address if direct
     flash execution is possible (e.g. on x86 devices).
 
-    SPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
+    SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     in the binman README for more information.
 
index db3d8a91c9b0691af7cb3cabdb945d59d99be105..64c2767488daf0b0c15fc78aac843ebbbc413c02 100644 (file)
@@ -21,11 +21,7 @@ class Entry_u_boot_vpl_nodtb(Entry_blob):
     expands to a section containing u-boot-vpl-dtb, u-boot-vpl-bss-pad and
     u-boot-vpl-dtb
 
-    VPL can access binman symbols at runtime. See:
-
-        'Access to binman entry offsets at run time (symbols)'
-
-    in the binman README for more information.
+    VPL can access binman symbols at runtime. See :ref:`binman_fdt`.
 
     The ELF file 'vpl/u-boot-vpl' must also be available for this to work, since
     binman uses that to look up symbols to write into the VPL binary.