Skip to content

Add module and toolchain-bundled Picolibc synchronisation policy #58006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlescufi merged 4 commits into from
May 25, 2023
Merged

Add module and toolchain-bundled Picolibc synchronisation policy #58006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4671769
doc: toolchains: Add Zephyr SDK version compatibility section
stephanosio May 10, 2023
a534a68
doc: Link a specific Zephyr SDK release instead of the latest
stephanosio May 10, 2023
df3ed3d
doc: Update link to the "Zephyr SDK Releases" page
stephanosio May 10, 2023
95d5f9a
doc: picolibc: Add module and toolchain Picolibc synchronisation policy
stephanosio May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/develop/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,8 +496,8 @@ that are used to emulate, flash and debug Zephyr applications.

.. _ubuntu_zephyr_sdk:

#. Download and verify the `latest Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
#. Download and verify the `Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases/tag/v0.16.1>`_:

.. code-block:: bash

Expand Down Expand Up @@ -553,8 +553,8 @@ that are used to emulate, flash and debug Zephyr applications.

.. _macos_zephyr_sdk:

#. Download and verify the `latest Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
#. Download and verify the `Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases/tag/v0.16.1>`_:

.. code-block:: bash

Expand Down Expand Up @@ -604,8 +604,8 @@ that are used to emulate, flash and debug Zephyr applications.

#. Open a ``cmd.exe`` window by pressing the Windows key typing "cmd.exe".

#. Download the `latest Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
#. Download the `Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases/tag/v0.16.1>`_:

.. code-block:: console

Expand Down
6 changes: 3 additions & 3 deletions doc/develop/getting_started/installation_linux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ The Zephyr SDK supports the following target architectures:

Follow these steps to install the Zephyr SDK:

#. Download and verify the `latest Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_:
#. Download and verify the `Zephyr SDK bundle
<https://github.com/zephyrproject-rtos/sdk-ng/releases/tag/v0.16.1>`_:

.. code-block:: bash

Expand Down Expand Up @@ -317,5 +317,5 @@ To make sure this variable is unset, run:

unset ZEPHYR_SDK_INSTALL_DIR

.. _Zephyr SDK Releases: https://github.com/zephyrproject-rtos/sdk-ng/releases
.. _Zephyr SDK Releases: https://github.com/zephyrproject-rtos/sdk-ng/tags
.. _CMake Downloads: https://cmake.org/download
13 changes: 13 additions & 0 deletions doc/develop/languages/c/picolibc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ the library internal system calls to the equivalent Zephyr API calls.
.. _`C17 (ISO/IEC 9899:2018)`: https://www.iso.org/standard/74528.html
.. _`POSIX 2018 (IEEE Std 1003.1-2017)`: https://pubs.opengroup.org/onlinepubs/9699919799/functions/printf.html

.. _c_library_picolibc_module:

Picolibc Module
===============

Expand All @@ -38,6 +40,12 @@ The Picolibc module can be enabled by selecting
:kconfig:option:`CONFIG_PICOLIBC_USE_MODULE` in the application
configuration file.

When updating the Picolibc module to a newer version, the
:ref:`toolchain-bundled Picolibc in the Zephyr SDK
<c_library_picolibc_toolchain>` must also be updated to the same version.

.. _c_library_picolibc_toolchain:

Toolchain Picolibc
==================

Expand All @@ -49,6 +57,11 @@ The toolchain version of Picolibc can be enabled by de-selecting
:kconfig:option:`CONFIG_PICOLIBC_USE_MODULE` in the application
configuration file.

For every release of Zephyr, the toolchain-bundled Picolibc and the
:ref:`Picolibc module <c_library_picolibc_module>` are guaranteed to be in
sync when using the
:ref:`recommended version of Zephyr SDK <toolchain_zephyr_sdk_compatibility>`.

Formatted Output
****************

Expand Down
22 changes: 17 additions & 5 deletions doc/develop/toolchains/zephyr_sdk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,23 @@ example, you can set ``ZEPHYR_SDK_INSTALL_DIR`` to ``/company/tools``, where the
This allows the Zephyr build system to choose the correct version of the SDK,
while allowing multiple Zephyr SDKs to be grouped together at a specific path.

.. _toolchain_zephyr_sdk_compatibility:

Zephyr SDK version compatibility
********************************

In general, the Zephyr SDK version referenced in this page should be considered
the recommended version for the corresponding Zephyr version.

For the full list of compatible Zephyr and Zephyr SDK versions, refer to the
`Zephyr SDK Version Compatibility Matrix`_.

.. _toolchain_zephyr_sdk_install_linux:

Install Zephyr SDK on Linux
***************************

#. Download and verify the `latest Zephyr SDK bundle`_:
#. Download and verify the `Zephyr SDK bundle`_:

.. code-block:: bash

Expand Down Expand Up @@ -114,7 +125,7 @@ If you relocate the SDK directory, you need to re-run the setup script.
Install Zephyr SDK on macOS
***************************

#. Download and verify the `latest Zephyr SDK bundle`_:
#. Download and verify the `Zephyr SDK bundle`_:

.. code-block:: bash

Expand Down Expand Up @@ -166,7 +177,7 @@ Install Zephyr SDK on Windows

#. Open a ``cmd.exe`` window by pressing the Windows key typing "cmd.exe".

#. Download the `latest Zephyr SDK bundle`_:
#. Download the `Zephyr SDK bundle`_:

.. code-block:: console

Expand Down Expand Up @@ -203,5 +214,6 @@ Install Zephyr SDK on Windows
You must rerun the setup script if you relocate the Zephyr SDK bundle directory after
the initial setup.

.. _latest Zephyr SDK bundle: https://github.com/zephyrproject-rtos/sdk-ng/releases
.. _Zephyr SDK Releases: https://github.com/zephyrproject-rtos/sdk-ng/releases
.. _Zephyr SDK bundle: https://github.com/zephyrproject-rtos/sdk-ng/releases/tag/v0.16.1
.. _Zephyr SDK Releases: https://github.com/zephyrproject-rtos/sdk-ng/tags
.. _Zephyr SDK Version Compatibility Matrix: https://github.com/zephyrproject-rtos/sdk-ng/wiki/Zephyr-SDK-Version-Compatibility-Matrix