doc: kernel: Improved reloc text formatting
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:
parent
117dca089a
commit
5dbd364954
1 changed files with 10 additions and 10 deletions
|
@ -74,30 +74,30 @@ for data copy operations from ROM to required memory type.
|
|||
Additional Configurations
|
||||
=========================
|
||||
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
|
||||
sections for example:
|
||||
* If the memory is ``SRAM1``, ``SRAM2``, ``CCD``, or ``AON``, then place the
|
||||
full object in the sections. For example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2)
|
||||
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM)
|
||||
|
||||
* if the memory type is appended with _DATA, _TEXT, _RODATA or _BSS, only the
|
||||
selected memory is placed in the required memory region.
|
||||
for example:
|
||||
* If the memory type is appended with ``_DATA``, ``_TEXT``, ``_RODATA`` or
|
||||
``_BSS``, only the selected memory is placed in the required memory region.
|
||||
For example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2_DATA)
|
||||
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM2_TEXT)
|
||||
|
||||
* Multiple regions can also be appended together such as: SRAM2_DATA_BSS.
|
||||
This will place data and bss inside SRAM2.
|
||||
* Multiple regions can also be appended together such as: ``SRAM2_DATA_BSS``.
|
||||
This will place data and bss inside ``SRAM2``.
|
||||
|
||||
* Multiple files can be passed to the FILES argument, or CMake generator
|
||||
expressions can be used to relocate a comma-separated list of files
|
||||
* Multiple files can be passed to the ``FILES`` argument, or CMake generator
|
||||
expressions can be used to relocate a comma-separated list of files.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue