Remove the initial _2 component in the examples in order to match what
linker_lists.h now does. This also makes the
Note the two '_2_' constant components in the names
easier to grok, as there is now only one such component.
Remove the whole "Start and end symbols for the whole of the linker
lists area can be defined as" paragraph, since that can no longer be
done like that, and the (never used) macros doing it were removed in
e2138cf1e60 ("linker_lists.h: drop never used ll_start, ll_end
macros").
Leave the occurrences in the "Alignment issues" subsection alone for
now. They are verbatim copies from a u-boot.map file, and it would not
be right to edit that long after the fact, when we cannot easily
reproduce a u-boot.map exhibiting this phenomenon.
Part of the purpose of this series is to get a better handle on
alignment issues once and for all, so hopefully we can simply remove
the whole subsection in a not too distant future.
Signed-off-by: Rasmus Villemoes <[email protected]>
---
doc/api/linker_lists.rst | 54 +++++++++++++++++-----------------------
1 file changed, 23 insertions(+), 31 deletions(-)
diff --git a/doc/api/linker_lists.rst b/doc/api/linker_lists.rst
index 9e6849d5e75..3f7a982c518 100644
--- a/doc/api/linker_lists.rst
+++ b/doc/api/linker_lists.rst
@@ -13,13 +13,13 @@ then the corresponding input section name is
::
- __u_boot_list_ + 2_ + @_list + _2_ + @_entry
+ __u_boot_list_ + @_list + _2_ + @_entry
and the C variable name is
::
- _u_boot_list + _2_ + @_list + _2_ + @_entry
+ _u_boot_list + @_list + _2_ + @_entry
This ensures uniqueness for both input section and C variable name.
@@ -30,7 +30,7 @@ to as
::
- %u_boot_list_ + 2_ + @_list + _2_ + @_entry
+ %u_boot_list_ + @_list + _2_ + @_entry
Entry variables need never be referred to directly.
@@ -46,16 +46,8 @@ Start and end symbols for a list can generally be defined as
::
- %u_boot_list_2_ + @_list + _1_...
- %u_boot_list_2_ + @_list + _3_...
-
-Start and end symbols for the whole of the linker lists area can be
-defined as
-
-::
-
- %u_boot_list_1_...
- %u_boot_list_3_...
+ %u_boot_list_ + @_list + _1_...
+ %u_boot_list_ + @_list + _3_...
Here is an example of the sorted sections which result from a list
"array" made up of three entries : "first", "second" and "third",
@@ -63,11 +55,11 @@ iterated at least once.
::
- __u_boot_list_2_array_1
- __u_boot_list_2_array_2_first
- __u_boot_list_2_array_2_second
- __u_boot_list_2_array_2_third
- __u_boot_list_2_array_3
+ __u_boot_list_array_1
+ __u_boot_list_array_2_first
+ __u_boot_list_array_2_second
+ __u_boot_list_array_2_third
+ __u_boot_list_array_3
If lists must be divided into sublists (e.g. for iterating only on
part of a list), one can simply give the list a name of the form
@@ -82,19 +74,19 @@ defined for the whole list and each sub-list:
::
- %u_boot_list_2_drivers_1
- %u_boot_list_2_drivers_2_i2c_1
- %u_boot_list_2_drivers_2_i2c_2_first
- %u_boot_list_2_drivers_2_i2c_2_first
- %u_boot_list_2_drivers_2_i2c_2_second
- %u_boot_list_2_drivers_2_i2c_2_third
- %u_boot_list_2_drivers_2_i2c_3
- %u_boot_list_2_drivers_2_pci_1
- %u_boot_list_2_drivers_2_pci_2_first
- %u_boot_list_2_drivers_2_pci_2_second
- %u_boot_list_2_drivers_2_pci_2_third
- %u_boot_list_2_drivers_2_pci_3
- %u_boot_list_2_drivers_3
+ %u_boot_list_drivers_1
+ %u_boot_list_drivers_2_i2c_1
+ %u_boot_list_drivers_2_i2c_2_first
+ %u_boot_list_drivers_2_i2c_2_first
+ %u_boot_list_drivers_2_i2c_2_second
+ %u_boot_list_drivers_2_i2c_2_third
+ %u_boot_list_drivers_2_i2c_3
+ %u_boot_list_drivers_2_pci_1
+ %u_boot_list_drivers_2_pci_2_first
+ %u_boot_list_drivers_2_pci_2_second
+ %u_boot_list_drivers_2_pci_2_third
+ %u_boot_list_drivers_2_pci_3
+ %u_boot_list_drivers_3
Alignment issues
----------------
--
2.54.0
