Skip to content

Commit 7e00170

Browse files
AlexFabrenashif
authored andcommitted
doc: toolchain: ATfE: fix formating
This commit fixe text formatting, removing numbered paragraphs, and adding sub-titled parts. Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
1 parent b234e86 commit 7e00170

File tree

1 file changed

+53
-52
lines changed

1 file changed

+53
-52
lines changed

doc/develop/toolchains/arm_toolchain_for_embedded.rst

Lines changed: 53 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -3,84 +3,85 @@
33
Arm Toolchain for Embedded (ATfE)
44
#################################
55

6-
#. LLVM toolchain by ARM
76

8-
#. Arm Toolchain for Embedded (ATfE) is a C and C++ toolchain from Arm based
9-
on the free and open-source LLVM Compiler Infrastructure and the Picolib C
10-
library for baremetal targets.
7+
Arm Toolchain for Embedded (ATfE) is a C and C++ toolchain from Arm based
8+
on the free and open-source LLVM Compiler Infrastructure and the Picolib C
9+
library for baremetal targets.
1110

12-
#. ATfE is fined-tuned with a particular focus on performance for newer
13-
ARM products (post 2024) like 64-bit Arm Architectures (AArch64),
14-
or the M-Profile Vector Extension (MVE, a 32-bit Armv8.1-M extension).
11+
ATfE is fined-tuned with a particular focus on performance for newer
12+
ARM products (post 2024) like 64-bit Arm Architectures (AArch64),
13+
or the M-Profile Vector Extension (MVE, a 32-bit Armv8.1-M extension).
1514

16-
#. Installation
15+
Installation
16+
************
1717

18-
#. Download and install a `Arm toolchain for embedded`_ build for your operating system
19-
and extract it on your file system.
18+
#. Download and install a `Arm toolchain for embedded`_ build for your operating system
19+
and extract it on your file system.
2020

21-
#. :ref:`Set these environment variables <env_vars>`:
21+
#. :ref:`Set these environment variables <env_vars>`:
2222

23-
- Set :envvar:`ZEPHYR_TOOLCHAIN_VARIANT` to ``llvm``.
24-
- Set :envvar:`LLVM_TOOLCHAIN_PATH` to the toolchain installation directory.
23+
- Set :envvar:`ZEPHYR_TOOLCHAIN_VARIANT` to ``llvm``.
24+
- Set :envvar:`LLVM_TOOLCHAIN_PATH` to the toolchain installation directory.
2525

26-
#. To check that you have set these variables correctly in your current
27-
environment, follow these example shell sessions (the
28-
:envvar:`LLVM_TOOLCHAIN_PATH` values may be different on your system):
26+
#. To check that you have set these variables correctly in your current
27+
environment, follow these example shell sessions (the
28+
:envvar:`LLVM_TOOLCHAIN_PATH` values may be different on your system):
2929

30-
.. tabs::
30+
.. tabs::
3131

32-
.. group-tab:: Ubuntu
32+
.. group-tab:: Ubuntu
3333

34-
.. code-block:: bash
34+
.. code-block:: bash
3535
36-
echo $ZEPHYR_TOOLCHAIN_VARIANT
37-
llvm
38-
echo $LLVM_TOOLCHAIN_PATH
39-
/home/you/Downloads/ATfE
36+
echo $ZEPHYR_TOOLCHAIN_VARIANT
37+
llvm
38+
echo $LLVM_TOOLCHAIN_PATH
39+
/home/you/Downloads/ATfE
4040
41-
.. group-tab:: macOS
41+
.. group-tab:: macOS
4242

43-
.. code-block:: bash
43+
.. code-block:: bash
4444
45-
echo $ZEPHYR_TOOLCHAIN_VARIANT
46-
llvm
47-
echo $LLVM_TOOLCHAIN_PATH
48-
/home/you/Downloads/ATfE
45+
echo $ZEPHYR_TOOLCHAIN_VARIANT
46+
llvm
47+
echo $LLVM_TOOLCHAIN_PATH
48+
/home/you/Downloads/ATfE
4949
50-
.. group-tab:: Windows
50+
.. group-tab:: Windows
5151

52-
.. code-block:: powershell
52+
.. code-block:: powershell
5353
54-
> echo %ZEPHYR_TOOLCHAIN_VARIANT%
55-
llvm
56-
> echo %LLVM_TOOLCHAIN_PATH%
57-
C:\ATfE
54+
> echo %ZEPHYR_TOOLCHAIN_VARIANT%
55+
llvm
56+
> echo %LLVM_TOOLCHAIN_PATH%
57+
C:\ATfE
5858
59-
.. _toolchain_env_var:
59+
.. _toolchain_env_var:
6060

61-
#. You can also set ``ZEPHYR_TOOLCHAIN_VARIANT`` and ``LLVM_TOOLCHAIN_PATH`` as CMake
62-
variables when generating a build system for a Zephyr application, like so:
61+
#. You can also set ``ZEPHYR_TOOLCHAIN_VARIANT`` and ``LLVM_TOOLCHAIN_PATH`` as CMake
62+
variables when generating a build system for a Zephyr application, like so:
6363

64-
.. code-block:: console
64+
.. code-block:: console
6565
66-
west build ... -- -DZEPHYR_TOOLCHAIN_VARIANT=llvm -DLLVM_TOOLCHAIN_PATH=...
66+
west build ... -- -DZEPHYR_TOOLCHAIN_VARIANT=llvm -DLLVM_TOOLCHAIN_PATH=...
6767

68-
#. Toolchain settings
68+
Toolchain settings
69+
******************
6970

70-
#. Because LLVM is widely compatible with GNU tools, When builiding with any
71-
LLVM toolchain, you have to specify some settings to let the compiler
72-
know what tools to use:
71+
Because LLVM is widely compatible with GNU tools, When builiding with any
72+
LLVM toolchain, you have to specify some settings to let the compiler
73+
know what tools to use:
7374

74-
#. Linker:
75-
Set :envvar:`CONFIG_LLVM_USE_LLD=y` to use LLVM linker.
76-
set :envvar:`CONFIG_LLVM_USE_LD=y` to use the GNU LD linker.
75+
Linker:
76+
Set :envvar:`CONFIG_LLVM_USE_LLD=y` to use LLVM linker.
77+
set :envvar:`CONFIG_LLVM_USE_LD=y` to use the GNU LD linker.
7778

78-
#. Runtime library:
79-
Set :envvar:`CONFIG_COMPILER_RT_RTLIB=y` to use LLVM runtime library.
80-
Set :envvar:`CONFIG_LIBGCC_RTLIB=y` to use LibGCC runtime library.
79+
Runtime library:
80+
Set :envvar:`CONFIG_COMPILER_RT_RTLIB=y` to use LLVM runtime library.
81+
Set :envvar:`CONFIG_LIBGCC_RTLIB=y` to use LibGCC runtime library.
8182

82-
.. code-block:: console
83+
.. code-block:: console
8384
84-
west build ... -- -DZEPHYR_TOOLCHAIN_VARIANT=llvm -DLLVM_TOOLCHAIN_PATH=... -DCONFIG_LLVM_USE_LLD=y -DCONFIG_COMPILER_RT_RTLIB=y
85+
west build ... -- -DZEPHYR_TOOLCHAIN_VARIANT=llvm -DLLVM_TOOLCHAIN_PATH=... -DCONFIG_LLVM_USE_LLD=y -DCONFIG_COMPILER_RT_RTLIB=y
8586
8687
.. _Arm Toolchain for Embedded: https://developer.arm.com/Tools%20and%20Software/Arm%20Toolchain%20for%20Embedded

0 commit comments

Comments
 (0)