michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kernel: Improved reloc text formatting

Browse source 
This patch improves the formatting of the "Additional Configurations"
section of the "Code And Data Relocation" document.

Signed-off-by: Joel Holdsworth <jholdsworth@nvidia.com>
This commit is contained in:
Joel Holdsworth 2025-05-23 09:20:54 -07:00 • committed by Fabio Baltieri
commit 5dbd364954
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/kernel/code-relocation.rst
View file

@ -74,30 +74,30 @@ for data copy operations from ROM to required memory type.
Additional Configurations Additional Configurations
========================= =========================
This section shows additional configuration options that can be set in This section shows additional configuration options that can be set in
``CMakeLists.txt`` ``CMakeLists.txt``.
* if the memory is SRAM1, SRAM2, CCD, or AON, then place the full object in the * If the memory is ``SRAM1``, ``SRAM2``, ``CCD``, or ``AON``, then place the
sections for example: full object in the sections. For example:
.. code-block:: none .. code-block:: none
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2) zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2)
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM) zephyr_code_relocate(FILES src/file2.c LOCATION SRAM)
* if the memory type is appended with _DATA, _TEXT, _RODATA or _BSS, only the * If the memory type is appended with ``_DATA``, ``_TEXT``, ``_RODATA`` or
selected memory is placed in the required memory region. ``_BSS``, only the selected memory is placed in the required memory region.
for example: For example:
.. code-block:: none .. code-block:: none
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2_DATA) zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2_DATA)
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM2_TEXT) zephyr_code_relocate(FILES src/file2.c LOCATION SRAM2_TEXT)
* Multiple regions can also be appended together such as: SRAM2_DATA_BSS. * Multiple regions can also be appended together such as: ``SRAM2_DATA_BSS``.
This will place data and bss inside SRAM2. This will place data and bss inside ``SRAM2``.
* Multiple files can be passed to the FILES argument, or CMake generator * Multiple files can be passed to the ``FILES`` argument, or CMake generator
expressions can be used to relocate a comma-separated list of files expressions can be used to relocate a comma-separated list of files.
.. code-block:: none .. code-block:: none