You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by ac...@apache.org on 2023/10/27 16:21:51 UTC
(nuttx) 05/10: Documentation: add dummy pages for missing top directories
This is an automated email from the ASF dual-hosted git repository.
acassis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 8090fb9d5c144b4cfc925af2bb4899ceacc96653
Author: raiden00pl <ra...@railab.me>
AuthorDate: Fri Oct 27 11:39:30 2023 +0200
Documentation: add dummy pages for missing top directories
crypto, openamp, video and wireless
---
Documentation/components/audio/index.rst | 4 ++--
Documentation/components/crypto.rst | 5 +++++
Documentation/components/index.rst | 5 +++++
Documentation/components/openamp.rst | 6 ++++++
Documentation/components/video.rst | 5 +++++
Documentation/components/wireless.rst | 11 +++++++++++
6 files changed, 34 insertions(+), 2 deletions(-)
diff --git a/Documentation/components/audio/index.rst b/Documentation/components/audio/index.rst
index de9a6637fc..0f1ccd2c9e 100644
--- a/Documentation/components/audio/index.rst
+++ b/Documentation/components/audio/index.rst
@@ -1,9 +1,9 @@
===============
-Audio subsystem
+Audio Subsystem
===============
This page discusses the audio subsystem support for NuttX which is only built if
-CONFIG_AUDIO is defined in the NuttX configuration file.
+``CONFIG_AUDIO`` is defined in the NuttX configuration file.
Files in nuttx/audio
====================
diff --git a/Documentation/components/crypto.rst b/Documentation/components/crypto.rst
new file mode 100644
index 0000000000..1a94ae0b05
--- /dev/null
+++ b/Documentation/components/crypto.rst
@@ -0,0 +1,5 @@
+====================
+Crypto API Subsystem
+====================
+
+In the future this page will contain details about the Crypto API in NuttX.
diff --git a/Documentation/components/index.rst b/Documentation/components/index.rst
index 72d48a8adc..ba2488dd4a 100644
--- a/Documentation/components/index.rst
+++ b/Documentation/components/index.rst
@@ -26,3 +26,8 @@ case, you can head to the :doc:`reference <../reference/index>`.
tools/index.rst
arch/index.rst
boards.rst
+ cmake.rst
+ openamp.rst
+ video.rst
+ crypto.rst
+ wireless.rst
diff --git a/Documentation/components/openamp.rst b/Documentation/components/openamp.rst
new file mode 100644
index 0000000000..4e9349536c
--- /dev/null
+++ b/Documentation/components/openamp.rst
@@ -0,0 +1,6 @@
+===============
+OpenAMP Support
+===============
+
+Asymmetric Multi Processing support in NuttX is implemented via
+`OpenAMP <https://www.openampproject.org/>`_ framework.
diff --git a/Documentation/components/video.rst b/Documentation/components/video.rst
new file mode 100644
index 0000000000..3a75d82a9a
--- /dev/null
+++ b/Documentation/components/video.rst
@@ -0,0 +1,5 @@
+===============
+Video Subsystem
+===============
+
+In the future this page will contain details about the video support in NuttX.
diff --git a/Documentation/components/wireless.rst b/Documentation/components/wireless.rst
new file mode 100644
index 0000000000..41acafa806
--- /dev/null
+++ b/Documentation/components/wireless.rst
@@ -0,0 +1,11 @@
+==================
+Wireless Subsystem
+==================
+
+In the future this page will contain details about the wireless support in NuttX.
+
+Components:
+
+- ``wireless/bluetooth`` - Bluetooth Low Energy Support
+- ``wireless/pktradio`` - Packet Radio Support
+- ``wireless/ieee802154`` - IEEE 802.15.4 Support