Commit graph

21 commits

Author SHA1 Message Date
Anas Nashif 681e1d41e0 doc: clarify what a subsystem is
Clarify what a subsystem is, this has been missing the docs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-05-14 10:55:55 +02:00
Mia Koen 0bcad09392 bluetooth: mesh: Doc fix Bluetooth mesh to Mesh
SIG has changed Bluetooth mesh to Bluetooth Mesh
Updating zephyr docs accordingly
Leaving out old release notes

Signed-off-by: Mia Koen <mia.koen@nordicsemi.no>
2023-12-01 10:56:18 +00:00
Christopher Friedt 3b45235887 doc: posix: structural reorganization of posix docs
Revise the structure of the POSIX API docs. This separates
related items out to dedicated pages. Further improvements
could yet be made - e.g. using the 'collapse' feature to
expand and collapse large sections of text or tables.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-22 22:47:26 -05:00
Alberto Escolar Piedras 85b54358a1 docs: Introduction: Replace references to native_posix w native_sim
Let's replace the references to native_posix with native_sim,
in the introduction and beyond the getting started guide.

Background: during this release native_sim is replacing
native_posix as the main host test/development platform.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-14 14:38:10 +01:00
Benjamin Cabé 02226208bf doc: intro: cleanup VFS section
* add mention of ext2 as a supported file system.
* remove unnecessary mention to configurability and logging since it's
  not unique to VFS.
* capitalize FatFS properly

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-18 13:17:57 +03:00
Benjamin Cabé 54f51cbcb3 doc: intro: fix improper definition list
add missing blank line to not have the sentence render as a definition
list.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-17 19:05:20 +03:00
Kirill Kobelev 4a8d61248a doc: introduction: Improve style and grammar across the chapter
The changes are cosmetic and they do not change the meaning of the docs.

Signed-off-by: Kirill Kobelev <kobelev17@cdsan.com>
2023-07-10 10:01:08 +00:00
Manoel Brunnen c51da6f96c doc: Remove tickless idle from PM in introduction
Tickless idle has been replaced by the tickless kernel and also power
management has become much more advanced.

See also: https://github.com/zephyrproject-rtos/zephyr/pull/33302

Signed-off-by: Manoel Brunnen <mb@lee-brunnen.de>
2023-05-24 16:39:52 +02:00
Antony Pavlov ac0c1e4192 doc: mention MIPS architecture support
MIPS architecture support was introduced
in 0369998e61 ('arch: add MIPS architecture support').

Also sort supported architectures list alphabetically.

Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
2022-01-24 17:11:42 -05:00
Anas Nashif 76ac2dc478 doc: update list of supported architectures
- Add MIPS to the list.
- Update ARC entry with ARCv3 support.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-01-21 07:27:07 -05:00
Ingar Kulbrandstad 3ec6411c7f Bluetooth: Mesh: Align capitalization for BT mesh
Align the capitalization of the term "Bluetooth Mesh" to Bluetooth mesh"
in the documentation. This is done to to match the new updated naming
convention done in Bluetooth SIG. In the upcoming spec versions, it its
used "Bluetooth mesh" with the lower case convention.

Signed-off-by: Ingar Kulbrandstad <ingar.kulbrandstad@nordicsemi.no>
2021-07-13 11:23:54 -04:00
Carles Cufi 3260ed187f doc: intro: Add a reference to ARMv8-R
Specify that 64-bit Cortex-R, ARMv8-R, is now supported in Zephyr.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2021-06-03 13:40:14 +02:00
Kumar Gala 3c04f0c433 docs: Change a number of 'master' branch refers to 'main'
Now that we use 'main' for git development, update the docs to reflect
or point there instead of 'master'.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-05-28 10:45:17 -05:00
Carles Cufi 0b1ff6f5e4 doc: Add SPARC to the list of supported archs
The introduction page lists all the architectures supported by Zephyr.
Now that SPARC V8 support has been merged, add it to the list. Also list
it in the set of architectures supported by the SDK.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-11-16 08:12:07 -05:00
Henrik Brix Andersen d92b199173 doc: update list of architectures in introduction
List ARMv6-M (Cortex-M) as a supported architecture.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2020-08-31 17:37:25 -04:00
Olof Johansson 6a8c622bcc doc: update list of architectures in introduction
The list is out of date, so clarify the support a bit and add newly
added subarchitectures.

Signed-off-by: Olof Johansson <olof@lixom.net>
2020-08-27 23:38:54 -04:00
Martí Bolívar 6e57b42758 doc: dts: revisit documentation
This is joint work with Kumar Gala (see signed-off-by).

Document the changes to the generated node macros in macros.bnf,
moving the old file to legacy-macros.bnf and putting it in its own
section.

The actual generated macros are now a low-level detail, so rewrite the
foregoing sections as examples in terms of the new <devicetree.h> APIs.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2020-03-24 10:11:20 -05:00
Martí Bolívar 51b885019e doc: split devicetree docs into multiple pages
The one page on devicetree is too long. Split it into multiple pages
to make it easier to digest and more squintable. This is basically
just moving content around; minimal changes have been made apart from
redoing some transitions and adding a couple of introductory paragraphs.

Rename the 'device-tree' Sphinx :ref: target while we are here.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-02-20 12:15:27 +02:00
Andrzej Puzdrowski 68f51f66c6 doc: cleanup after NFFS removal
Patch introduce references to LittleFS instead of NFFS where it
was suitable. In other places NFFS mentions were removed

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2020-01-21 15:32:47 +01:00
Marti Bolivar 27e5dd131f doc: s/device tree/devicetree/
DTSpec writes this as a single word, presumably to make it easier to
grep for / more precise. Follow along in the rest of the docs now that
our main DT docs page agrees with this usage.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-10-08 11:53:40 +02:00
Anas Nashif 2b9458c378 doc: restructure and create index pages
Move all lead pages to be index pages and create redirect rules from the
old pointers.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
Renamed from doc/introduction/introducing_zephyr.rst (Browse further)