michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/getting_started/installation_linux.rst

235 lines
7.2 KiB
ReStructuredText
Raw Normal View History

doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
.. _installation_linux:
Development Environment Setup on Linux
######################################
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
.. important::
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
This section only describes OS-specific setup instructions; it is the first step in the
complete Zephyr :ref:`getting_started`.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
This section describes how to set up a Zephyr development environment on the
following Linux distributions:
* Ubuntu 16.04 LTS or 18.04 LTS 64-bit
* Fedora 28 64-bit
doc: getting_started: add instructions to build on Clear Linux This expands the Development Environment Setup on Linux guide to include instructions for Clear Linux. Tested on Clear Linux build 23610. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-07-10 13:33:06 -07:00
* Clear Linux
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
* Arch Linux
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Where needed, instructions are given which only apply to specific Linux
doc: getting_started: add instructions to build on Clear Linux This expands the Development Environment Setup on Linux guide to include instructions for Clear Linux. Tested on Clear Linux build 23610. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-07-10 13:33:06 -07:00
distributions.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
Update Your Operating System
****************************
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Ensure your host system is up to date before proceeding.
On Ubuntu:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
.. code-block:: console
doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-17 17:32:31 +01:00
sudo apt-get update
sudo apt-get upgrade
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
On Fedora:
.. code-block:: console
doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-17 17:32:31 +01:00
sudo dnf upgrade
doc: update linux update/upgrade instructions Linux package update/upgrade instuctions were incomplete (on Ubuntu the instructions updated the local database but didn't actually do the upgrade). On Fedora, the dnf update command was deprecated in favor of dnf upgrade. Change-Id: I83e126cf924d9c3720fcfb77b0d5abda943a6af5 Jira: ZEP-516 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-08-01 10:08:04 -07:00
Note that having a newer version available for an installed package
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
(as reported by ``dnf check-update``) does not imply a subsequent
doc: update linux update/upgrade instructions Linux package update/upgrade instuctions were incomplete (on Ubuntu the instructions updated the local database but didn't actually do the upgrade). On Fedora, the dnf update command was deprecated in favor of dnf upgrade. Change-Id: I83e126cf924d9c3720fcfb77b0d5abda943a6af5 Jira: ZEP-516 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-08-01 10:08:04 -07:00
``dnf upgrade`` will install it, because it must also ensure dependencies
and other restrictions are satisfied.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: getting_started: add instructions to build on Clear Linux This expands the Development Environment Setup on Linux guide to include instructions for Clear Linux. Tested on Clear Linux build 23610. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-07-10 13:33:06 -07:00
On Clear Linux:
.. code-block:: console
sudo swupd update
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
On Arch Linux:
.. code-block:: console
sudo pacman -Syu
doc: Add anchor in Getting Started Add an anchor in the Getting Started topic to be able to link to the requirements section. Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2018-12-07 08:31:21 +01:00
.. _linux_requirements:
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Install Requirements and Dependencies
*************************************
.. NOTE FOR DOCS AUTHORS: DO NOT PUT DOCUMENTATION BUILD DEPENDENCIES HERE.
This section is for dependencies to build Zephyr binaries, *NOT* this
documentation. If you need to add a dependency only required for building
the docs, add it to doc/README.rst. (This change was made following the
introduction of LaTeX->PDF support for the docs, as the texlive footprint is
massive and not needed by users not building PDF documentation.)
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Install the following packages using your system's package manager. Note that
both Ninja and Make are installed; you may prefer only to install one.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
On Ubuntu:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
.. code-block:: console
doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-17 17:32:31 +01:00
sudo apt-get install --no-install-recommends git cmake ninja-build gperf \
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
ccache dfu-util device-tree-compiler wget \
doc: Linux installation: Add gcc and gcc_mulitlib for Ubuntu In 0d811b9aee6a6410f73fdfb4d4072d4d16b05a52 the gcc-mulitlib package was removed from the Ubuntu list of packages to install. Seems this may be creating some confusion for some developers (see comments in #10243) Let's add it back. Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2018-10-30 11:57:34 +01:00
python3-pip python3-setuptools python3-wheel xz-utils file make gcc \
gcc-multilib
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
On Fedora:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
.. code-block:: console
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
doc: update package dependencies for Linux We now require host compiler for building Zephyr in 32bit mode. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-02-05 20:34:35 -06:00
sudo dnf group install "Development Tools" "C Development Tools and Libraries"
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
dnf install git cmake ninja-build gperf ccache dfu-util dtc wget \
python3-pip xz file glibc-devel.i686 libstdc++-devel.i686
doc: add python pip requirements.txt List all required modules in one file and just call pip with this file to install all needed modules instead of listing them individually. Added gitlint and pyocd and other required packages to the list. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-07-14 17:35:20 +03:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
On Clear Linux:
doc: getting_started: add instructions to build on Clear Linux This expands the Development Environment Setup on Linux guide to include instructions for Clear Linux. Tested on Clear Linux build 23610. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-07-10 13:33:06 -07:00
.. code-block:: console
sudo swupd bundle-add c-basic dev-utils dfu-util dtc \
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
os-core-dev python-basic python3-basic
doc: getting_started: add instructions to build on Clear Linux This expands the Development Environment Setup on Linux guide to include instructions for Clear Linux. Tested on Clear Linux build 23610. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-07-10 13:33:06 -07:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
On Arch:
.. code-block:: console
doc: add python pip requirements.txt List all required modules in one file and just call pip with this file to install all needed modules instead of listing them individually. Added gitlint and pyocd and other required packages to the list. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-07-14 17:35:20 +03:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
sudo pacman -S git cmake ninja gperf ccache dfu-util dtc wget \
python-pip python-setuptools python-wheel xz file make
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
cmake: increase minimal required version to 3.13.1 Move to latest cmake version with many bug fixes and enhancements. Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-12-11 10:33:23 -05:00
.. important::
Zephyr requires a recent version of CMake. Read through
the rest of the section below to verify the version you have
installed is recent enough to build Zephyr.
CMake version 3.13.1 or higher is required. Check what version you have by using
``cmake --version``. If you have an older version, there are several ways
of obtaining a more recent one:
* Use ``pip``:
.. code-block:: console
pip3 install --user cmake
doc: update with CMake instructions Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-31 08:35:24 -04:00
cmake: increase minimal required version to 3.13.1 Move to latest cmake version with many bug fixes and enhancements. Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-12-11 10:33:23 -05:00
* Download and install from the pre-built binaries provided by the CMake
project itself in the `CMake Downloads`_ page.
For example, to install version 3.13.1 in :file:`~/bin/cmake`:
.. code-block:: console
mkdir $HOME/bin/cmake && cd $HOME/bin/cmake
wget https://github.com/Kitware/CMake/releases/download/v3.13.1/cmake-3.13.1-Linux-x86_64.sh
yes | sh cmake-3.13.1-Linux-x86_64.sh | cat
echo "export PATH=$PWD/cmake-3.13.1-Linux-x86_64/bin:\$PATH" >> $HOME/.zephyrrc
* Check your distribution's beta or unstable release package library for an
update.
.. note::
If you have installed a recent version of CMake using one of the approaches
listed above, you might want to uninstall the one provided by your
distribution's package manager (``apt``, ``dnf``, ``swupd``, ``pacman``,
etc.) in order to avoid version conflicts.
doc: update with CMake instructions Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-10-31 08:35:24 -04:00
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
.. _zephyr_sdk:
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Install the Zephyr Software Development Kit (SDK)
*************************************************
.. note::
Use of the Zephyr SDK is optional, but recommended. Some of the requirements
and dependencies in the previous section are only needed for installing the
SDK.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
Zephyr's :abbr:`SDK (Software Development Kit)` contains all necessary tools
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
and cross-compilers needed to build Zephyr on all supported
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
architectures. Additionally, it includes host tools such as custom QEMU binaries
and a host compiler for building host tools if necessary. The SDK supports the
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
following target architectures:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: add note about order of SDK installation Jira: ZEP-1479 Change-Id: Ie3f7eb1e7ce8f245f1e54193a30a52cf552315cd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-20 09:45:09 -05:00
* :abbr:`X86 (Intel Architecture 32 bits)`
* :abbr:`X86 IAMCU ABI (Intel Architecture 32 bits IAMCU ABI)`
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
* :abbr:`Arm (Advanced RISC Machine)`
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
* :abbr:`ARC (Argonaut RISC Core)`
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
* :abbr:`Nios II`
doc: add note about order of SDK installation Jira: ZEP-1479 Change-Id: Ie3f7eb1e7ce8f245f1e54193a30a52cf552315cd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-20 09:45:09 -05:00
doc: also require dtc to be installed for linux Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-05-30 20:43:40 -04:00
* :abbr:`Xtensa`
doc: Add RISC-V to a list of SDK-supported ISA's Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-09-18 15:49:58 +02:00
* :abbr:`RISC-V`
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
Follow these steps to install the SDK on your Linux host system.
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
#. Download the latest SDK as a self-extracting installation binary:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
docs: Getting Started overhaul - Put everything in one page and simplify workflow. - Fix indent and layout Change-Id: Ifd9d11531c9b906324cf87cf401cbce416cc01a4 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-13 07:41:34 -05:00
.. code-block:: console
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: update docs with latest SDK Changed documentation to point to SDK 0.9.4. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 15:36:40 -04:00
wget https://github.com/zephyrproject-rtos/meta-zephyr-sdk/releases/download/0.9.5/zephyr-sdk-0.9.5-setup.run
doc: Remove SDK specific version numbers. Removes the specific version number of SDK installation example commands. Specific version numbers becomes frequently outdated. Change-Id: I6fc368b30a5fe7899f6a2fc979f469e2b3cd9f72 Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
2016-03-15 13:16:06 -06:00
doc: update docs with latest SDK Changed documentation to point to SDK 0.9.4. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 15:36:40 -04:00
(You can change *0.9.5* to another version if needed; the `Zephyr
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
Downloads`_ page contains all available SDK releases.)
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
#. Run the installation binary:
doc: add note about order of SDK installation Jira: ZEP-1479 Change-Id: Ie3f7eb1e7ce8f245f1e54193a30a52cf552315cd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-20 09:45:09 -05:00
docs: Getting Started overhaul - Put everything in one page and simplify workflow. - Fix indent and layout Change-Id: Ifd9d11531c9b906324cf87cf401cbce416cc01a4 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-13 07:41:34 -05:00
.. code-block:: console
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
Doc: installation_linux.rst: Feedback Updates Modified the web page to make it direct and easier to understand. Major changes being the selection of the directory in the Zephyr SDK Installation and a Note added for the '.zephyrrc' to include the SDK installation location if not default. Minor changes involving the elimination of repeated use of same sentence with different Host OS and indentation correction in the Fedora section since it showed up in 'white text' rather than code block. SDK's '.zephyrrc' documentation needed to have the default location and the user defined location Signed-off-by: Arjun Warty <arjun.warty@nxp.com>
2018-07-24 13:33:30 -05:00
cd <sdk download directory>
doc: update docs with latest SDK Changed documentation to point to SDK 0.9.4. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 15:36:40 -04:00
sh zephyr-sdk-0.9.5-setup.run
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
.. important::
If this fails, make sure Zephyr's dependencies were installed
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
as described in `Install Requirements and Dependencies`_.
doc: Remove SDK specific version numbers. Removes the specific version number of SDK installation example commands. Specific version numbers becomes frequently outdated. Change-Id: I6fc368b30a5fe7899f6a2fc979f469e2b3cd9f72 Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
2016-03-15 13:16:06 -06:00
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
#. Follow the installation instructions on the screen. The toolchain's
default installation location is :file:`/opt/zephyr-sdk/`, but it
is recommended to install the SDK under your home directory instead.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
To install the SDK in the default location, you need to run the
installation binary as root.
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
#. To use the Zephyr SDK, export the following environment variables and
getting_started: fixes and cleanups for installation_linux Miscellaneous fixes and concision improvements. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2018-05-31 15:28:07 -04:00
use the target location where SDK was installed:
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
docs: Getting Started overhaul - Put everything in one page and simplify workflow. - Fix indent and layout Change-Id: Ifd9d11531c9b906324cf87cf401cbce416cc01a4 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-13 07:41:34 -05:00
.. code-block:: console
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
build: deprecate ZEPHYR_GCC_VARIANT We want to support other toolchain not based on GCC, so the variable is confusing, use ZEPHYR_TOOLCHAIN_VARIANT instead. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-02-11 14:36:21 -06:00
export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-17 17:32:31 +01:00
export ZEPHYR_SDK_INSTALL_DIR=<sdk installation directory>
doc: Refactor the Quick Start Guide. Restructured the guide to follow a basic three step process: Set up, develop, build. All information that is independent of the OS selection was taken out of of the OS related documents and placed in the general set up sections. A new section, Developing Zephyr Applications, was added with links to all the development relevant section of the documentation. The content in local_development.rst was split between the setting_up.rst, installation_linux.rst and installation_mac.rst files as appropriate. This new structure provides a much better flow for developers beginning their Zephyr develpment. Applied all of Inaky's suggestions in the refactored content. Minor markup fixes and language edits were also perfomed during the refactoring. Fixed a cross-reference that was broken during the refactor. Applied all the feedback from the first trial run. Applied the feedback provided by David Kinder from TCS. Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-28 10:59:49 -06:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
.. _sdkless_builds:
Use .zephyrrc for initializing common variables The file can be used to define variables used by the SDK to avoid having to define them everytime a session is started. The old file names ~/zephyr-env_install.bash will still work but it will warn about the file being renamed. We do not want to break users who have ~/zephyr-env_install.bash in their home and depend on it. Change-Id: I04fcaa76854bda3dcfc1cabe75e00e95c511b10d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-12 22:24:47 -05:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
Building on Linux without the Zephyr SDK
****************************************
Use .zephyrrc for initializing common variables The file can be used to define variables used by the SDK to avoid having to define them everytime a session is started. The old file names ~/zephyr-env_install.bash will still work but it will warn about the file being renamed. We do not want to break users who have ~/zephyr-env_install.bash in their home and depend on it. Change-Id: I04fcaa76854bda3dcfc1cabe75e00e95c511b10d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-12 22:24:47 -05:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
The Zephyr SDK is provided for convenience and ease of use. It provides
toolchains for all Zephyr target architectures, and does not require any extra
flags when building applications or running tests. In addition to
cross-compilers, the Zephyr SDK also provides prebuilt host tools. It is,
however, possible to build without the SDK's toolchain by using another
toolchain as as described in the main :ref:`getting_started` document.
Use .zephyrrc for initializing common variables The file can be used to define variables used by the SDK to avoid having to define them everytime a session is started. The old file names ~/zephyr-env_install.bash will still work but it will warn about the file being renamed. We do not want to break users who have ~/zephyr-env_install.bash in their home and depend on it. Change-Id: I04fcaa76854bda3dcfc1cabe75e00e95c511b10d Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-12 22:24:47 -05:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
As already noted above, the SDK also includes prebuilt host tools. To use the
SDK's prebuilt host tools with a toolchain from another source, keep the
:envvar:`ZEPHYR_SDK_INSTALL_DIR` environment variable set to the Zephyr SDK
installation directory. To build without the Zephyr SDK's prebuilt host tools,
the :envvar:`ZEPHYR_SDK_INSTALL_DIR` environment variable must be unset before
you run ``source zephyr-env.sh`` later on in the Getting Started Guide.
Doc: installation_linux.rst: Feedback Updates Modified the web page to make it direct and easier to understand. Major changes being the selection of the directory in the Zephyr SDK Installation and a Note added for the '.zephyrrc' to include the SDK installation location if not default. Minor changes involving the elimination of repeated use of same sentence with different Host OS and indentation correction in the Fedora section since it showed up in 'white text' rather than code block. SDK's '.zephyrrc' documentation needed to have the default location and the user defined location Signed-off-by: Arjun Warty <arjun.warty@nxp.com>
2018-07-24 13:33:30 -05:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
To make sure this variable is unset, run:
.. code-block:: console
Doc: installation_linux.rst: Feedback Updates Modified the web page to make it direct and easier to understand. Major changes being the selection of the directory in the Zephyr SDK Installation and a Note added for the '.zephyrrc' to include the SDK installation location if not default. Minor changes involving the elimination of repeated use of same sentence with different Host OS and indentation correction in the Fedora section since it showed up in 'white text' rather than code block. SDK's '.zephyrrc' documentation needed to have the default location and the user defined location Signed-off-by: Arjun Warty <arjun.warty@nxp.com>
2018-07-24 13:33:30 -05:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
unset ZEPHYR_SDK_INSTALL_DIR
doc: getting_started: Remove redundant and erronous doc's The 'getting started' documentation is stating that one should set some environment variables, but this is not necessary because the user has already been instructed to set the variables in the platform-specific guides. The duplicated documentation should be removed because it is inferiour to the original documentation. E.g. this documentation does not describe how to permanently set environment variables. Also, it is confusingly demonstrating how to use the SDK on Windows, but this is not supported. I believe that the purpose of the section is to verify that the user has not misconfigured or misinstalled the toolchain, but this responsibility is handled better by CMake itself. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2018-05-15 13:14:39 +02:00
doc: overhaul getting_started The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
2018-10-14 23:20:24 -06:00
.. _Zephyr Downloads: https://www.zephyrproject.org/developers/#downloads
cmake: increase minimal required version to 3.13.1 Move to latest cmake version with many bug fixes and enhancements. Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-12-11 10:33:23 -05:00
.. _CMake Downloads: https://cmake.org/download
Copy permalink