Skip to content

Commit 64ab132

Browse files
Marti Bolivarnashif
authored andcommitted
getting_started: fixes and cleanups for installation_linux
Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <[email protected]>
1 parent 9ca4d84 commit 64ab132

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

doc/getting_started/installation_linux.rst

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ debugging ARM Cortex-M microcontrollers, use this command::
7878
pip2 install --user -r scripts/py2-requirements.txt
7979

8080
CMake version 3.8.2 or higher is required. Check what version you have using
81-
``cmake --version``, and if its an older version, check the backports or
81+
``cmake --version``; if you have an older version, check the backports or
8282
install a more recent version manually. For example, to install version
8383
3.8.2 from the CMake website directly in ~/cmake::
8484

@@ -96,8 +96,8 @@ Installing the Zephyr Software Development Kit
9696

9797
Zephyr's :abbr:`SDK (Software Development Kit)` contains all necessary tools
9898
and cross-compilers needed to build the kernel on all supported
99-
architectures. Additionally, it includes host tools such as a custom QEMU and
100-
a host compiler for building host tools if necessary. The SDK supports the
99+
architectures. Additionally, it includes host tools such as custom QEMU binaries
100+
and a host compiler for building host tools if necessary. The SDK supports the
101101
following architectures:
102102

103103
* :abbr:`X86 (Intel Architecture 32 bits)`
@@ -108,55 +108,49 @@ following architectures:
108108

109109
* :abbr:`ARC (Argonaut RISC Core)`
110110

111-
* :abbr:`NIOS II`
111+
* :abbr:`Nios II`
112112

113113
* :abbr:`Xtensa`
114114

115115
* :abbr:`RISC-V`
116116

117117
Follow these steps to install the SDK on your Linux host system.
118118

119-
#. Download the latest SDK self-extractable binary.
120-
121-
Visit the `Zephyr SDK archive`_ to find all available SDK versions,
122-
including the latest version.
123-
124-
Alternatively, you can use the following command to download the
125-
desired version (*0.9.3* can be replaced with the version number you
126-
wish to download).
119+
#. Download the latest SDK as a self-extracting installation binary:
127120

128121
.. code-block:: console
129122
130123
wget https://github.com/zephyrproject-rtos/meta-zephyr-sdk/releases/download/0.9.3/zephyr-sdk-0.9.3-setup.run
131124
132-
#. Run the installation binary, follow this example:
125+
(You can change *0.9.3* to another version if needed; the `Zephyr
126+
Downloads`_ page contains all available SDK releases.)
133127

134-
.. important::
135-
Make sure you have installed all required packages for your host
136-
distribution as described in the previous section
137-
`Installing Requirements and Dependencies`_ otherwise the SDK installation will fail.
128+
#. Run the installation binary:
138129

139130
.. code-block:: console
140131
141-
sh zephyr-sdk-<version>-setup.run
132+
sh zephyr-sdk-0.9.3-setup.run
133+
134+
.. important::
135+
If this fails, make sure Zephyr's dependencies were installed
136+
as described in `Installing Requirements and Dependencies`_.
142137

143-
There is no need to use ``sudo`` if the SDK is installed in the current
144-
user's home directory.
138+
#. Follow the installation instructions on the screen. The toolchain's
139+
default installation location is :file:`/opt/zephyr-sdk/`, but it
140+
is recommended to install the SDK under your home directory instead.
145141

146-
#. Follow the installation instructions on the screen. The
147-
toolchain's default installation location is :file:`/opt/zephyr-sdk/`.
148-
To install in the default installation location, you will need to use sudo. It is recommended
149-
to install the SDK in your home directory and not in a system directory.
142+
To install the SDK in the default location, you need to run the
143+
installation binary as root.
150144

151145
#. To use the Zephyr SDK, export the following environment variables and
152-
use the target location where SDK was installed, type:
146+
use the target location where SDK was installed:
153147

154148
.. code-block:: console
155149
156150
export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
157151
export ZEPHYR_SDK_INSTALL_DIR=<sdk installation directory>
158152
159-
To use the same toolchain in new sessions in the future you can set the
153+
To use the same toolchain in new sessions in the future, you can set the
160154
variables in the file :file:`${HOME}/.zephyrrc`, for example:
161155

162156
.. code-block:: console
@@ -169,5 +163,5 @@ Follow these steps to install the SDK on your Linux host system.
169163
.. note:: In previous releases of Zephyr, the ``ZEPHYR_TOOLCHAIN_VARIANT``
170164
variable was called ``ZEPHYR_GCC_VARIANT``.
171165

172-
.. _Zephyr SDK archive:
166+
.. _Zephyr Downloads:
173167
https://www.zephyrproject.org/developers/#downloads

0 commit comments

Comments
 (0)