michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: application: improve application types section

Browse source 
Add more cross-references to the overview and make a few other
improvements. In particular, adapt to David Kinder's recommended
style (lowercase 'zephyr' for the repository, capitalized 'Zephyr' for
the more general software distribution).

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2023-01-05 12:02:21 -08:00 • committed by Carles Cufí
commit 82ed21d9e7
1 changed files with 24 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

38
doc/develop/application/index.rst
View file

@ -96,25 +96,36 @@ applications, followed by more detailed reference material.
Application types Application types
***************** *****************
Based on where the source code of the application is located we can distinguish We distinguish three basic types of Zephyr application based on where
between three basic application types. :file:`<app>` is located:
* Zephyr repository application .. table::
* Zephyr workspace application
* Zephyr freestanding application
You can find out more about how the build system supports all the application +------------------------------+--------------------------------+
types described in this section in the :ref:`cmake_pkg` section. | Application type | :file:`<app>` location |
+------------------------------+--------------------------------+
| :ref:`repository | zephyr repository |
| <zephyr-repo-app>` | |
+------------------------------+--------------------------------+
| :ref:`workspace | west workspace where Zephyr is |
| <zephyr-workspace-app>` | installed |
+------------------------------+--------------------------------+
| :ref:`freestanding | other locations |
| <zephyr-freestanding-app>` | |
+------------------------------+--------------------------------+
We'll discuss these more below. To learn how the build system supports each
type, see :ref:`cmake_pkg`.
.. _zephyr-repo-app: .. _zephyr-repo-app:
Zephyr repository application Zephyr repository application
============================= =============================
An application located within the ``zephyr`` folder in a Zephyr :ref:`west An application located within the ``zephyr`` source code repository in a Zephyr
workspace <west-workspaces>` is referred to as a Zephyr repository application. :ref:`west workspace <west-workspaces>` is referred to as a Zephyr repository
In the following example, the :ref:`hello_world sample <hello_world>` is a application. In the following example, the :ref:`hello_world sample
Zephyr repository application: <hello_world>` is a Zephyr repository application:
.. code-block:: none .. code-block:: none
@ -137,9 +148,8 @@ Zephyr workspace application
============================ ============================
An application located within a :ref:`workspace <west-workspaces>`, but outside An application located within a :ref:`workspace <west-workspaces>`, but outside
the Zephyr repository (and thus folder) itself, is referred to as a Zephyr the zephyr repository itself, is referred to as a Zephyr workspace application.
workspace application. In the following example, ``app`` is a Zephyr workspace In the following example, ``app`` is a Zephyr workspace application:
application:
.. code-block:: none .. code-block:: none