Skip to content

Commit 5dbd364

Browse files
jholfabiobaltieri
authored andcommitted
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>
1 parent 117dca0 commit 5dbd364

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/kernel/code-relocation.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,30 +74,30 @@ for data copy operations from ROM to required memory type.
7474
Additional Configurations
7575
=========================
7676
This section shows additional configuration options that can be set in
77-
``CMakeLists.txt``
77+
``CMakeLists.txt``.
7878

79-
* if the memory is SRAM1, SRAM2, CCD, or AON, then place the full object in the
80-
sections for example:
79+
* If the memory is ``SRAM1``, ``SRAM2``, ``CCD``, or ``AON``, then place the
80+
full object in the sections. For example:
8181

8282
.. code-block:: none
8383
8484
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2)
8585
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM)
8686
87-
* if the memory type is appended with _DATA, _TEXT, _RODATA or _BSS, only the
88-
selected memory is placed in the required memory region.
89-
for example:
87+
* If the memory type is appended with ``_DATA``, ``_TEXT``, ``_RODATA`` or
88+
``_BSS``, only the selected memory is placed in the required memory region.
89+
For example:
9090

9191
.. code-block:: none
9292
9393
zephyr_code_relocate(FILES src/file1.c LOCATION SRAM2_DATA)
9494
zephyr_code_relocate(FILES src/file2.c LOCATION SRAM2_TEXT)
9595
96-
* Multiple regions can also be appended together such as: SRAM2_DATA_BSS.
97-
This will place data and bss inside SRAM2.
96+
* Multiple regions can also be appended together such as: ``SRAM2_DATA_BSS``.
97+
This will place data and bss inside ``SRAM2``.
9898

99-
* Multiple files can be passed to the FILES argument, or CMake generator
100-
expressions can be used to relocate a comma-separated list of files
99+
* Multiple files can be passed to the ``FILES`` argument, or CMake generator
100+
expressions can be used to relocate a comma-separated list of files.
101101

102102
.. code-block:: none
103103

0 commit comments

Comments
 (0)