text stringlengths 9 39.2M | dir stringlengths 25 226 | lang stringclasses 163
values | created_date timestamp[s] | updated_date timestamp[s] | repo_name stringclasses 751
values | repo_full_name stringclasses 752
values | star int64 1.01k 183k | len_tokens int64 1 18.5M |
|---|---|---|---|---|---|---|---|---|
```restructuredtext
:orphan:
.. _zephyr_2.7:
Zephyr 2.7.0
############
We are pleased to announce the release of Zephyr RTOS version 2.7.0 (LTS2).
Major enhancements since v2.6.0 include:
* Bluetooth Audio, Direction Finding, and Mesh improvements
* Support for Bluetooth Advertisement PDU Chaining
* Added support ... | /content/code_sandbox/doc/releases/release-notes-2.7.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 32,711 |
```restructuredtext
:orphan:
.. _zephyr_2.6:
Zephyr 2.6.0
############
We are pleased to announce the release of Zephyr RTOS version 2.6.0.
Major enhancements with this release include:
* Logging subsystem overhauled
* Added support for 64-bit ARCv3
* Split ARM32 and ARM64, ARM64 is now a top-level architecture
* ... | /content/code_sandbox/doc/releases/release-notes-2.6.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 39,889 |
```restructuredtext
:orphan:
.. _zephyr_4.0:
Zephyr 4.0.0 (Working Draft)
############################
We are pleased to announce the release of Zephyr version 4.0.0.
Major enhancements with this release include:
An overview of the changes required or recommended when migrating your application from Zephyr
v3.7.0 ... | /content/code_sandbox/doc/releases/release-notes-4.0.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,107 |
```restructuredtext
:orphan:
.. _zephyr_1.9:
Zephyr Kernel 1.9.2
###################
This is a maintenance release with fixes.
Kernel
******
* Generic queue item acquisition fixed to always return a valid item when
using K_FOREVER
Bluetooth
*********
* Multiple stability fixes for BLE Mesh
* Multiple stability f... | /content/code_sandbox/doc/releases/release-notes-1.9.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,392 |
```restructuredtext
:orphan:
.. _zephyr_2.4:
Zephyr 2.4.0
############
We are pleased to announce the release of Zephyr RTOS version 2.4.0.
Major enhancements with this release include:
* Introduced initial support for virtual memory management.
* Added Bluetooth host support for periodic advertisement and isochr... | /content/code_sandbox/doc/releases/release-notes-2.4.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 30,795 |
```restructuredtext
:orphan:
.. _migration_4.0:
Migration guide to Zephyr v4.0.0 (Working Draft)
################################################
This document describes the changes required when migrating your application from Zephyr v3.7.0 to
Zephyr v4.0.0.
Any other changes (not directly related to migrating app... | /content/code_sandbox/doc/releases/migration-guide-4.0.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,236 |
```restructuredtext
:orphan:
.. _migration_3.7:
Migration guide to Zephyr v3.7.0
################################
This document describes the changes required when migrating your application from Zephyr v3.6.0 to
Zephyr v3.7.0.
Any other changes (not directly related to migrating applications) can be found in
the :... | /content/code_sandbox/doc/releases/migration-guide-3.7.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 11,163 |
```restructuredtext
:orphan:
.. _zephyr_3.7:
Zephyr 3.7.0
############
We are pleased to announce the release of Zephyr version 3.7.0.
This release is the last non-maintenance 3.x release and, as such, will be the next
:ref:`Long Term Support (LTS) release <release_process_lts>`.
Major enhancements with this relea... | /content/code_sandbox/doc/releases/release-notes-3.7.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 23,733 |
```restructuredtext
:orphan:
.. _zephyr_3.3:
Zephyr 3.3.0
############
We are pleased to announce the release of Zephyr version 3.3.0.
Major enhancements with this release include:
* Introduced :ref:`Fuel Gauge <fuel_gauge_api>` subsystem for battery level
monitoring.
* Introduced :ref:`USB-C <usbc_api>` device ... | /content/code_sandbox/doc/releases/release-notes-3.3.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 53,828 |
```restructuredtext
:orphan:
.. _zephyr_2.0:
Zephyr 2.0.0
############
We are pleased to announce the release of Zephyr RTOS version 2.0.0.
Major enhancements with this release include:
* The kernel now supports both 32- and 64-bit architectures.
* We added support for SOCKS5 proxy. SOCKS5 is an Internet protocol ... | /content/code_sandbox/doc/releases/release-notes-2.0.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 28,857 |
```restructuredtext
:orphan:
.. _zephyr_2.5:
Zephyr 2.5.0
#############
We are pleased to announce the release of Zephyr RTOS version 2.5.0.
Major enhancements with this release include:
* Introduced support for the SPARC processor architecture and the LEON
processor implementation.
* Added Thread Local Storage ... | /content/code_sandbox/doc/releases/release-notes-2.5.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 31,000 |
```restructuredtext
:orphan:
.. _zephyr_3.5:
Zephyr 3.5.0
############
We are pleased to announce the release of Zephyr version 3.5.0.
Major enhancements with this release include:
* Added support for linkable loadable extensions (llext)
* Added native_sim simulator target (successor to native_posix)
* Added new b... | /content/code_sandbox/doc/releases/release-notes-3.5.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 20,608 |
```restructuredtext
.. _safety_overview:
Zephyr Safety Overview
########################
Introduction
************
This document is the safety documentation providing an overview over the safety-relevant activities
and what the Zephyr Project and the Zephyr Safety Working Group / Committee try to achieve.
This over... | /content/code_sandbox/doc/safety/safety_overview.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,781 |
```restructuredtext
.. _safety_section:
Safety
########
These documents describe the processes, developer guidelines and requirements
for ensuring safety is addressed within the Zephyr project.
.. toctree::
:maxdepth: 1
:glob:
safety_overview.rst
safety_requirements.rst
``` | /content/code_sandbox/doc/safety/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 64 |
```restructuredtext
.. _zephyr_1.6:
Zephyr Kernel 1.6.0
####################
We are pleased to announce the release of Zephyr kernel version 1.6.0. This
release introduces the unified Kernel replacing the separate nano- and
micro-kernels and simplifying the overall Zephyr architecture and programming
interfaces.
Supp... | /content/code_sandbox/doc/releases/release-notes-1.6.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,300 |
```restructuredtext
.. _safety_requirements:
Safety Requirements
###################
Introduction
************
The safety committee leads the effort to gather requirements that reflect the **actual** state of
the implementation, following the `route 3s <path_to_url#general-safety-scope>`_
approach of the project's s... | /content/code_sandbox/doc/safety/safety_requirements.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 757 |
```css
/**
*
* Custom stylesheet for Google Programmable Search Engine results.
*/
.gs-webResult .gs-snippet,
.gs-fileFormatType,
.gs-spelling,
.gsc-refinementHeader,
.gsc-result-info,
.gsc-orderby-label {
color: var(--body-color) !important;
}
.gsc-control-cse {
width: 100%;
padding: 0 !important;
font-fa... | /content/code_sandbox/doc/_static/css/gcs.css | css | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 679 |
```css
/**
*
* Dark theme colors
*/
:root {
--body-color: rgba(255, 255, 255, 0.85);
--content-wrap-background-color: #202326;
--content-background-color: #2e3236;
/* Decrease the logo opacity when using the dark theme to be less distracting */
--logo-opacity: 0.85;
--navbar-background-color... | /content/code_sandbox/doc/_static/css/dark.css | css | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,106 |
```css
/**
*
* Light theme colors
*/
:root {
--body-color: #404040;
--content-wrap-background-color: #efefef;
--content-background-color: #fcfcfc;
--logo-opacity: 1.0;
--navbar-background-color: #333f67;
--navbar-background-color-hover: #29355c;
--navbar-background-color-active: #212d51;... | /content/code_sandbox/doc/_static/css/light.css | css | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,107 |
```javascript
/**
* Simple search result scoring code.
*
*/
var Scorer = {
// Implement the following function to further tweak the score for
// each result The function takes a result array [filename, title,
// anchor, descr, score] and returns the new score.
// For Zephyr search results, push display dow... | /content/code_sandbox/doc/_static/js/scorer.js | javascript | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 336 |
```javascript
/**
*/
// Handle page scroll and adjust sidebar accordingly.
// Each page has two scrolls: the main scroll, which is moving the content of the page;
// and the sidebar scroll, which is moving the navigation in the sidebar.
// We want the logo to gradually disappear as the main content is scrolled, giv... | /content/code_sandbox/doc/_static/js/custom.js | javascript | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,044 |
```css
/**
*
* Various tweaks to the Read the Docs theme to better conform with Zephyr's
* visual identity. Many colors are also overridden to use CSS variables.
*/
body,
h1,
h2,
h3,
h4,
h5,
h6,
input[type="text"],
input[type="button"],
input[type="reset"],
input[type="submit"],
textarea,
legend,
.btn,
.rst-conten... | /content/code_sandbox/doc/_static/css/custom.css | css | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,049 |
```unknown
const e=document;const t=localStorage;const i="prefers-color-scheme";const a="media";const s="light";const r="dark";const o=`(${i}:${r})`;const n=`(${i}:${s})`;const l="link[rel=stylesheet]";const h="remember";const c="legend";const d="toggle";const b="switch";const p="appearance";const g="permanent";const m... | /content/code_sandbox/doc/_static/js/dark-mode-toggle.min.mjs | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,064 |
```tex
% LaTeX documentation preamble
%
\usepackage[some]{background}
\usepackage{sectsty}
\usepackage{pdflscape}
\definecolor{bg-color}{HTML}{333f67}
\setcounter{tocdepth}{2}
\addto\captionsenglish{\renewcommand{\contentsname}{Table of contents}}
\allsectionsfont{\color{bg-color}}
``` | /content/code_sandbox/doc/_static/latex/preamble.tex | tex | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 81 |
```tex
% LaTeX documentation title page
%
\makeatletter
\newgeometry{top=3cm,left=0cm,right=0cm,bottom=2.5cm}
\backgroundsetup{
scale=2.3,
contents={\sphinxlogo},
opacity=0.2,
angle=0,
position={0.25\textwidth,-0.4\textheight}
}
\BgThispage
\begin{minipage}{2cm}
\color{bg-color} \rule{2cm}{1... | /content/code_sandbox/doc/_static/latex/title.tex | tex | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 304 |
```python
"""
Helper functions used by gen_kconfig_rest.py and gen_devicetree_rest.py.
"""
import errno
def write_if_updated(path, s):
"""
Writes 's' as the contents of <out_dir>/<filename>, but only if it
differs from the current contents of the file. This avoids unnecessary
timestamp updates, which... | /content/code_sandbox/doc/_scripts/gen_helpers.py | python | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 170 |
```python
"""
This module contains a variable with a list of tuples (old_url, new_url) for
pages to redirect. This list allows redirecting old URLs (caused by reorganizing
doc directories)
Notes:
- Please keep this list sorted alphabetically.
- URLs must be relative to document root (with NO leading slash), a... | /content/code_sandbox/doc/_scripts/redirects.py | python | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,622 |
```python
"""
Like gen_kconfig_rest.py, but for generating an index of existing
devicetree bindings.
"""
import argparse
from collections import defaultdict
import glob
import io
import logging
import os
from pathlib import Path
import pprint
import re
import sys
import textwrap
from devicetree import edtlib
import... | /content/code_sandbox/doc/_scripts/gen_devicetree_rest.py | python | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,532 |
```restructuredtext
.. _developing_with_zephyr:
Developing with Zephyr
######################
.. toctree::
:maxdepth: 1
getting_started/index.rst
beyond-GSG.rst
env_vars.rst
application/index.rst
debug/index.rst
api/index.rst
languages/index.rst
optimizations/index
flash_debug/index
... | /content/code_sandbox/doc/develop/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 112 |
```restructuredtext
.. _beyond-gsg:
Beyond the Getting Started Guide
################################
The :ref:`getting_started` gives a straight-forward path to set up
your Linux, macOS, or Windows environment for Zephyr development. In
this document, we delve deeper into Zephyr development setup
issues and alternat... | /content/code_sandbox/doc/develop/beyond-GSG.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,285 |
```restructuredtext
.. _env_vars:
Environment Variables
=====================
Various pages in this documentation refer to setting Zephyr-specific
environment variables. This page describes how.
Setting Variables
*****************
Option 1: Just Once
-------------------
To set the environment variable ``MY_VARIABL... | /content/code_sandbox/doc/develop/env_vars.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,660 |
```restructuredtext
.. _modules:
Modules (External projects)
############################
Zephyr relies on the source code of several externally maintained projects in
order to avoid reinventing the wheel and to reuse as much well-established,
mature code as possible when it makes sense. In the context of Zephyr's bu... | /content/code_sandbox/doc/develop/modules.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 10,200 |
```unknown
mainmenu "Your Application Name"
# Your application configuration options go here
# Sources Kconfig.zephyr in the Zephyr root directory.
#
# Note: All 'source' statements work relative to the Zephyr root directory (due
# to the $srctree environment variable being set to $ZEPHYR_BASE). If you want
# to 'so... | /content/code_sandbox/doc/develop/application/application-kconfig.include | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 117 |
```restructuredtext
.. _application:
Application Development
#######################
.. note::
In this document, we'll assume:
- your **application directory**, :file:`<app>`, is something like :file:`<home>/zephyrproject/app`
- its **build directory** is :file:`<app>/build`
These terms are defined bel... | /content/code_sandbox/doc/develop/application/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 10,883 |
```restructuredtext
.. _flashing_and_debugging:
Flashing and Hardware Debugging
###############################
.. toctree::
:maxdepth: 1
host-tools.rst
probes.rst
``` | /content/code_sandbox/doc/develop/flash_debug/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 42 |
```restructuredtext
.. _debug-probes:
Debug Probes
############
A *debug probe* is special hardware which allows you to control execution of a
Zephyr application running on a separate board. Debug probes usually allow
reading and writing registers and memory, and support breakpoint debugging of
the Zephyr application... | /content/code_sandbox/doc/develop/flash_debug/probes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,071 |
```restructuredtext
.. _flash-debug-host-tools:
Flash & Debug Host Tools
########################
This guide describes the software tools you can run on your host workstation to
flash and debug Zephyr applications.
Zephyr's west tool has built-in support for all of these in its ``flash``,
``debug``, ``debugserver``,... | /content/code_sandbox/doc/develop/flash_debug/host-tools.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 4,253 |
```restructuredtext
.. _dev_tools:
Tools and IDEs
##############
.. toctree::
:maxdepth: 1
clion.rst
coccinelle.rst
vscode.rst
``` | /content/code_sandbox/doc/develop/tools/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 45 |
```restructuredtext
:orphan:
.. _nordic_segger:
Nordic nRF5x Segger J-Link
##########################
Overview
********
All Nordic nRF5x Development Kits, Preview Development Kits and Dongles are equipped
with a Debug IC (Atmel ATSAM3U2C) which provides the following functionality:
* Segger J-Link firmware and des... | /content/code_sandbox/doc/develop/flash_debug/nordic_segger.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,053 |
```restructuredtext
.. _vscode_ide:
Visual Studio Code
##################
`Visual Studio Code`_ (VS Code for short) is a popular cross-platform IDE that supports C projects
and has a rich set of extensions.
This guide describes the process of setting up VS Code for Zephyr's
:zephyr:code-sample:`blinky` sample in VS ... | /content/code_sandbox/doc/develop/tools/vscode.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 856 |
```restructuredtext
.. _clion_ide:
CLion
#####
CLion_ is a cross-platform C/C++ IDE that supports multi-threaded RTOS debugging.
This guide describes the process of setting up, building, and debugging Zephyr's
:zephyr:code-sample:`multi-thread-blinky` sample in CLion.
The instructions have been tested on Windows. I... | /content/code_sandbox/doc/develop/tools/clion.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,610 |
```restructuredtext
.. _west-troubleshooting:
Troubleshooting West
####################
This page covers common issues with west and how to solve them.
``west update`` fetching failures
*********************************
One good way to troubleshoot fetching issues is to run ``west update`` in
verbose mode, like thi... | /content/code_sandbox/doc/develop/west/troubleshooting.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,897 |
```restructuredtext
.. _coccinelle:
..
Coccinelle
##########
Coccinelle is a tool for pattern matching and text transformation that has
many uses in kernel development, including the application of complex,
tree-wide patches and detection of problematic programming patterns.
.. note::
Linux and macOS development... | /content/code_sandbox/doc/develop/tools/coccinelle.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,879 |
```restructuredtext
.. _west-extensions:
Extensions
##########
West is "pluggable": you can add your own commands to west without editing its
source code. These are called **west extension commands**, or just "extensions"
for short. Extensions show up in the ``west --help`` output in a special
section for the project... | /content/code_sandbox/doc/develop/west/extensions.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,084 |
```restructuredtext
.. _west-sign:
Signing Binaries
################
The ``west sign`` :ref:`extension <west-extensions>` command can be used to
sign a Zephyr application binary for consumption by a bootloader using an
external tool. In some configurations, ``west sign`` is also used to invoke
an external, post-proce... | /content/code_sandbox/doc/develop/west/sign.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,153 |
```restructuredtext
.. _west-zephyr-ext-cmds:
Additional Zephyr extension commands
####################################
This page documents miscellaneous :ref:`west-zephyr-extensions`.
.. _west-boards:
Listing boards: ``west boards``
*******************************
The ``boards`` command can be used to list the bo... | /content/code_sandbox/doc/develop/west/zephyr-cmds.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,546 |
```restructuredtext
.. _west:
West (Zephyr's meta-tool)
#########################
The Zephyr project includes a swiss-army knife command line tool named
``west``\ [#west-name]_. West is developed in its own `repository`_.
West's built-in commands provide a multiple repository management system with
features inspired... | /content/code_sandbox/doc/develop/west/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 432 |
```restructuredtext
.. _moving-to-west:
Moving to West
##############
To convert a "pre-west" Zephyr setup on your computer to west, follow these
steps. If you are starting from scratch, use the :ref:`getting_started`
instead. See :ref:`west-troubleshooting` for advice on common issues.
#. Install west.
On Linux... | /content/code_sandbox/doc/develop/west/moving-to-west.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 393 |
```restructuredtext
.. _west-install:
Installing west
###############
West is written in Python 3 and distributed through `PyPI`_.
Use :file:`pip3` to install or upgrade west:
On Linux::
pip3 install --user -U west
On Windows and macOS::
pip3 install -U west
.. note::
See :ref:`python-pip` for additional ... | /content/code_sandbox/doc/develop/west/install.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 581 |
```restructuredtext
.. _west-history:
History and Motivation
######################
West was added to the Zephyr project to fulfill two fundamental requirements:
* The ability to work with multiple Git repositories
* The ability to provide an extensible and user-friendly command-line interface
for basic Zephyr wor... | /content/code_sandbox/doc/develop/west/why.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,022 |
```restructuredtext
.. _west-build-flash-debug:
Building, Flashing and Debugging
################################
Zephyr provides several :ref:`west extension commands <west-extensions>` for
building, flashing, and interacting with Zephyr programs running on a board:
``build``, ``flash``, ``debug``, ``debugserver`` a... | /content/code_sandbox/doc/develop/west/build-flash-debug.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 6,715 |
```restructuredtext
.. _west-workspaces:
Workspaces
##########
This page describes the *west workspace* concept introduced in
:ref:`west-basics` in more detail.
.. _west-manifest-rev:
The ``manifest-rev`` branch
***************************
West creates and controls a Git branch named ``manifest-rev`` in each
proje... | /content/code_sandbox/doc/develop/west/workspaces.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,545 |
```restructuredtext
.. _west-config:
Configuration
#############
This page documents west's configuration file system, the ``west config``
command, and configuration options used by built-in commands. For API
documentation on the ``west.configuration`` module, see
:ref:`west-apis-configuration`.
West Configuration F... | /content/code_sandbox/doc/develop/west/config.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,544 |
```restructuredtext
.. _west-release-notes:
West Release Notes
##################
v1.2.0
******
Major changes:
- New ``west grep`` command for running a "grep tool" in your west workspace's
repositories. Currently, ``git grep``, `ripgrep`_, and standard ``grep`` are
supported grep tools.
To run this command ... | /content/code_sandbox/doc/develop/west/release-notes.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 7,345 |
```restructuredtext
.. _west-basics:
Basics
######
This page introduces west's basic concepts and provides references to further
reading.
West's built-in commands allow you to work with :term:`projects <west project>`
(Git repositories) under a common :term:`workspace <west workspace>` directory.
West works in the ... | /content/code_sandbox/doc/develop/west/basics.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,727 |
```restructuredtext
.. _no-west:
Using Zephyr without west
#########################
This page provides information on using Zephyr without west. This is
not recommended for beginners due to the extra effort involved. In
particular, you will have to do work "by hand" to replace these
features:
- cloning the addition... | /content/code_sandbox/doc/develop/west/without-west.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,069 |
```restructuredtext
:orphan:
.. _west-apis:
.. _west-apis-west:
.. _west-apis-commands:
.. _west-apis-westcommand:
.. _west-apis-configuration:
.. _west-apis-log:
.. _west-apis-manifest:
.. _west-apis-util:
West APIs
#########
The west APIs are not documented since either west was missing or the zephyr
repository wa... | /content/code_sandbox/doc/develop/west/west-not-found.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 97 |
```restructuredtext
:orphan:
.. _west-apis:
.. _west-apis-west:
West APIs
#########
This page documents the Python APIs provided by :ref:`west <west>`, as well as
some additional APIs used by the :ref:`west extensions <west-extensions>` in
the zephyr repository.
**Contents**:
.. contents::
:local:
.. NOTE: doc... | /content/code_sandbox/doc/develop/west/west-apis.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,929 |
```restructuredtext
.. _west-built-in-cmds:
Built-in commands
#################
This page describes west's built-in commands, some of which were introduced in
:ref:`west-basics`, in more detail.
Some commands are related to Git commands with the same name, but operate
on the entire workspace. For example, ``west dif... | /content/code_sandbox/doc/develop/west/built-in.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,590 |
```restructuredtext
.. _twister_script:
Test Runner (Twister)
#####################
Twister scans for the set of test applications in the git repository
and attempts to execute them. By default, it tries to build each test
application on boards marked as default in the board definition file.
The default options will... | /content/code_sandbox/doc/develop/test/twister.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 11,784 |
```c
#include <zephyr/ztest.h>
static void expect_two_parameters(int a, int b)
{
ztest_check_expected_value(a);
ztest_check_expected_value(b);
}
static void parameter_tests(void)
{
ztest_expect_value(expect_two_parameters, a, 2);
ztest_expect_value(expect_two_parameters, b, 3);
expect_two_parameters(2, 3);
}
st... | /content/code_sandbox/doc/develop/test/mocking.c | c | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 170 |
```restructuredtext
.. _coverage:
Generating coverage reports
###########################
With Zephyr, you can generate code coverage reports to analyze which parts of
the code are covered by a given test or application.
You can do this in two ways:
* In a real embedded target or QEMU, using Zephyr's gcov integrati... | /content/code_sandbox/doc/develop/test/coverage.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,382 |
```restructuredtext
.. _testing:
Testing
#######
.. toctree::
:maxdepth: 1
ztest
twister
twister/twister_blackbox
pytest
coverage
BabbleSim<bsim>
ztest_deprecated
``` | /content/code_sandbox/doc/develop/test/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 59 |
```restructuredtext
.. _west-manifests:
West Manifests
##############
This page contains detailed information about west's multiple repository model,
manifest files, and the ``west manifest`` command. For API documentation on the
``west.manifest`` module, see :ref:`west-apis-manifest`. For a more general
introduction... | /content/code_sandbox/doc/develop/west/manifest.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 16,820 |
```restructuredtext
.. _integration_with_pytest:
Integration with pytest test framework
######################################
*Please mind that integration of twister with pytest is still work in progress. Not every platform
type is supported in pytest (yet). If you find any issue with the integration or have an ide... | /content/code_sandbox/doc/develop/test/pytest.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,523 |
```restructuredtext
.. _test-framework:
Test Framework
###############
The Zephyr Test Framework (Ztest) provides a simple testing framework intended
to be used during development. It provides basic assertion macros and a generic
test structure.
The framework can be used in two ways, either as a generic framework f... | /content/code_sandbox/doc/develop/test/ztest.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 5,252 |
```restructuredtext
.. _test-framework-deprecated:
ZTest Deprecated APIs
#####################
Ztest is currently being migrated to a new API, this documentation provides information about the
deprecated APIs which will eventually be removed. See :ref:`Test Framework <test-framework>` for the new API.
Similarly, ZTes... | /content/code_sandbox/doc/develop/test/ztest_deprecated.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,006 |
```restructuredtext
.. _bsim:
BabbleSim
#########
BabbleSim and Zephyr
********************
In the Zephyr project we use the `Babblesim`_ simulator to test some of the Zephyr radio protocols,
including the BLE stack, 802.15.4, and some of the networking stack.
BabbleSim_ is a physical layer simulator, which in comb... | /content/code_sandbox/doc/develop/test/bsim.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,015 |
```python
#!/usr/bin/env python3
#
import importlib
import mock
import os
import pytest
import sys
import json
from conftest import ZEPHYR_BASE, TEST_DATA, testsuite_filename_mock
from twisterlib.testplan import TestPlan
class TestDummy:
TESTDATA_X = [
("smoke", 5),
("acceptance", 6),
]
... | /content/code_sandbox/doc/develop/test/twister/sample_blackbox_test.py | python | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 726 |
```restructuredtext
.. _language_support:
Language Support
################
.. toctree::
:maxdepth: 2
c/index.rst
cpp/index.rst
``` | /content/code_sandbox/doc/develop/languages/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 36 |
```restructuredtext
.. _twister_blackbox:
Twister blackbox tests
######################
This guide aims to explain the structure of a test file so the reader will be able
to understand existing files and create their own. All developers should fix any tests
they break and create new ones when introducing new features... | /content/code_sandbox/doc/develop/test/twister/twister_blackbox.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,198 |
```restructuredtext
.. _c_library_minimal:
Minimal libc
############
The most basic C library, named "minimal libc", is part of the Zephyr codebase
and provides the minimal subset of the standard C library required to meet the
needs of Zephyr and its subsystems, primarily in the areas of string
manipulation and displ... | /content/code_sandbox/doc/develop/languages/c/minimal_libc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 570 |
```restructuredtext
.. _language_c:
C Language Support
##################
C is a general-purpose low-level programming language that is widely used for
writing code for embedded systems.
Zephyr is primarily written in C and natively supports applications written in
the C language. All Zephyr API functions and macros... | /content/code_sandbox/doc/develop/languages/c/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,037 |
```restructuredtext
.. _language_cpp:
C++ Language Support
####################
C++ is a general-purpose object-oriented programming language that is based on
the C language.
Enabling C++ Support
********************
Zephyr supports applications written in both C and C++. However, to use C++ in
an application you m... | /content/code_sandbox/doc/develop/languages/cpp/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,540 |
```restructuredtext
.. _c_library_common:
Common C library code
#####################
Zephyr provides some C library functions that are designed to be used in
conjunction with multiple C libraries. These either provide functions not
available in multiple C libraries or are designed to replace functionality
in the C l... | /content/code_sandbox/doc/develop/languages/c/common_libc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 466 |
```restructuredtext
.. _c_library_picolibc:
Picolibc
########
`Picolibc`_ is a complete C library implementation written for the
embedded systems, targeting `C17 (ISO/IEC 9899:2018)`_ and `POSIX 2018
(IEEE Std 1003.1-2017)`_ standards. Picolibc is an external open
source project which is provided for Zephyr as a modu... | /content/code_sandbox/doc/develop/languages/c/picolibc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,421 |
```restructuredtext
.. _mac-setup-alts:
macOS alternative setup instructions
####################################
.. _mac-gatekeeper:
Important note about Gatekeeper
*******************************
Starting with macOS 10.15 Catalina, applications launched from the macOS
Terminal application (or any other terminal e... | /content/code_sandbox/doc/develop/getting_started/installation_mac.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 358 |
```restructuredtext
.. _c_library_newlib:
Newlib
######
`Newlib`_ is a complete C library implementation written for the embedded
systems. It is a separate open source project and is not included in source
code form with Zephyr. Instead, the :ref:`toolchain_zephyr_sdk` includes a
precompiled library for each supporte... | /content/code_sandbox/doc/develop/languages/c/newlib.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 1,280 |
```restructuredtext
.. _installation_linux:
Install Linux Host Dependencies
###############################
Documentation is available for these Linux distributions:
* Ubuntu
* Fedora
* Clear Linux
* Arch Linux
For distributions that are not based on rolling releases, some of the
requirements and dependencies may n... | /content/code_sandbox/doc/develop/getting_started/installation_linux.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,676 |
```restructuredtext
.. _win-setup-alts:
Windows alternative setup instructions
######################################
.. _win-wsl:
Windows 10 WSL (Windows Subsystem for Linux)
********************************************
If you are running a recent version of Windows 10 you can make use of the
built-in functionalit... | /content/code_sandbox/doc/develop/getting_started/installation_win.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 315 |
```restructuredtext
.. _sparse:
Sparse support
##############
`Sparse <path_to_url`__
is a static code analysis tool.
Apart from performing common code analysis tasks it also supports an
``address_space`` attribute, which allows introduction of distinct address
spaces in C code with subsequent verification that point... | /content/code_sandbox/doc/develop/sca/sparse.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 226 |
```restructuredtext
.. _getting_started:
Getting Started Guide
#####################
Follow this guide to:
- Set up a command-line Zephyr development environment on Ubuntu, macOS, or
Windows (instructions for other Linux distributions are discussed in
:ref:`installation_linux`)
- Get the source code
- Build, fla... | /content/code_sandbox/doc/develop/getting_started/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,809 |
```restructuredtext
.. _gcc:
GCC static analysis support
###########################
Static analysis was introduced in `GCC <path_to_url`__ 10 and it is enabled
with the option ``-fanalyzer``. This option performs a much more expensive and thorough
analysis of the code than traditional warnings.
Run GCC static analy... | /content/code_sandbox/doc/develop/sca/gcc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 142 |
```restructuredtext
.. _sca:
Static Code Analysis (SCA)
##########################
Support for static code analysis tools in Zephyr is possible through CMake.
The build setting :makevar:`ZEPHYR_SCA_VARIANT` can be used to specify the SCA
tool to use. :envvar:`ZEPHYR_SCA_VARIANT` is also supported as
:ref:`environmen... | /content/code_sandbox/doc/develop/sca/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 553 |
```restructuredtext
.. _cpptest:
Parasoft C/C++test support
##########################
Parasoft `C/C++test <path_to_url`__ is a software testing
and static analysis tool for C and C++. It is a commercial software and you must acquire a
commercial license to use it.
Documentation of C/C++test can be found at path_to_... | /content/code_sandbox/doc/develop/sca/cpptest.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 352 |
```restructuredtext
.. _codechecker:
CodeChecker support
###################
`CodeChecker <path_to_url`__ is a static analysis infrastructure.
It executes analysis tools available on the build system, such as
`Clang-Tidy <path_to_url`__,
`Clang Static Analyzer <path_to_url`__ and
`Cppcheck <path_to_url`__. Refer to t... | /content/code_sandbox/doc/develop/sca/codechecker.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 725 |
```unknown
.. _external_module_<name>:
<External Module Name>
#######################
Introduction
************
Short intro into the module and how it relates to Zephyr.
Usage with Zephyr
*****************
How to use this module with Zephyr. Provide all the details.
Reference
*********
External references and li... | /content/code_sandbox/doc/develop/manifest/external/external.rst.tmpl | unknown | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 67 |
```restructuredtext
:orphan:
.. _west_projects_index:
West Projects index
###################
See :ref:`external-contributions` for more information about
this contributing and review process for imported components.
Active Projects/Modules
+++++++++++++++++++++++
The projects below are enabled by default and will... | /content/code_sandbox/doc/develop/manifest/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 392 |
```restructuredtext
.. _external_module_dummy:
Add Your External Module Here
#############################
Introduction
************
Short intro into the module and how it relates to Zephyr.
Usage with Zephyr
*****************
How to use this module with Zephyr. Provide all the details.
Reference
*********
Exter... | /content/code_sandbox/doc/develop/manifest/external/dummy.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 65 |
```restructuredtext
.. _footprint:
Optimizing for Footprint
########################
Stack Sizes
***********
Stack sizes of various system threads are specified generously to allow for
usage in different scenarios on as many supported platforms as possible. You
should start the optimization process by reviewing all ... | /content/code_sandbox/doc/develop/optimizations/footprint.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 337 |
```restructuredtext
.. _optimizations:
Optimizations
##############
Guides on how to optimize Zephyr for performance, power and footprint.
.. toctree::
:maxdepth: 1
footprint.rst
tools.rst
``` | /content/code_sandbox/doc/develop/optimizations/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 51 |
```restructuredtext
.. _optimization_tools:
Optimization Tools
##################
The available optimization tools let you analyse :ref:`footprint_tools`
and :ref:`data_structure_tools` using different build system targets.
.. _footprint_tools:
Footprint and Memory Usage
**************************
The build system... | /content/code_sandbox/doc/develop/optimizations/tools.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 2,615 |
```restructuredtext
.. _develop_debug:
Debugging
#########
.. _application_debugging:
Application Debugging
*********************
This section is a quick hands-on reference to start debugging your
application with QEMU. Most content in this section is already covered in
`QEMU`_ and `GNU_Debugger`_ reference manuals... | /content/code_sandbox/doc/develop/debug/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 3,004 |
```restructuredtext
.. _toolchain_armclang:
Arm Compiler 6
##############
#. Download and install a development suite containing the `Arm Compiler 6`_
for your operating system.
#. :ref:`Set these environment variables <env_vars>`:
- Set :envvar:`ZEPHYR_TOOLCHAIN_VARIANT` to ``armclang``.
- Set :envvar:`AR... | /content/code_sandbox/doc/develop/toolchains/arm_compiler.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 504 |
```restructuredtext
.. _toolchain_gnuarmemb:
GNU Arm Embedded
################
#. Download and install a `GNU Arm Embedded`_ build for your operating system
and extract it on your file system.
.. note::
On Windows, we'll assume for this guide that you install into the directory
:file:`C:\\gnu_arm_... | /content/code_sandbox/doc/develop/toolchains/gnu_arm_embedded.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 467 |
```restructuredtext
.. _custom_cmake_toolchains:
Custom CMake Toolchains
#######################
To use a custom toolchain defined in an external CMake file, :ref:`set these
environment variables <env_vars>`:
- Set :envvar:`ZEPHYR_TOOLCHAIN_VARIANT` to your toolchain's name
- Set ``TOOLCHAIN_ROOT`` to the path to th... | /content/code_sandbox/doc/develop/toolchains/custom_cmake.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 829 |
```restructuredtext
.. _toolchain_intel_oneapi_toolkit:
Intel oneAPI Toolkit
####################
#. Download `Intel oneAPI Base Toolkit
<path_to_url`_
#. Assuming the toolkit is installed in ``/opt/intel/oneApi``, set environment
using::
# Linux, macOS:
export ONEAPI_TOOLCHAIN_PATH=/opt/intel... | /content/code_sandbox/doc/develop/toolchains/intel_oneapi_toolkit.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 190 |
```restructuredtext
.. _toolchains:
Toolchains
##########
Guides on how to set up toolchains for Zephyr development.
.. toctree::
:maxdepth: 1
zephyr_sdk.rst
arm_compiler.rst
cadence_xcc.rst
designware_arc_mwdt.rst
gnu_arm_embedded.rst
intel_oneapi_toolkit.rst
crosstool_ng.rst
host.rst
... | /content/code_sandbox/doc/develop/toolchains/index.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 118 |
```restructuredtext
.. _host_toolchains:
Host Toolchains
###############
In some specific configurations, like when building for non-MCU x86 targets on
a Linux host, you may be able to reuse the native development tools provided
by your operating system.
To use your host gcc, set the :envvar:`ZEPHYR_TOOLCHAIN_VARIAN... | /content/code_sandbox/doc/develop/toolchains/host.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 110 |
```restructuredtext
.. _toolchain_cadence_xcc:
Cadence Tensilica Xtensa C/C++ Compiler (XCC)
#############################################
#. Obtain Tensilica Software Development Toolkit targeting the specific SoC
on hand. This usually contains two parts:
* The Xtensa Xplorer which contains the necessary exec... | /content/code_sandbox/doc/develop/toolchains/cadence_xcc.rst | restructuredtext | 2016-05-26T17:54:19 | 2024-08-16T18:09:06 | zephyr | zephyrproject-rtos/zephyr | 10,307 | 591 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.