You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by xi...@apache.org on 2023/10/24 05:56:39 UTC
[nuttx] branch master updated (10e1540b53 -> 24bc270d82)
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
from 10e1540b53 games: Add documentation
new c4b2c65078 Documentaion: migrate graphics/lvgl readme
new e8c135ba0c Documentaion: migrate fsutils/inifile readme
new 3d7a395f52 Documentaion: migrate examples/mcuboot readme
new a342d2a7ac Documentaion: migrate testing readmes
new 731eaefba2 Documentation/examples: add missing titles
new 24bc270d82 Documentation/examples: format the first header as in other files
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../applications/examples/abntcodi/index.rst | 1 +
Documentation/applications/examples/adc/index.rst | 1 +
.../applications/examples/adjtime/index.rst | 1 +
.../applications/examples/adxl372_test/index.rst | 1 +
.../applications/examples/ajoystick/index.rst | 1 +
.../applications/examples/alarm/index.rst | 1 +
.../applications/examples/apa102/index.rst | 1 +
.../applications/examples/apds9960/index.rst | 1 +
.../applications/examples/audio_rttl/index.rst | 1 +
.../applications/examples/bastest/index.rst | 1 +
.../applications/examples/battery/index.rst | 1 +
.../applications/examples/bme680/index.rst | 1 +
.../applications/examples/bmi160/index.rst | 1 +
.../applications/examples/bmp180/index.rst | 1 +
.../applications/examples/bmp280/index.rst | 1 +
.../applications/examples/bridge/index.rst | 1 +
.../applications/examples/buttons/index.rst | 1 +
.../applications/examples/calib_udelay/index.rst | 1 +
.../applications/examples/camera/index.rst | 1 +
Documentation/applications/examples/can/index.rst | 1 +
.../applications/examples/capture/index.rst | 1 +
.../applications/examples/cbortest/index.rst | 1 +
.../applications/examples/cctype/index.rst | 1 +
Documentation/applications/examples/chat/index.rst | 1 +
.../applications/examples/chrono/index.rst | 1 +
.../applications/examples/configdata/index.rst | 1 +
.../applications/examples/cordic/index.rst | 1 +
.../applications/examples/cpuhog/index.rst | 1 +
.../applications/examples/cromfs/index.rst | 1 +
Documentation/applications/examples/dac/index.rst | 1 +
.../applications/examples/dhcpd/index.rst | 1 +
.../applications/examples/discover/index.rst | 1 +
.../applications/examples/djoystick/index.rst | 1 +
.../applications/examples/dronecan/index.rst | 1 +
Documentation/applications/examples/elf/index.rst | 1 +
.../applications/examples/embedlog/index.rst | 1 +
.../applications/examples/esp32_himem/index.rst | 1 +
Documentation/applications/examples/etl/index.rst | 1 +
Documentation/applications/examples/fb/index.rst | 1 +
.../applications/examples/fboverlay/index.rst | 1 +
.../applications/examples/flash_test/index.rst | 1 +
.../applications/examples/flowc/index.rst | 1 +
.../applications/examples/fmsynth/index.rst | 1 +
Documentation/applications/examples/foc/index.rst | 1 +
.../applications/examples/ft80x/index.rst | 1 +
Documentation/applications/examples/ftpc/index.rst | 1 +
Documentation/applications/examples/ftpd/index.rst | 1 +
.../examples/fxos8700cq_test/index.rst | 1 +
Documentation/applications/examples/gpio/index.rst | 3 +-
Documentation/applications/examples/gps/index.rst | 1 +
Documentation/applications/examples/hall/index.rst | 1 +
.../applications/examples/hdc1008_demo/index.rst | 1 +
.../applications/examples/hello/index.rst | 1 +
.../applications/examples/hello_nim/index.rst | 1 +
.../applications/examples/hello_rust/index.rst | 1 +
.../applications/examples/hello_wasm/index.rst | 1 +
.../applications/examples/hello_zig/index.rst | 1 +
.../applications/examples/helloxx/index.rst | 1 +
.../applications/examples/hidkbd/index.rst | 1 +
.../applications/examples/hts221_reader/index.rst | 1 +
.../applications/examples/i2cchar/index.rst | 1 +
.../applications/examples/i2sloop/index.rst | 1 +
Documentation/applications/examples/igmp/index.rst | 1 +
.../applications/examples/ina219/index.rst | 1 +
.../applications/examples/ina226/index.rst | 5 +-
Documentation/applications/examples/index.rst | 1 +
.../applications/examples/ini_dumper/index.rst | 5 +-
.../applications/examples/ipcfg/index.rst | 5 +-
Documentation/applications/examples/json/index.rst | 1 +
.../applications/examples/keyboard/index.rst | 1 +
Documentation/applications/examples/leds/index.rst | 1 +
.../applications/examples/libtest/index.rst | 1 +
.../applications/examples/lis3dsh_reader/index.rst | 1 +
.../applications/examples/lp503x/index.rst | 5 +-
.../applications/examples/lsm303_reader/index.rst | 1 +
.../applications/examples/lsm6dsl_reader/index.rst | 1 +
.../applications/examples/ltr308/index.rst | 5 +-
.../applications/examples/lua_module/index.rst | 1 +
.../applications/examples/lvgldemo/index.rst | 5 +-
.../applications/examples/lvglterm/index.rst | 1 +
.../applications/examples/max31855/index.rst | 5 +-
.../applications/examples/mcuboot/index.rst | 132 ++++++++++++++++++-
.../applications/examples/media/index.rst | 5 +-
Documentation/applications/examples/mld/index.rst | 5 +-
.../applications/examples/mlx90614/index.rst | 5 +-
.../applications/examples/mml_parser/index.rst | 4 +-
.../applications/examples/modbus/index.rst | 5 +-
.../applications/examples/modbusmaster/index.rst | 5 +-
.../applications/examples/module/index.rst | 1 +
.../applications/examples/mount/index.rst | 1 +
.../applications/examples/mqttc/index.rst | 5 +-
.../applications/examples/mtdpart/index.rst | 1 +
.../applications/examples/mtdrwb/index.rst | 1 +
.../applications/examples/netlink_route/index.rst | 5 +-
.../applications/examples/netloop/index.rst | 1 +
.../applications/examples/netpkt/index.rst | 1 +
.../applications/examples/nettest/index.rst | 1 +
.../applications/examples/nimble/index.rst | 5 +-
.../applications/examples/nng_test/index.rst | 5 +-
.../applications/examples/noteprintf/index.rst | 5 +-
.../applications/examples/nrf24l01_btle/index.rst | 5 +-
.../applications/examples/nrf24l01_term/index.rst | 1 +
Documentation/applications/examples/null/index.rst | 5 +-
.../applications/examples/nunchuck/index.rst | 1 +
Documentation/applications/examples/nx/index.rst | 5 +-
.../applications/examples/nxdemo/index.rst | 5 +-
.../applications/examples/nxflat/index.rst | 1 +
.../applications/examples/nxhello/index.rst | 5 +-
.../applications/examples/nximage/index.rst | 1 +
.../applications/examples/nxlines/index.rst | 1 +
.../applications/examples/nxscope/index.rst | 5 +-
.../applications/examples/nxterm/index.rst | 1 +
.../applications/examples/nxtext/index.rst | 1 +
Documentation/applications/examples/obd2/index.rst | 5 +-
.../applications/examples/oneshot/index.rst | 1 +
.../applications/examples/opencyphal/index.rst | 5 +-
.../applications/examples/pca9635/index.rst | 1 +
.../applications/examples/pdcurses/index.rst | 5 +-
.../applications/examples/pf_ieee802154/index.rst | 5 +-
Documentation/applications/examples/pipe/index.rst | 5 +-
Documentation/applications/examples/poll/index.rst | 5 +-
.../applications/examples/popen/index.rst | 5 +-
.../applications/examples/posix_spawn/index.rst | 5 +-
.../applications/examples/powerled/index.rst | 5 +-
.../applications/examples/powermonitor/index.rst | 5 +-
Documentation/applications/examples/pppd/index.rst | 5 +-
.../applications/examples/pty_test/index.rst | 1 +
Documentation/applications/examples/pwfb/index.rst | 5 +-
.../applications/examples/pwlines/index.rst | 5 +-
Documentation/applications/examples/pwm/index.rst | 1 +
.../applications/examples/qencoder/index.rst | 1 +
.../applications/examples/random/index.rst | 1 +
.../applications/examples/relays/index.rst | 1 +
.../applications/examples/rfid_readuid/index.rst | 1 +
.../applications/examples/rgbled/index.rst | 1 +
.../applications/examples/romfs/index.rst | 1 +
.../applications/examples/rpmsgsocket/index.rst | 5 +-
.../applications/examples/sendmail/index.rst | 1 +
.../applications/examples/serialblaster/index.rst | 5 +-
.../applications/examples/serialrx/index.rst | 5 +-
.../applications/examples/serloop/index.rst | 1 +
.../applications/examples/shm_test/index.rst | 5 +-
.../applications/examples/sht3x/index.rst | 5 +-
Documentation/applications/examples/slcd/index.rst | 1 +
Documentation/applications/examples/smps/index.rst | 1 +
.../applications/examples/sotest/index.rst | 1 +
Documentation/applications/examples/stat/index.rst | 5 +-
.../applications/examples/sx127x_demo/index.rst | 5 +-
.../applications/examples/system/index.rst | 5 +-
.../applications/examples/tcp_ipc_client/index.rst | 5 +-
.../applications/examples/tcp_ipc_server/index.rst | 5 +-
.../applications/examples/tcpblaster/index.rst | 1 +
.../applications/examples/tcpecho/index.rst | 1 +
.../applications/examples/telnetd/index.rst | 1 +
.../applications/examples/termios/index.rst | 1 +
.../applications/examples/thttpd/index.rst | 1 +
Documentation/applications/examples/tiff/index.rst | 5 +-
.../applications/examples/timer/index.rst | 5 +-
.../applications/examples/timer_gpio/index.rst | 5 +-
.../applications/examples/touchscreen/index.rst | 1 +
.../applications/examples/udgram/index.rst | 4 +-
Documentation/applications/examples/udp/index.rst | 1 +
.../applications/examples/udpblaster/index.rst | 5 +-
Documentation/applications/examples/uid/index.rst | 5 +-
.../applications/examples/unionfs/index.rst | 1 +
.../applications/examples/usbserial/index.rst | 1 +
.../applications/examples/userfs/index.rst | 1 +
.../applications/examples/usrsocktest/index.rst | 5 +-
.../applications/examples/ustream/index.rst | 1 +
.../applications/examples/veml6070/index.rst | 5 +-
.../applications/examples/watcher/index.rst | 1 +
.../applications/examples/webserver/index.rst | 1 +
Documentation/applications/examples/wget/index.rst | 1 +
.../applications/examples/wgetjson/index.rst | 1 +
.../applications/examples/wiegand/index.rst | 5 +-
.../applications/examples/ws2812/index.rst | 5 +-
.../applications/examples/ws2812esp32rmt/index.rst | 5 +-
.../applications/examples/xbc_test/index.rst | 5 +-
.../applications/examples/xmlrpc/index.rst | 1 +
.../applications/examples/zerocross/index.rst | 1 +
Documentation/applications/fsutils/index.rst | 8 +-
.../applications/fsutils/inifile/index.rst | 146 +++++++++++++++++++++
Documentation/applications/graphics/index.rst | 8 +-
Documentation/applications/graphics/lvgl/index.rst | 27 ++++
.../applications/testing/arch_libc/index.rst | 13 ++
.../applications/testing/cxxtest/index.rst | 29 ++++
.../applications/testing/fopencookie/index.rst | 11 ++
.../applications/testing/fstest/index.rst | 29 ++++
Documentation/applications/testing/index.rst | 28 ++--
Documentation/applications/testing/mm/index.rst | 5 +
.../applications/testing/mtd_config_fs/index.rst | 19 +++
Documentation/applications/testing/nxfss/index.rst | 8 ++
.../applications/testing/ostest/index.rst | 33 +++++
Documentation/applications/testing/smart/index.rst | 29 ++++
.../applications/testing/smart_test/index.rst | 20 +++
Documentation/applications/testing/smp/index.rst | 6 +
Documentation/applications/testing/unity/index.rst | 7 +
197 files changed, 837 insertions(+), 136 deletions(-)
create mode 100644 Documentation/applications/fsutils/inifile/index.rst
create mode 100644 Documentation/applications/graphics/lvgl/index.rst
create mode 100644 Documentation/applications/testing/arch_libc/index.rst
create mode 100644 Documentation/applications/testing/cxxtest/index.rst
create mode 100644 Documentation/applications/testing/fopencookie/index.rst
create mode 100644 Documentation/applications/testing/fstest/index.rst
create mode 100644 Documentation/applications/testing/mm/index.rst
create mode 100644 Documentation/applications/testing/mtd_config_fs/index.rst
create mode 100644 Documentation/applications/testing/nxfss/index.rst
create mode 100644 Documentation/applications/testing/ostest/index.rst
create mode 100644 Documentation/applications/testing/smart/index.rst
create mode 100644 Documentation/applications/testing/smart_test/index.rst
create mode 100644 Documentation/applications/testing/smp/index.rst
create mode 100644 Documentation/applications/testing/unity/index.rst
[nuttx] 02/06: Documentaion: migrate fsutils/inifile readme
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit e8c135ba0c364e8b314f0d6d5afcc753c240367f
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 15:55:51 2023 +0200
Documentaion: migrate fsutils/inifile readme
---
Documentation/applications/fsutils/index.rst | 8 +-
.../applications/fsutils/inifile/index.rst | 146 +++++++++++++++++++++
2 files changed, 153 insertions(+), 1 deletion(-)
diff --git a/Documentation/applications/fsutils/index.rst b/Documentation/applications/fsutils/index.rst
index a24d54c3c8..965afc4adc 100644
--- a/Documentation/applications/fsutils/index.rst
+++ b/Documentation/applications/fsutils/index.rst
@@ -2,8 +2,14 @@
File System Utilities
=====================
+.. toctree::
+ :glob:
+ :maxdepth: 3
+ :titlesonly:
+
+ */*
+
- flash_eraseall - flash_eraseall() function
-- inifile - INI File Parser
- inih - inih ini file parser
- ipcfg - IP Configuration File Support
- libtinycbor - TinyCBOR Library (RFC 8949)
diff --git a/Documentation/applications/fsutils/inifile/index.rst b/Documentation/applications/fsutils/inifile/index.rst
new file mode 100644
index 0000000000..17ee17a227
--- /dev/null
+++ b/Documentation/applications/fsutils/inifile/index.rst
@@ -0,0 +1,146 @@
+===========================
+``inifile`` INI File Parser
+===========================
+
+Syntax
+------
+
+This directory contains a very simple INI file parser. An INI file consists of a
+sequence of lines up to the end of file. A line may be one of the following:
+
+1. A blank line.
+
+2. A comment line. Any line beginning with ``;``
+
+3. A section header. Definitions are divided into sections. Each section begins
+ with a line containing the section name enclosed in square brackets. For
+ example, ``[section1]``. The left bracket must be the first character on the
+ line. Section names are case insensitive, i.e., ``SECTION1`` and ``Section1``
+ refer to the same section.
+
+4. Variable assignments. A variable assignment is a variable name followed by
+ the ``=`` sign and then the value of the variable. For example, ``A=B``: ``A`` is
+ the variable name; ``B`` is the variable value. All variables following the
+ section header belong in the section.
+
+ Variable names may be preceded with white space. Whitespace is not permitted
+ before the ``=`` sign. Variable names are case insensitive, i.e., ``A`` and ``a``
+ refer to the same variable name.
+
+ Variable values may be numeric (any base) or a string. The case of string
+ arguments is preserved.
+
+Programming Interfaces
+----------------------
+
+See ``apps/include/fsutils/inifile.h`` for interfaces supported by the INI file
+parser.
+
+## Test Program
+
+Below is a simple test program:
+
+.. code-block:: C
+
+ int main(int argc, char *argv[])
+ {
+ INIHANDLE handle;
+ FILE *stream;
+ FAR char *ptr;
+ long value;
+
+ stream = fopen("/tmp/file.ini", "w");
+ fprintf(stream, "; Test INI file\n");
+ fprintf(stream, "[section1]\n");
+ fprintf(stream, " VAR1=1\n");
+ fprintf(stream, " VAR2=2\n");
+ fprintf(stream, " VAR3=3\n");
+ fprintf(stream, "\n");
+ fprintf(stream, "[section2]\n");
+ fprintf(stream, " VAR4=4\n");
+ fprintf(stream, " VAR5=5\n");
+ fprintf(stream, "VAR6=6\n");
+ fprintf(stream, "\n");
+ fclose(stream);
+
+ handle = inifile_initialize("/tmp/file.ini");
+
+ ptr = inifile_read_string(handle, "section2", "VAR5", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section2", "VAR5", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section1", "VAR2", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section1", "VAR2", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section3", "VAR3", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section3", "VAR3", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section1", "VAR3", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section1", "VAR3", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section1", "VAR1", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section1", "VAR1", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section1", "VAR42", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section1", "VAR42", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section2", "VAR6", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section2", "VAR6", ptr);
+ inifile_free_string(ptr);
+
+ ptr = inifile_read_string(handle, "section2", "VAR4", "OOPS");
+ printf("Section: %s Variable: %s String: %s\n", "section2", "VAR4", ptr);
+ inifile_free_string(ptr);
+
+ value = inifile_read_integer(handle, "section1", "VAR3", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section1", "VAR3", value);
+
+ value = inifile_read_integer(handle, "section3", "VAR3", 0);
+ printf("Section: %s Variable: %s String: %ld\n", "section3", "VAR3", value);
+
+ value = inifile_read_integer(handle, "section1", "VAR1", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section1", "VAR1", value);
+
+ value = inifile_read_integer(handle, "section2", "VAR5", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section2", "VAR5", value);
+
+ value = inifile_read_integer(handle, "section2", "VAR6", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section2", "VAR6", value);
+
+ value = inifile_read_integer(handle, "section1", "VAR42", 0);
+ printf("Section: %s Variable: %s String: %ld\n", "section1", "VAR42", value);
+
+ value = inifile_read_integer(handle, "section1", "VAR2", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section1", "VAR2", value);
+
+ value = inifile_read_integer(handle, "section2", "VAR4", 0);
+ printf("Section: %s Variable: %s Value: %ld\n", "section2", "VAR4", value);
+
+ inifile_uninitialize(handle);
+ return 0;
+ }
+
+Test program output::
+
+ Section: section2 Variable: VAR5 String: 5
+ Section: section1 Variable: VAR2 String: 2
+ Section: section3 Variable: VAR3 String: OOPS
+ Section: section1 Variable: VAR3 String: 3
+ Section: section1 Variable: VAR1 String: 1
+ Section: section1 Variable: VAR42 String: OOPS
+ Section: section2 Variable: VAR6 String: 6
+ Section: section2 Variable: VAR4 String: 4
+
+ Section: section1 Variable: VAR3 Value: 3
+ Section: section3 Variable: VAR3 Value: 0
+ Section: section1 Variable: VAR1 Value: 1
+ Section: section2 Variable: VAR5 Value: 5
+ Section: section2 Variable: VAR6 Value: 6
+ Section: section1 Variable: VAR42 String: 0
+ Section: section1 Variable: VAR2 Value: 2
+ Section: section2 Variable: VAR4 Value: 4
[nuttx] 04/06: Documentaion: migrate testing readmes
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit a342d2a7acca1c933fcc1e5d18ea805810ac92f0
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 16:13:45 2023 +0200
Documentaion: migrate testing readmes
---
.../applications/testing/arch_libc/index.rst | 13 +++++++++
.../applications/testing/cxxtest/index.rst | 29 +++++++++++++++++++
.../applications/testing/fopencookie/index.rst | 11 ++++++++
.../applications/testing/fstest/index.rst | 29 +++++++++++++++++++
Documentation/applications/testing/index.rst | 28 ++++++++++--------
Documentation/applications/testing/mm/index.rst | 5 ++++
.../applications/testing/mtd_config_fs/index.rst | 19 +++++++++++++
Documentation/applications/testing/nxfss/index.rst | 8 ++++++
.../applications/testing/ostest/index.rst | 33 ++++++++++++++++++++++
Documentation/applications/testing/smart/index.rst | 29 +++++++++++++++++++
.../applications/testing/smart_test/index.rst | 20 +++++++++++++
Documentation/applications/testing/smp/index.rst | 6 ++++
Documentation/applications/testing/unity/index.rst | 7 +++++
13 files changed, 225 insertions(+), 12 deletions(-)
diff --git a/Documentation/applications/testing/arch_libc/index.rst b/Documentation/applications/testing/arch_libc/index.rst
new file mode 100644
index 0000000000..f6b054fa9a
--- /dev/null
+++ b/Documentation/applications/testing/arch_libc/index.rst
@@ -0,0 +1,13 @@
+=======================================
+``arch_libc`` - Arch-specific libc Test
+=======================================
+
+This is a test for arch-specific libc function. Arch-specific libc functions are often implemented in
+assembly language, here is the test for these functions. The test focuses on key features in assembly
+language, including aligned access, speed, callee saved register check and so on.
+Currently, the test only contains a subset of possible arch-specific libc functions. You are welcomed
+to put more cases here.
+
+Options:
+- ``CONFIG_TESTING_ARCH_LIBC`` – Enable the test.
+- ``CONFIG_TESTING_ARCH_LIBC_XXXXX`` – Enable test for function XXXXX.
diff --git a/Documentation/applications/testing/cxxtest/index.rst b/Documentation/applications/testing/cxxtest/index.rst
new file mode 100644
index 0000000000..72ed911da3
--- /dev/null
+++ b/Documentation/applications/testing/cxxtest/index.rst
@@ -0,0 +1,29 @@
+==============================
+``cxxtest`` - C++ test program
+==============================
+
+This is a test of the C++ standard library. At present a port of the uClibc++
+C++ library is available. Due to licensing issues, the uClibc++ C++ library is
+not included in the NuttX source tree by default, but must be installed (see the
+``README.txt`` file in the uClibc++ download package for installation).
+
+The uClibc++ test includes simple test of:
+
+- iostreams,
+- STL,
+- RTTI, and
+- Exceptions
+
+### Example Configuration Options
+
+- ``CONFIG_TESTING_CXXTEST=y`` – Eanbles the example
+
+### Other Required Configuration Settings
+
+Other NuttX setting that are required include:
+
+- ``CONFIG_HAVE_CXX=y``
+- ``CONFIG_HAVE_CXXINITIALIZE=y``
+- ``CONFIG_UCLIBCXX=y`` or ``CONFIG_LIBCXX=y``
+
+Additional ``uClibc++/libcxx`` settings may be required in your build environment.
diff --git a/Documentation/applications/testing/fopencookie/index.rst b/Documentation/applications/testing/fopencookie/index.rst
new file mode 100644
index 0000000000..267d1cbcde
--- /dev/null
+++ b/Documentation/applications/testing/fopencookie/index.rst
@@ -0,0 +1,11 @@
+=======================================
+``fopencookie`` - fopencookie test tool
+=======================================
+
+``CONFIG_TESTING_SMART_TEST=y``
+
+Performs a basic operations with fopencookie call.
+
+Usage::
+
+ fopencookie
diff --git a/Documentation/applications/testing/fstest/index.rst b/Documentation/applications/testing/fstest/index.rst
new file mode 100644
index 0000000000..f830746c68
--- /dev/null
+++ b/Documentation/applications/testing/fstest/index.rst
@@ -0,0 +1,29 @@
+=====================================
+``fstest`` - Generic file system test
+=====================================
+
+This is a generic file system test that derives from ``testing/nxffs``. It was
+created to test the tmpfs file system, but should work with any file system
+provided that all initialization has already been performed prior to starting
+the test.
+
+This test a a general test for any file system, but includes some specific hooks
+for the SPIFFS file system.
+
+- ``CONFIG_TESTING_FSTEST`` – Enable the file system example.
+- ``CONFIG_TESTING_FSTEST_MAXNAME`` – Determines the maximum size of names used in
+ the filesystem.
+- ``CONFIG_TESTING_FSTEST_MAXFILE`` – Determines the maximum size of a file.
+- ``CONFIG_TESTING_FSTEST_MAXIO`` – Max I/O, default ``347``.
+- ``CONFIG_TESTING_FSTEST_MAXOPEN`` – Max open files.
+- ``CONFIG_TESTING_FSTEST_MOUNTPT`` – Path where the file system is mounted.
+- ``CONFIG_TESTING_FSTEST_NLOOPS`` – Number of test loops. default ``100``.
+- ``CONFIG_TESTING_FSTEST_VERBOSE`` – Verbose output.
+
+EXAMPLE::
+
+ fstest -m /mnt -n 10 – Test /mnt 10 times
+ fstest -h – Get help message
+ fstest – Test path define by `CONFIG_TESTING_FSTEST_MOUNTPT`
+ `CONFIG_TESTING_FSTEST_NLOOPS` times
+
diff --git a/Documentation/applications/testing/index.rst b/Documentation/applications/testing/index.rst
index f792593f28..8fbbbd2993 100644
--- a/Documentation/applications/testing/index.rst
+++ b/Documentation/applications/testing/index.rst
@@ -2,36 +2,40 @@
Testing
=======
-- arch_libc - arch-specific libc function test
+The ``apps/testing`` directory is used to build NuttX-specific tests and to
+include external testing frameworks.
+
+There is overlap between what you will find in ``apps/examples`` and
+``apps/testing`` in the sense that there are also tests in ``apps/examples`` as
+well. Those tests, however, can also be used to illustrate usage of a NuttX
+feature. Most of the tests in ``apps/testing``, on the other hand, are pure tests
+with little value as usage examples.
+
+.. toctree::
+ :glob:
+ :maxdepth: 3
+ :titlesonly:
+
+ */*
+
- atomic - "Test atomic" testing
- batterydump - Battery dump for test
- cmocka - libcmocka
- cpuload - cpuload test
- crypto - crypto test
-- cxxtest - C++ test program
- drivertest - vela cmocka driver test
- fatutf8 - FAT UTF8 test
- fdsantest - vela cmocka fdsan test
-- fopencookie - Fopencookie test tool
-- fstest - Generic file system test
- getprime - getprime example
- iozone - IOzone, filesystem benchmark tool
- irtest - IR driver test
- ltp - Linux Test Project
- memtester - utils_memtester
-- mm - Memory management test
- monkey - Monkey test
-- mtd_config_fs - MTD Config fail-safe storage test
- nist-sts - NIST Statistical Test Suite
-- nxffs - NXFFS file system example
- osperf - System performance profiling
-- ostest - OS test example
- scanftest - sscanf() test
- sensortest - Sensor driver test
- setest - Secure Element driver test
-- smart - SMART file system example
-- smart_test - SMART filesystem test tool
-- smp - SMP example
- superpi - SuperPI test
- uclibcxx_test - uclibcxx test
-- unity - Unity testing framework
diff --git a/Documentation/applications/testing/mm/index.rst b/Documentation/applications/testing/mm/index.rst
new file mode 100644
index 0000000000..564f54b221
--- /dev/null
+++ b/Documentation/applications/testing/mm/index.rst
@@ -0,0 +1,5 @@
+===============================
+``mm`` - Memory management test
+===============================
+
+This is a simple test of the memory manager.
diff --git a/Documentation/applications/testing/mtd_config_fs/index.rst b/Documentation/applications/testing/mtd_config_fs/index.rst
new file mode 100644
index 0000000000..fba289bf2f
--- /dev/null
+++ b/Documentation/applications/testing/mtd_config_fs/index.rst
@@ -0,0 +1,19 @@
+=========================================
+``mtd_nvs`` MTD non-volatile storage Test
+=========================================
+
+This is a test for MTD non-volatile storage. MTD non-volatile storage was originally
+implemented in Zephyr by Laczen. We made several modification to the original design.
+The main purpose of those modification was:
+
+1. support C-string key in nvs API(Original design only support uint16_t as key)
+2. Meanwhile achieve better performance by limiting flash read times(Theoratically
+ better than Zephyr subsys/settings, which is based on original NVS).
+
+Options:
+- ``CONFIG_TESTING_FAILSAFE_MTD_CONFIG`` – Enable the test.
+- ``CONFIG_TESTING_FAILSAFE_MTD_CONFIG_VERBOSE`` – Verbose output.
+
+EXAMPLE::
+ mtdconfig_fs_test -m /dev/config – Test MTD NVS on /dev/config
+ mtdconfig_fs_test -h – Get help message
diff --git a/Documentation/applications/testing/nxfss/index.rst b/Documentation/applications/testing/nxfss/index.rst
new file mode 100644
index 0000000000..92836060cd
--- /dev/null
+++ b/Documentation/applications/testing/nxfss/index.rst
@@ -0,0 +1,8 @@
+=====================================
+``nxffs`` - NXFFS file system example
+=====================================
+
+This is a test of the NuttX NXFFS FLASH file system. This is an NXFFS stress
+test and beats on the file system very hard. It should only be used in a
+simulation environment! Putting this NXFFS test on real hardware will most
+likely destroy your FLASH. You have been warned.
diff --git a/Documentation/applications/testing/ostest/index.rst b/Documentation/applications/testing/ostest/index.rst
new file mode 100644
index 0000000000..82905dd025
--- /dev/null
+++ b/Documentation/applications/testing/ostest/index.rst
@@ -0,0 +1,33 @@
+====================
+``ostest`` - OS test
+====================
+
+This is the NuttX _qualification_ suite. It attempts to exercise a broad set of
+OS functionality. Its coverage is not very extensive as of this writing, but it
+is used to qualify each NuttX release.
+
+The behavior of the ``ostest`` can be modified with the following settings in the
+``boards/<arch>/<chip>/<board>/configs/<config>/defconfig`` file:
+
+- ``CONFIG_NSH_BUILTIN_APPS`` – Build the OS test example as an NSH built-in
+ application.
+- ``CONFIG_TESTING_OSTEST_LOOPS`` – Used to control the number of executions of
+ the test. If undefined, the test executes one time. If defined to be zero,
+ the test runs forever.
+
+- ``CONFIG_TESTING_OSTEST_STACKSIZE`` – Used to create the ostest task. Default is
+ ``8192``.
+- ``CONFIG_TESTING_OSTEST_NBARRIER_THREADS`` – Specifies the number of threads to
+ create in the barrier test. The default is 8 but a smaller number may be
+ needed on systems without sufficient memory to start so many threads.
+
+- ``CONFIG_TESTING_OSTEST_RR_RANGE`` – During round-robin scheduling test two
+ threads are created. Each of the threads searches for prime numbers in the
+ configurable range, doing that configurable number of times. This value
+ specifies the end of search range and together with number of runs allows to
+ configure the length of this test – it should last at least a few tens of
+ seconds. Allowed values ``[1; 32767]``, default ``10000``.
+
+- ``CONFIG_TESTING_OSTEST_RR_RUNS`` – During round-robin scheduling test two
+ threads are created. Each of the threads searches for prime numbers in the
+ configurable range, doing that configurable number of times.
diff --git a/Documentation/applications/testing/smart/index.rst b/Documentation/applications/testing/smart/index.rst
new file mode 100644
index 0000000000..240f32c78b
--- /dev/null
+++ b/Documentation/applications/testing/smart/index.rst
@@ -0,0 +1,29 @@
+===========================
+``smart`` SMART File System
+===========================
+
+This is a test of the SMART file system that derives from ``testing/nxffs``.
+
+- ``CONFIG_TESTING_SMART`` – Enable the SMART file system example.
+
+- ``CONFIG_TESTING_SMART_ARCHINIT`` – The default is to use the RAM MTD device at
+ ``drivers/mtd/rammtd.c``. But an architecture-specific MTD driver can be used
+ instead by defining ``CONFIG_TESTING_SMART_ARCHINIT``. In this case, the
+ initialization logic will call ``smart_archinitialize()`` to obtain the MTD
+ driver instance.
+
+- ``CONFIG_TESTING_SMART_NEBLOCKS`` – When ``CONFIG_TESTING_SMART_ARCHINIT`` is not
+ defined, this test will use the RAM MTD device at ``drivers/mtd/rammtd.c`` to
+ simulate FLASH. In this case, this value must be provided to give the number
+ of erase blocks in MTD RAM device. The size of the allocated RAM drive will
+ be: ``CONFIG_RAMMTD_ERASESIZE * CONFIG_TESTING_SMART_NEBLOCKS``.
+
+- ``CONFIG_TESTING_SMART_MAXNAME`` – Determines the maximum size of names used in
+ the filesystem.
+
+- ``CONFIG_TESTING_SMART_MAXFILE`` – Determines the maximum size of a file.
+- ``CONFIG_TESTING_SMART_MAXIO`` – Max I/O, default ``347``.
+- ``CONFIG_TESTING_SMART_MAXOPEN`` – Max open files.
+- ``CONFIG_TESTING_SMART_MOUNTPT`` – SMART mountpoint.
+- ``CONFIG_TESTING_SMART_NLOOPS`` – Number of test loops. default ``100``.
+- ``CONFIG_TESTING_SMART_VERBOSE`` – Verbose output.
diff --git a/Documentation/applications/testing/smart_test/index.rst b/Documentation/applications/testing/smart_test/index.rst
new file mode 100644
index 0000000000..17297afb9b
--- /dev/null
+++ b/Documentation/applications/testing/smart_test/index.rst
@@ -0,0 +1,20 @@
+================================
+``smart_test`` SMART File System
+================================
+
+``CONFIG_TESTING_SMART_TEST=y``
+
+Author: Ken Pettit
+Date: April 24, 2013
+
+Performs a file-based test on a SMART (or any) filesystem. Validates seek,
+append and seek-with-write operations::
+
+ Usage:
+
+ flash_test mtdblock_device
+
+ Additional options:
+
+ --force to replace existing installation
+
diff --git a/Documentation/applications/testing/smp/index.rst b/Documentation/applications/testing/smp/index.rst
new file mode 100644
index 0000000000..2f47e487b3
--- /dev/null
+++ b/Documentation/applications/testing/smp/index.rst
@@ -0,0 +1,6 @@
+=====================
+``smp`` - SMP example
+=====================
+
+This is a simple test for SMP functionality. It is basically just the pthread
+barrier test with some custom instrumentation.
diff --git a/Documentation/applications/testing/unity/index.rst b/Documentation/applications/testing/unity/index.rst
new file mode 100644
index 0000000000..d483fee3a5
--- /dev/null
+++ b/Documentation/applications/testing/unity/index.rst
@@ -0,0 +1,7 @@
+===================================
+``unity`` - Unity testing framework
+===================================
+
+Unity is a unit testing framework for C developed by ThrowTheSwitch.org:
+
+http://www.throwtheswitch.org/unity
[nuttx] 05/06: Documentation/examples: add missing titles
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 731eaefba2542143abb0c06f3b508e126433eb83
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 18:58:34 2023 +0200
Documentation/examples: add missing titles
---
Documentation/applications/examples/ina226/index.rst | 4 ++--
Documentation/applications/examples/ini_dumper/index.rst | 4 ++--
Documentation/applications/examples/ipcfg/index.rst | 4 ++--
Documentation/applications/examples/lp503x/index.rst | 4 ++--
Documentation/applications/examples/ltr308/index.rst | 4 ++--
Documentation/applications/examples/lvgldemo/index.rst | 4 ++--
Documentation/applications/examples/max31855/index.rst | 4 ++--
Documentation/applications/examples/mcuboot/index.rst | 4 ++--
Documentation/applications/examples/media/index.rst | 4 ++--
Documentation/applications/examples/mld/index.rst | 4 ++--
Documentation/applications/examples/mlx90614/index.rst | 4 ++--
Documentation/applications/examples/mml_parser/index.rst | 4 ++--
Documentation/applications/examples/modbus/index.rst | 4 ++--
Documentation/applications/examples/modbusmaster/index.rst | 4 ++--
Documentation/applications/examples/mqttc/index.rst | 4 ++--
Documentation/applications/examples/netlink_route/index.rst | 4 ++--
Documentation/applications/examples/nimble/index.rst | 4 ++--
Documentation/applications/examples/nng_test/index.rst | 4 ++--
Documentation/applications/examples/noteprintf/index.rst | 4 ++--
Documentation/applications/examples/nrf24l01_btle/index.rst | 4 ++--
Documentation/applications/examples/null/index.rst | 4 ++--
Documentation/applications/examples/nx/index.rst | 4 ++--
Documentation/applications/examples/nxdemo/index.rst | 4 ++--
Documentation/applications/examples/nxhello/index.rst | 4 ++--
Documentation/applications/examples/nxscope/index.rst | 4 ++--
Documentation/applications/examples/obd2/index.rst | 4 ++--
Documentation/applications/examples/opencyphal/index.rst | 4 ++--
Documentation/applications/examples/pdcurses/index.rst | 4 ++--
Documentation/applications/examples/pf_ieee802154/index.rst | 4 ++--
Documentation/applications/examples/pipe/index.rst | 4 ++--
Documentation/applications/examples/poll/index.rst | 4 ++--
Documentation/applications/examples/popen/index.rst | 4 ++--
Documentation/applications/examples/posix_spawn/index.rst | 4 ++--
Documentation/applications/examples/powerled/index.rst | 4 ++--
Documentation/applications/examples/pppd/index.rst | 4 ++--
Documentation/applications/examples/pwfb/index.rst | 4 ++--
Documentation/applications/examples/pwlines/index.rst | 4 ++--
Documentation/applications/examples/rpmsgsocket/index.rst | 4 ++--
Documentation/applications/examples/serialblaster/index.rst | 4 ++--
Documentation/applications/examples/serialrx/index.rst | 4 ++--
Documentation/applications/examples/shm_test/index.rst | 4 ++--
Documentation/applications/examples/sht3x/index.rst | 4 ++--
Documentation/applications/examples/stat/index.rst | 4 ++--
Documentation/applications/examples/sx127x_demo/index.rst | 4 ++--
Documentation/applications/examples/system/index.rst | 4 ++--
Documentation/applications/examples/tcp_ipc_client/index.rst | 4 ++--
Documentation/applications/examples/tcp_ipc_server/index.rst | 4 ++--
Documentation/applications/examples/tiff/index.rst | 4 ++--
Documentation/applications/examples/timer/index.rst | 4 ++--
Documentation/applications/examples/timer_gpio/index.rst | 4 ++--
Documentation/applications/examples/udgram/index.rst | 4 ++--
Documentation/applications/examples/udpblaster/index.rst | 4 ++--
Documentation/applications/examples/uid/index.rst | 4 ++--
Documentation/applications/examples/usrsocktest/index.rst | 4 ++--
Documentation/applications/examples/veml6070/index.rst | 4 ++--
Documentation/applications/examples/wiegand/index.rst | 4 ++--
Documentation/applications/examples/ws2812/index.rst | 4 ++--
Documentation/applications/examples/ws2812esp32rmt/index.rst | 4 ++--
Documentation/applications/examples/xbc_test/index.rst | 4 ++--
59 files changed, 118 insertions(+), 118 deletions(-)
diff --git a/Documentation/applications/examples/ina226/index.rst b/Documentation/applications/examples/ina226/index.rst
index fea20e31d0..dff8c9a004 100644
--- a/Documentation/applications/examples/ina226/index.rst
+++ b/Documentation/applications/examples/ina226/index.rst
@@ -1,4 +1,4 @@
-``ina226``
-==========
+``ina226`` Current/Power Monitor INA219
+======================================
TODO
diff --git a/Documentation/applications/examples/ini_dumper/index.rst b/Documentation/applications/examples/ini_dumper/index.rst
index 0320eb02e9..333534d4b7 100644
--- a/Documentation/applications/examples/ini_dumper/index.rst
+++ b/Documentation/applications/examples/ini_dumper/index.rst
@@ -1,4 +1,4 @@
-``ini_dumper``
-==============
+``ini_dumper`` ini dumper example
+=================================
TODO
diff --git a/Documentation/applications/examples/ipcfg/index.rst b/Documentation/applications/examples/ipcfg/index.rst
index c6d3dcd705..daffe8ebef 100644
--- a/Documentation/applications/examples/ipcfg/index.rst
+++ b/Documentation/applications/examples/ipcfg/index.rst
@@ -1,4 +1,4 @@
-``ipcfg``
-=========
+``ipcfg`` IP Configuration file example
+=======================================
TODO
diff --git a/Documentation/applications/examples/lp503x/index.rst b/Documentation/applications/examples/lp503x/index.rst
index 64da9b69c0..3a22466199 100644
--- a/Documentation/applications/examples/lp503x/index.rst
+++ b/Documentation/applications/examples/lp503x/index.rst
@@ -1,4 +1,4 @@
-``lp503x``
-===========
+``lp503x`` LP503X PWM LED example
+================================
TODO
diff --git a/Documentation/applications/examples/ltr308/index.rst b/Documentation/applications/examples/ltr308/index.rst
index ef372e0d6f..035dc49b75 100644
--- a/Documentation/applications/examples/ltr308/index.rst
+++ b/Documentation/applications/examples/ltr308/index.rst
@@ -1,4 +1,4 @@
-``ltr308``
-===========
+``ltr308`` LTR308 ambient light sensor example
+==============================================
TODO
diff --git a/Documentation/applications/examples/lvgldemo/index.rst b/Documentation/applications/examples/lvgldemo/index.rst
index c202e55125..176c2286ec 100644
--- a/Documentation/applications/examples/lvgldemo/index.rst
+++ b/Documentation/applications/examples/lvgldemo/index.rst
@@ -1,4 +1,4 @@
-``lvgldemo``
-============
+``lvgldemo`` LVGL Demo
+=====================
TODO
diff --git a/Documentation/applications/examples/max31855/index.rst b/Documentation/applications/examples/max31855/index.rst
index ecf20d814b..93e7b67b43 100644
--- a/Documentation/applications/examples/max31855/index.rst
+++ b/Documentation/applications/examples/max31855/index.rst
@@ -1,4 +1,4 @@
-``max31855``
-============
+``max31855`` max31855 example
+=============================
TODO
diff --git a/Documentation/applications/examples/mcuboot/index.rst b/Documentation/applications/examples/mcuboot/index.rst
index 087144e1f8..2b7176c34c 100644
--- a/Documentation/applications/examples/mcuboot/index.rst
+++ b/Documentation/applications/examples/mcuboot/index.rst
@@ -1,5 +1,5 @@
-``mcuboot``
-===========
+``mcuboot`` MCUboot examples
+============================
``swap_test``
-------------
diff --git a/Documentation/applications/examples/media/index.rst b/Documentation/applications/examples/media/index.rst
index d85522a0c9..66aa17a689 100644
--- a/Documentation/applications/examples/media/index.rst
+++ b/Documentation/applications/examples/media/index.rst
@@ -1,5 +1,5 @@
-``media``
-=========
+``media`` Media test
+====================
The media test simply writes values onto the media hidden behind a character
driver and verifies that the media can be successfully written and read. This
diff --git a/Documentation/applications/examples/mld/index.rst b/Documentation/applications/examples/mld/index.rst
index 6718f8d9a0..48dde4eab1 100644
--- a/Documentation/applications/examples/mld/index.rst
+++ b/Documentation/applications/examples/mld/index.rst
@@ -1,4 +1,4 @@
-``mld``
-=======
+``mld`` MLD example
+==================
TODO
diff --git a/Documentation/applications/examples/mlx90614/index.rst b/Documentation/applications/examples/mlx90614/index.rst
index ee5ff86500..c568e52df8 100644
--- a/Documentation/applications/examples/mlx90614/index.rst
+++ b/Documentation/applications/examples/mlx90614/index.rst
@@ -1,4 +1,4 @@
-``mlx90614``
-============
+``mlx90614`` MLX90614 Test Example
+==================================
TODO
diff --git a/Documentation/applications/examples/mml_parser/index.rst b/Documentation/applications/examples/mml_parser/index.rst
index db9041df77..24bac56598 100644
--- a/Documentation/applications/examples/mml_parser/index.rst
+++ b/Documentation/applications/examples/mml_parser/index.rst
@@ -1,4 +1,4 @@
-``mml_parser``
-==============
+``mml_parser`` MML parser example
+=================================
TODO
diff --git a/Documentation/applications/examples/modbus/index.rst b/Documentation/applications/examples/modbus/index.rst
index fef63bc10d..cd436cefe8 100644
--- a/Documentation/applications/examples/modbus/index.rst
+++ b/Documentation/applications/examples/modbus/index.rst
@@ -1,5 +1,5 @@
-``modbus`` FreeModbus
-=====================
+``modbus`` FreeModbus demo example
+==================================
This is a port of the FreeModbus Linux demo. It derives from the demos/LINUX
directory of the FreeModBus version ``1.5.0`` (June 6, 2010) that can be
diff --git a/Documentation/applications/examples/modbusmaster/index.rst b/Documentation/applications/examples/modbusmaster/index.rst
index f7d573dcaa..87e65f6561 100644
--- a/Documentation/applications/examples/modbusmaster/index.rst
+++ b/Documentation/applications/examples/modbusmaster/index.rst
@@ -1,4 +1,4 @@
-``modbusmaster``
-================
+``modbusmaster`` Modbus Master example
+======================================
TODO
diff --git a/Documentation/applications/examples/mqttc/index.rst b/Documentation/applications/examples/mqttc/index.rst
index e33eadc75b..c411ffabe1 100644
--- a/Documentation/applications/examples/mqttc/index.rst
+++ b/Documentation/applications/examples/mqttc/index.rst
@@ -1,5 +1,5 @@
-``mqttc``
-=========
+``mqttc`` MQTT-C Example
+========================
This is a simple MQTT publisher example using MQTT-C
diff --git a/Documentation/applications/examples/netlink_route/index.rst b/Documentation/applications/examples/netlink_route/index.rst
index 1a6ffff4b3..3ec0219e93 100644
--- a/Documentation/applications/examples/netlink_route/index.rst
+++ b/Documentation/applications/examples/netlink_route/index.rst
@@ -1,4 +1,4 @@
-``netlink_route``
-=================
+``netlink_route`` Netlink NETLINK_ROUTE test
+============================================
TODO
diff --git a/Documentation/applications/examples/nimble/index.rst b/Documentation/applications/examples/nimble/index.rst
index 65ef4e7758..d24a18b4e7 100644
--- a/Documentation/applications/examples/nimble/index.rst
+++ b/Documentation/applications/examples/nimble/index.rst
@@ -1,4 +1,4 @@
-``nimble``
-==========
+``nimble`` NimBLE example
+=========================
TODO
diff --git a/Documentation/applications/examples/nng_test/index.rst b/Documentation/applications/examples/nng_test/index.rst
index 567fbf1253..244089f0c9 100644
--- a/Documentation/applications/examples/nng_test/index.rst
+++ b/Documentation/applications/examples/nng_test/index.rst
@@ -1,4 +1,4 @@
-``nng_test``
-============
+``nng_test`` NNG pubsub program
+===============================
TODO
diff --git a/Documentation/applications/examples/noteprintf/index.rst b/Documentation/applications/examples/noteprintf/index.rst
index bb20f177ee..4df7eb8238 100644
--- a/Documentation/applications/examples/noteprintf/index.rst
+++ b/Documentation/applications/examples/noteprintf/index.rst
@@ -1,4 +1,4 @@
-``noteprintf``
-==============
+``noteprintf`` "Note printf!" example
+=====================================
TODO
diff --git a/Documentation/applications/examples/nrf24l01_btle/index.rst b/Documentation/applications/examples/nrf24l01_btle/index.rst
index 475d5e0a8a..302115c46c 100644
--- a/Documentation/applications/examples/nrf24l01_btle/index.rst
+++ b/Documentation/applications/examples/nrf24l01_btle/index.rst
@@ -1,4 +1,4 @@
-``nrf24l01_btle``
-=================
+``nrf24l01_btle`` Emulates a nRF8001 temperature beacon with nRF24L01
+=====================================================================
TODO
diff --git a/Documentation/applications/examples/null/index.rst b/Documentation/applications/examples/null/index.rst
index 0eefcebeaf..6cd0880bc5 100644
--- a/Documentation/applications/examples/null/index.rst
+++ b/Documentation/applications/examples/null/index.rst
@@ -1,5 +1,5 @@
-``null``
-========
+``null`` NULL example
+=====================
This is the do nothing application. It is only used for bringing up new NuttX
architectures in the most minimal of environments.
diff --git a/Documentation/applications/examples/nx/index.rst b/Documentation/applications/examples/nx/index.rst
index a561cf9de3..e5b8dff3c0 100644
--- a/Documentation/applications/examples/nx/index.rst
+++ b/Documentation/applications/examples/nx/index.rst
@@ -1,5 +1,5 @@
-``nx``
-======
+``nx`` NX graphics example
+==========================
This directory contains a simple test of a subset of the NX APIs defined in
``include/nuttx/nx/nx.h``. The following configuration options can be selected:
diff --git a/Documentation/applications/examples/nxdemo/index.rst b/Documentation/applications/examples/nxdemo/index.rst
index c3cf6352e7..bc18d203bb 100644
--- a/Documentation/applications/examples/nxdemo/index.rst
+++ b/Documentation/applications/examples/nxdemo/index.rst
@@ -1,4 +1,4 @@
-``nxdemo``
-==========
+``nxdemo`` NX Demo "Graphic test" example
+=========================================
TODO
diff --git a/Documentation/applications/examples/nxhello/index.rst b/Documentation/applications/examples/nxhello/index.rst
index 152da5c96f..fc85ab8f0f 100644
--- a/Documentation/applications/examples/nxhello/index.rst
+++ b/Documentation/applications/examples/nxhello/index.rst
@@ -1,5 +1,5 @@
-``nxhello``
-===========
+``nxhello`` NX graphics "Hello, World!" example
+===============================================
A very simple graphics example that just says Hello, World! in the center of
the display.
diff --git a/Documentation/applications/examples/nxscope/index.rst b/Documentation/applications/examples/nxscope/index.rst
index cd6fc11dd8..9aef08145a 100644
--- a/Documentation/applications/examples/nxscope/index.rst
+++ b/Documentation/applications/examples/nxscope/index.rst
@@ -1,4 +1,4 @@
-``nxscope``
-===========
+``nxscope`` NxScope library example
+===================================
TODO
diff --git a/Documentation/applications/examples/obd2/index.rst b/Documentation/applications/examples/obd2/index.rst
index 4c5c7e6a6f..58ed454276 100644
--- a/Documentation/applications/examples/obd2/index.rst
+++ b/Documentation/applications/examples/obd2/index.rst
@@ -1,4 +1,4 @@
-``obd2``
-========
+``obd2`` OBD-II application example
+===================================
A simple test of ``apps/canutils/libobd2``.
diff --git a/Documentation/applications/examples/opencyphal/index.rst b/Documentation/applications/examples/opencyphal/index.rst
index 465c11b464..d907954525 100644
--- a/Documentation/applications/examples/opencyphal/index.rst
+++ b/Documentation/applications/examples/opencyphal/index.rst
@@ -1,4 +1,4 @@
-``opencyphal``
-==============
+``opencyphal`` OpenCyphal Cyphal/CAN example
+============================================
TODO
diff --git a/Documentation/applications/examples/pdcurses/index.rst b/Documentation/applications/examples/pdcurses/index.rst
index 9ceb8801a0..d71ab91282 100644
--- a/Documentation/applications/examples/pdcurses/index.rst
+++ b/Documentation/applications/examples/pdcurses/index.rst
@@ -1,5 +1,5 @@
-``pdcurses``
-============
+``pdcurses`` pdcurses demos
+===========================
This directory contains demonstration programs to show and test the capabilities
of ``pdcurses`` libraries. Some of them predate PDCurses, PCcurses or even
diff --git a/Documentation/applications/examples/pf_ieee802154/index.rst b/Documentation/applications/examples/pf_ieee802154/index.rst
index a097706fe3..0bd0d8d656 100644
--- a/Documentation/applications/examples/pf_ieee802154/index.rst
+++ b/Documentation/applications/examples/pf_ieee802154/index.rst
@@ -1,4 +1,4 @@
-``pf_ieee802154``
-=================
+``pf_ieee802154`` PF_IEEE802154 example
+======================================
TODO
diff --git a/Documentation/applications/examples/pipe/index.rst b/Documentation/applications/examples/pipe/index.rst
index f65f2c914e..ab1af3dae1 100644
--- a/Documentation/applications/examples/pipe/index.rst
+++ b/Documentation/applications/examples/pipe/index.rst
@@ -1,5 +1,5 @@
-``pipe``
-========
+``pipe`` Pipe example
+=====================
A test of the ``mkfifo()`` and ``pipe()`` APIs. Requires ``CONFIG_PIPES``
diff --git a/Documentation/applications/examples/poll/index.rst b/Documentation/applications/examples/poll/index.rst
index 96c87898fc..f277e6dd6f 100644
--- a/Documentation/applications/examples/poll/index.rst
+++ b/Documentation/applications/examples/poll/index.rst
@@ -1,5 +1,5 @@
-``poll``
-========
+``poll`` Poll example
+=====================
A test of the ``poll()`` and ``select()`` APIs using FIFOs and, if available,
``stdin``, and a TCP/IP socket. In order to use the TCP/IP select test, you must
diff --git a/Documentation/applications/examples/popen/index.rst b/Documentation/applications/examples/popen/index.rst
index 5f3ec21aa5..978a1a7642 100644
--- a/Documentation/applications/examples/popen/index.rst
+++ b/Documentation/applications/examples/popen/index.rst
@@ -1,4 +1,4 @@
-``popen``
-=========
+``popen`` popen() example
+=========================
TODO
diff --git a/Documentation/applications/examples/posix_spawn/index.rst b/Documentation/applications/examples/posix_spawn/index.rst
index 01288d7eac..57de02a7cc 100644
--- a/Documentation/applications/examples/posix_spawn/index.rst
+++ b/Documentation/applications/examples/posix_spawn/index.rst
@@ -1,5 +1,5 @@
-``posix_spawn``
-===============
+``posix_spawn`` posix_spawn Unit Test
+=====================================
This is a simple test of the ``posix_spawn()`` API. The example derives from
``examples/elf``. As a result, these tests are built using the relocatable ELF
diff --git a/Documentation/applications/examples/powerled/index.rst b/Documentation/applications/examples/powerled/index.rst
index ae55179377..b05f1ec673 100644
--- a/Documentation/applications/examples/powerled/index.rst
+++ b/Documentation/applications/examples/powerled/index.rst
@@ -1,5 +1,5 @@
-``powerled``
-============
+``powerled`` Powerled driver example
+====================================
This is a powerled driver example application. This application support three
operation modes which can be selected from NSH command line:
diff --git a/Documentation/applications/examples/pppd/index.rst b/Documentation/applications/examples/pppd/index.rst
index 306b0e24c7..bcccc75768 100644
--- a/Documentation/applications/examples/pppd/index.rst
+++ b/Documentation/applications/examples/pppd/index.rst
@@ -1,4 +1,4 @@
-``pppd``
-========
+``pppd`` pppd client example
+============================
TODO
diff --git a/Documentation/applications/examples/pwfb/index.rst b/Documentation/applications/examples/pwfb/index.rst
index 9176065f10..4df0fb80dd 100644
--- a/Documentation/applications/examples/pwfb/index.rst
+++ b/Documentation/applications/examples/pwfb/index.rst
@@ -1,5 +1,5 @@
-``pwfb``
-========
+``pwfb`` NX Per-Window Framebuffer Text Example
+===============================================
A graphics example using pre-window frame buffers. The example shows three
windows containing text moving around, crossing each other from above and from
diff --git a/Documentation/applications/examples/pwlines/index.rst b/Documentation/applications/examples/pwlines/index.rst
index c21547b52f..16ce0b776a 100644
--- a/Documentation/applications/examples/pwlines/index.rst
+++ b/Documentation/applications/examples/pwlines/index.rst
@@ -1,4 +1,4 @@
-``pwlines``
-===========
+``pwlines`` NX Per-Window Framebuffer Graphics Example
+======================================================
TODO
diff --git a/Documentation/applications/examples/rpmsgsocket/index.rst b/Documentation/applications/examples/rpmsgsocket/index.rst
index 1a5400f3bc..f28707c457 100644
--- a/Documentation/applications/examples/rpmsgsocket/index.rst
+++ b/Documentation/applications/examples/rpmsgsocket/index.rst
@@ -1,4 +1,4 @@
-``rpmsgsocket``
-===============
+``rpmsgsocket`` Rpmsg socket example
+====================================
TODO
diff --git a/Documentation/applications/examples/serialblaster/index.rst b/Documentation/applications/examples/serialblaster/index.rst
index 67ca1471b9..6b56449538 100644
--- a/Documentation/applications/examples/serialblaster/index.rst
+++ b/Documentation/applications/examples/serialblaster/index.rst
@@ -1,5 +1,5 @@
-``serialblaster``
-=================
+``serialblaster`` Serial Blaster example
+========================================
Sends a repeating pattern (the alphabet) out a serial port continuously. This
may be useful if you are trying run down other problems that you think might
diff --git a/Documentation/applications/examples/serialrx/index.rst b/Documentation/applications/examples/serialrx/index.rst
index 1592e1b545..a7eb9bf823 100644
--- a/Documentation/applications/examples/serialrx/index.rst
+++ b/Documentation/applications/examples/serialrx/index.rst
@@ -1,5 +1,5 @@
-``serialrx``
-============
+``serialrx`` Serial RX example
+==============================
Constant receives serial data. This is the complement to ``serialblaster``. This
may be useful if you are trying run down other problems that you think might
diff --git a/Documentation/applications/examples/shm_test/index.rst b/Documentation/applications/examples/shm_test/index.rst
index fedfb0f2d1..3ca80dc791 100644
--- a/Documentation/applications/examples/shm_test/index.rst
+++ b/Documentation/applications/examples/shm_test/index.rst
@@ -1,4 +1,4 @@
-``shm_test``
-============
+``shm_test`` SHM example
+========================
TODO
diff --git a/Documentation/applications/examples/sht3x/index.rst b/Documentation/applications/examples/sht3x/index.rst
index c7932e5d6c..96a6d087a2 100644
--- a/Documentation/applications/examples/sht3x/index.rst
+++ b/Documentation/applications/examples/sht3x/index.rst
@@ -1,4 +1,4 @@
-``sht3x``
-=========
+``sht3x`` SHT3x sensor example
+==============================
TODO
diff --git a/Documentation/applications/examples/stat/index.rst b/Documentation/applications/examples/stat/index.rst
index 053a43b803..94f64fd30a 100644
--- a/Documentation/applications/examples/stat/index.rst
+++ b/Documentation/applications/examples/stat/index.rst
@@ -1,5 +1,5 @@
-``stat``
-========
+``stat`` Test of stat(), fstat(), and statfs()
+==============================================
A simple test of ``stat()``, ``fstat()``, and ``statfs()``. This is useful primarily
for bringing up a new file system and verifying the correctness of these
diff --git a/Documentation/applications/examples/sx127x_demo/index.rst b/Documentation/applications/examples/sx127x_demo/index.rst
index fc4c725793..41b823a0bb 100644
--- a/Documentation/applications/examples/sx127x_demo/index.rst
+++ b/Documentation/applications/examples/sx127x_demo/index.rst
@@ -1,4 +1,4 @@
-``sx127x_demo`` ``SX127X`` Radio
-================================
+``sx127x_demo`` SX127X Radio
+============================
This example demonstrates the use of the ``SX127X`` radio.
diff --git a/Documentation/applications/examples/system/index.rst b/Documentation/applications/examples/system/index.rst
index 6b3ffaf2ff..da84bb2ba1 100644
--- a/Documentation/applications/examples/system/index.rst
+++ b/Documentation/applications/examples/system/index.rst
@@ -1,5 +1,5 @@
-``system``
-==========
+``system`` System() example
+===========================
This is a simple test of the ``system()`` command. The test simply executes this
``system`` command:
diff --git a/Documentation/applications/examples/tcp_ipc_client/index.rst b/Documentation/applications/examples/tcp_ipc_client/index.rst
index f70d0f62bf..13e285ef52 100644
--- a/Documentation/applications/examples/tcp_ipc_client/index.rst
+++ b/Documentation/applications/examples/tcp_ipc_client/index.rst
@@ -1,5 +1,5 @@
-``tcp_ipc_client``
-==================
+``tcp_ipc_client`` Client for TCP IPC NuttX
+===========================================
What's this?
------------
diff --git a/Documentation/applications/examples/tcp_ipc_server/index.rst b/Documentation/applications/examples/tcp_ipc_server/index.rst
index b176e5546e..f4eb0c42a2 100644
--- a/Documentation/applications/examples/tcp_ipc_server/index.rst
+++ b/Documentation/applications/examples/tcp_ipc_server/index.rst
@@ -1,5 +1,5 @@
-``tcp_ipc_server``
-==================
+``tcp_ipc_server`` Server for TCP IPC NuttX
+===========================================
What's this?
------------
diff --git a/Documentation/applications/examples/tiff/index.rst b/Documentation/applications/examples/tiff/index.rst
index bad9860f70..26b0eed7e6 100644
--- a/Documentation/applications/examples/tiff/index.rst
+++ b/Documentation/applications/examples/tiff/index.rst
@@ -1,5 +1,5 @@
-``tiff``
-========
+``tiff`` TIFF file generation example
+=====================================
This is a simple unit test for the TIFF creation library at ``apps/graphic/tiff``.
It is configured to work in the Linux user-mode simulation and has not been
diff --git a/Documentation/applications/examples/timer/index.rst b/Documentation/applications/examples/timer/index.rst
index ec17e01360..3352a92122 100644
--- a/Documentation/applications/examples/timer/index.rst
+++ b/Documentation/applications/examples/timer/index.rst
@@ -1,5 +1,5 @@
-``timer``
-=========
+``timer`` Timer example
+=======================
This is a simple test of the timer driver (see ``include/nuttx/timers/timer.h``).
diff --git a/Documentation/applications/examples/timer_gpio/index.rst b/Documentation/applications/examples/timer_gpio/index.rst
index 30d14b740e..77cb1e2357 100644
--- a/Documentation/applications/examples/timer_gpio/index.rst
+++ b/Documentation/applications/examples/timer_gpio/index.rst
@@ -1,5 +1,5 @@
-``timer_gpio``
-==============
+``timer_gpio`` Timer GPIO example
+=================================
This example uses the timer interrupt to periodically change the state of a
digital output. The digital output may be a relay, a led or anything else.
diff --git a/Documentation/applications/examples/udgram/index.rst b/Documentation/applications/examples/udgram/index.rst
index 1e3ffe2efb..36326b5493 100644
--- a/Documentation/applications/examples/udgram/index.rst
+++ b/Documentation/applications/examples/udgram/index.rst
@@ -1,4 +1,4 @@
-``udgram``
-==========
+``udgram`` Unix domain datagram example
+=======================================
TODO
diff --git a/Documentation/applications/examples/udpblaster/index.rst b/Documentation/applications/examples/udpblaster/index.rst
index 096727a8d5..c7ad4e6edc 100644
--- a/Documentation/applications/examples/udpblaster/index.rst
+++ b/Documentation/applications/examples/udpblaster/index.rst
@@ -1,5 +1,5 @@
-``udpblaster``
-==============
+``udpblaster`` UDP blaster example
+==================================
This is a simple network test for stressing UDP transfers. It simply sends UDP
packets from both the host and the target and the highest possible rate.
diff --git a/Documentation/applications/examples/uid/index.rst b/Documentation/applications/examples/uid/index.rst
index 43411c2e07..7e44434d31 100644
--- a/Documentation/applications/examples/uid/index.rst
+++ b/Documentation/applications/examples/uid/index.rst
@@ -1,4 +1,4 @@
-``uid``
-=======
+``uid`` UID/GID example
+=======================
TODO
diff --git a/Documentation/applications/examples/usrsocktest/index.rst b/Documentation/applications/examples/usrsocktest/index.rst
index da391ad2bb..3b7370087f 100644
--- a/Documentation/applications/examples/usrsocktest/index.rst
+++ b/Documentation/applications/examples/usrsocktest/index.rst
@@ -1,4 +1,4 @@
-``usrsocktest``
-===============
+``usrsocktest`` USRSOCK test example
+===================================
TODO
diff --git a/Documentation/applications/examples/veml6070/index.rst b/Documentation/applications/examples/veml6070/index.rst
index a6ede63452..6409090d3a 100644
--- a/Documentation/applications/examples/veml6070/index.rst
+++ b/Documentation/applications/examples/veml6070/index.rst
@@ -1,4 +1,4 @@
-``veml6070``
-============
+``veml6070`` VEML6070 UltraViolet sensor example
+================================================
TODO
diff --git a/Documentation/applications/examples/wiegand/index.rst b/Documentation/applications/examples/wiegand/index.rst
index 3898fdc26a..ee3bdd50ae 100644
--- a/Documentation/applications/examples/wiegand/index.rst
+++ b/Documentation/applications/examples/wiegand/index.rst
@@ -1,4 +1,4 @@
-``wiegand``
-===========
+``wiegand`` Wiegand example
+===========================
TODO
diff --git a/Documentation/applications/examples/ws2812/index.rst b/Documentation/applications/examples/ws2812/index.rst
index 31b405240b..671c2f8c44 100644
--- a/Documentation/applications/examples/ws2812/index.rst
+++ b/Documentation/applications/examples/ws2812/index.rst
@@ -1,4 +1,4 @@
-``ws2812``
-==========
+``ws2812`` ws2812 Demo
+======================
TODO
diff --git a/Documentation/applications/examples/ws2812esp32rmt/index.rst b/Documentation/applications/examples/ws2812esp32rmt/index.rst
index c49cf21aa7..5e2897c6c8 100644
--- a/Documentation/applications/examples/ws2812esp32rmt/index.rst
+++ b/Documentation/applications/examples/ws2812esp32rmt/index.rst
@@ -1,4 +1,4 @@
-``ws2812esp32rmt``
-==================
+``ws2812esp32rmt`` ws2812 Demo using ESP32_RMT
+==============================================
TODO
diff --git a/Documentation/applications/examples/xbc_test/index.rst b/Documentation/applications/examples/xbc_test/index.rst
index eda6232336..4235670f36 100644
--- a/Documentation/applications/examples/xbc_test/index.rst
+++ b/Documentation/applications/examples/xbc_test/index.rst
@@ -1,4 +1,4 @@
-``xbc_test``
-============
+``xbc_test`` XBox Controller Example
+====================================
TODO
[nuttx] 06/06: Documentation/examples: format the first header as in other files
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 24bc270d82fc83a3929d12496cf37f426a486e3c
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 19:21:37 2023 +0200
Documentation/examples: format the first header as in other files
---
Documentation/applications/examples/abntcodi/index.rst | 1 +
Documentation/applications/examples/adc/index.rst | 1 +
Documentation/applications/examples/adjtime/index.rst | 1 +
Documentation/applications/examples/adxl372_test/index.rst | 1 +
Documentation/applications/examples/ajoystick/index.rst | 1 +
Documentation/applications/examples/alarm/index.rst | 1 +
Documentation/applications/examples/apa102/index.rst | 1 +
Documentation/applications/examples/apds9960/index.rst | 1 +
Documentation/applications/examples/audio_rttl/index.rst | 1 +
Documentation/applications/examples/bastest/index.rst | 1 +
Documentation/applications/examples/battery/index.rst | 1 +
Documentation/applications/examples/bme680/index.rst | 1 +
Documentation/applications/examples/bmi160/index.rst | 1 +
Documentation/applications/examples/bmp180/index.rst | 1 +
Documentation/applications/examples/bmp280/index.rst | 1 +
Documentation/applications/examples/bridge/index.rst | 1 +
Documentation/applications/examples/buttons/index.rst | 1 +
Documentation/applications/examples/calib_udelay/index.rst | 1 +
Documentation/applications/examples/camera/index.rst | 1 +
Documentation/applications/examples/can/index.rst | 1 +
Documentation/applications/examples/capture/index.rst | 1 +
Documentation/applications/examples/cbortest/index.rst | 1 +
Documentation/applications/examples/cctype/index.rst | 1 +
Documentation/applications/examples/chat/index.rst | 1 +
Documentation/applications/examples/chrono/index.rst | 1 +
Documentation/applications/examples/configdata/index.rst | 1 +
Documentation/applications/examples/cordic/index.rst | 1 +
Documentation/applications/examples/cpuhog/index.rst | 1 +
Documentation/applications/examples/cromfs/index.rst | 1 +
Documentation/applications/examples/dac/index.rst | 1 +
Documentation/applications/examples/dhcpd/index.rst | 1 +
Documentation/applications/examples/discover/index.rst | 1 +
Documentation/applications/examples/djoystick/index.rst | 1 +
Documentation/applications/examples/dronecan/index.rst | 1 +
Documentation/applications/examples/elf/index.rst | 1 +
Documentation/applications/examples/embedlog/index.rst | 1 +
Documentation/applications/examples/esp32_himem/index.rst | 1 +
Documentation/applications/examples/etl/index.rst | 1 +
Documentation/applications/examples/fb/index.rst | 1 +
Documentation/applications/examples/fboverlay/index.rst | 1 +
Documentation/applications/examples/flash_test/index.rst | 1 +
Documentation/applications/examples/flowc/index.rst | 1 +
Documentation/applications/examples/fmsynth/index.rst | 1 +
Documentation/applications/examples/foc/index.rst | 1 +
Documentation/applications/examples/ft80x/index.rst | 1 +
Documentation/applications/examples/ftpc/index.rst | 1 +
Documentation/applications/examples/ftpd/index.rst | 1 +
Documentation/applications/examples/fxos8700cq_test/index.rst | 1 +
Documentation/applications/examples/gpio/index.rst | 3 ++-
Documentation/applications/examples/gps/index.rst | 1 +
Documentation/applications/examples/hall/index.rst | 1 +
Documentation/applications/examples/hdc1008_demo/index.rst | 1 +
Documentation/applications/examples/hello/index.rst | 1 +
Documentation/applications/examples/hello_nim/index.rst | 1 +
Documentation/applications/examples/hello_rust/index.rst | 1 +
Documentation/applications/examples/hello_wasm/index.rst | 1 +
Documentation/applications/examples/hello_zig/index.rst | 1 +
Documentation/applications/examples/helloxx/index.rst | 1 +
Documentation/applications/examples/hidkbd/index.rst | 1 +
Documentation/applications/examples/hts221_reader/index.rst | 1 +
Documentation/applications/examples/i2cchar/index.rst | 1 +
Documentation/applications/examples/i2sloop/index.rst | 1 +
Documentation/applications/examples/igmp/index.rst | 1 +
Documentation/applications/examples/ina219/index.rst | 1 +
Documentation/applications/examples/ina226/index.rst | 3 ++-
Documentation/applications/examples/index.rst | 1 +
Documentation/applications/examples/ini_dumper/index.rst | 1 +
Documentation/applications/examples/ipcfg/index.rst | 1 +
Documentation/applications/examples/json/index.rst | 1 +
Documentation/applications/examples/keyboard/index.rst | 1 +
Documentation/applications/examples/leds/index.rst | 1 +
Documentation/applications/examples/libtest/index.rst | 1 +
Documentation/applications/examples/lis3dsh_reader/index.rst | 1 +
Documentation/applications/examples/lp503x/index.rst | 3 ++-
Documentation/applications/examples/lsm303_reader/index.rst | 1 +
Documentation/applications/examples/lsm6dsl_reader/index.rst | 1 +
Documentation/applications/examples/ltr308/index.rst | 1 +
Documentation/applications/examples/lua_module/index.rst | 1 +
Documentation/applications/examples/lvgldemo/index.rst | 3 ++-
Documentation/applications/examples/lvglterm/index.rst | 1 +
Documentation/applications/examples/max31855/index.rst | 1 +
Documentation/applications/examples/mcuboot/index.rst | 1 +
Documentation/applications/examples/media/index.rst | 1 +
Documentation/applications/examples/mld/index.rst | 3 ++-
Documentation/applications/examples/mlx90614/index.rst | 1 +
Documentation/applications/examples/modbus/index.rst | 1 +
Documentation/applications/examples/modbusmaster/index.rst | 1 +
Documentation/applications/examples/module/index.rst | 1 +
Documentation/applications/examples/mount/index.rst | 1 +
Documentation/applications/examples/mqttc/index.rst | 1 +
Documentation/applications/examples/mtdpart/index.rst | 1 +
Documentation/applications/examples/mtdrwb/index.rst | 1 +
Documentation/applications/examples/netlink_route/index.rst | 1 +
Documentation/applications/examples/netloop/index.rst | 1 +
Documentation/applications/examples/netpkt/index.rst | 1 +
Documentation/applications/examples/nettest/index.rst | 1 +
Documentation/applications/examples/nimble/index.rst | 1 +
Documentation/applications/examples/nng_test/index.rst | 1 +
Documentation/applications/examples/noteprintf/index.rst | 1 +
Documentation/applications/examples/nrf24l01_btle/index.rst | 1 +
Documentation/applications/examples/nrf24l01_term/index.rst | 1 +
Documentation/applications/examples/null/index.rst | 1 +
Documentation/applications/examples/nunchuck/index.rst | 1 +
Documentation/applications/examples/nx/index.rst | 1 +
Documentation/applications/examples/nxdemo/index.rst | 1 +
Documentation/applications/examples/nxflat/index.rst | 1 +
Documentation/applications/examples/nxhello/index.rst | 1 +
Documentation/applications/examples/nximage/index.rst | 1 +
Documentation/applications/examples/nxlines/index.rst | 1 +
Documentation/applications/examples/nxscope/index.rst | 1 +
Documentation/applications/examples/nxterm/index.rst | 1 +
Documentation/applications/examples/nxtext/index.rst | 1 +
Documentation/applications/examples/obd2/index.rst | 1 +
Documentation/applications/examples/oneshot/index.rst | 1 +
Documentation/applications/examples/opencyphal/index.rst | 1 +
Documentation/applications/examples/pca9635/index.rst | 1 +
Documentation/applications/examples/pdcurses/index.rst | 1 +
Documentation/applications/examples/pf_ieee802154/index.rst | 3 ++-
Documentation/applications/examples/pipe/index.rst | 1 +
Documentation/applications/examples/poll/index.rst | 1 +
Documentation/applications/examples/popen/index.rst | 1 +
Documentation/applications/examples/posix_spawn/index.rst | 1 +
Documentation/applications/examples/powerled/index.rst | 1 +
Documentation/applications/examples/powermonitor/index.rst | 5 +++--
Documentation/applications/examples/pppd/index.rst | 1 +
Documentation/applications/examples/pty_test/index.rst | 1 +
Documentation/applications/examples/pwfb/index.rst | 1 +
Documentation/applications/examples/pwlines/index.rst | 1 +
Documentation/applications/examples/pwm/index.rst | 1 +
Documentation/applications/examples/qencoder/index.rst | 1 +
Documentation/applications/examples/random/index.rst | 1 +
Documentation/applications/examples/relays/index.rst | 1 +
Documentation/applications/examples/rfid_readuid/index.rst | 1 +
Documentation/applications/examples/rgbled/index.rst | 1 +
Documentation/applications/examples/romfs/index.rst | 1 +
Documentation/applications/examples/rpmsgsocket/index.rst | 1 +
Documentation/applications/examples/sendmail/index.rst | 1 +
Documentation/applications/examples/serialblaster/index.rst | 1 +
Documentation/applications/examples/serialrx/index.rst | 1 +
Documentation/applications/examples/serloop/index.rst | 1 +
Documentation/applications/examples/shm_test/index.rst | 1 +
Documentation/applications/examples/sht3x/index.rst | 1 +
Documentation/applications/examples/slcd/index.rst | 1 +
Documentation/applications/examples/smps/index.rst | 1 +
Documentation/applications/examples/sotest/index.rst | 1 +
Documentation/applications/examples/stat/index.rst | 1 +
Documentation/applications/examples/sx127x_demo/index.rst | 1 +
Documentation/applications/examples/system/index.rst | 1 +
Documentation/applications/examples/tcp_ipc_client/index.rst | 1 +
Documentation/applications/examples/tcp_ipc_server/index.rst | 1 +
Documentation/applications/examples/tcpblaster/index.rst | 1 +
Documentation/applications/examples/tcpecho/index.rst | 1 +
Documentation/applications/examples/telnetd/index.rst | 1 +
Documentation/applications/examples/termios/index.rst | 1 +
Documentation/applications/examples/thttpd/index.rst | 1 +
Documentation/applications/examples/tiff/index.rst | 1 +
Documentation/applications/examples/timer/index.rst | 1 +
Documentation/applications/examples/timer_gpio/index.rst | 1 +
Documentation/applications/examples/touchscreen/index.rst | 1 +
Documentation/applications/examples/udp/index.rst | 1 +
Documentation/applications/examples/udpblaster/index.rst | 1 +
Documentation/applications/examples/uid/index.rst | 1 +
Documentation/applications/examples/unionfs/index.rst | 1 +
Documentation/applications/examples/usbserial/index.rst | 1 +
Documentation/applications/examples/userfs/index.rst | 1 +
Documentation/applications/examples/usrsocktest/index.rst | 3 ++-
Documentation/applications/examples/ustream/index.rst | 1 +
Documentation/applications/examples/veml6070/index.rst | 1 +
Documentation/applications/examples/watcher/index.rst | 1 +
Documentation/applications/examples/webserver/index.rst | 1 +
Documentation/applications/examples/wget/index.rst | 1 +
Documentation/applications/examples/wgetjson/index.rst | 1 +
Documentation/applications/examples/wiegand/index.rst | 1 +
Documentation/applications/examples/ws2812/index.rst | 1 +
Documentation/applications/examples/ws2812esp32rmt/index.rst | 1 +
Documentation/applications/examples/xbc_test/index.rst | 1 +
Documentation/applications/examples/xmlrpc/index.rst | 1 +
Documentation/applications/examples/zerocross/index.rst | 1 +
178 files changed, 187 insertions(+), 9 deletions(-)
diff --git a/Documentation/applications/examples/abntcodi/index.rst b/Documentation/applications/examples/abntcodi/index.rst
index 4c8c895985..8aed31c29d 100644
--- a/Documentation/applications/examples/abntcodi/index.rst
+++ b/Documentation/applications/examples/abntcodi/index.rst
@@ -1,3 +1,4 @@
+==============================
``abntcodi`` ABNT CODI example
==============================
diff --git a/Documentation/applications/examples/adc/index.rst b/Documentation/applications/examples/adc/index.rst
index c257fededc..99272c0f63 100644
--- a/Documentation/applications/examples/adc/index.rst
+++ b/Documentation/applications/examples/adc/index.rst
@@ -1,3 +1,4 @@
+=====================
``adc`` Read from ADC
=====================
diff --git a/Documentation/applications/examples/adjtime/index.rst b/Documentation/applications/examples/adjtime/index.rst
index 0dc641b88f..2d5c957378 100644
--- a/Documentation/applications/examples/adjtime/index.rst
+++ b/Documentation/applications/examples/adjtime/index.rst
@@ -1,3 +1,4 @@
+====================================
``adjtime`` Ajdtime function example
====================================
diff --git a/Documentation/applications/examples/adxl372_test/index.rst b/Documentation/applications/examples/adxl372_test/index.rst
index 9cefb5223e..ddb1c320dc 100644
--- a/Documentation/applications/examples/adxl372_test/index.rst
+++ b/Documentation/applications/examples/adxl372_test/index.rst
@@ -1,3 +1,4 @@
+=====================================
``adxl372_test`` ADXL372 test program
=====================================
diff --git a/Documentation/applications/examples/ajoystick/index.rst b/Documentation/applications/examples/ajoystick/index.rst
index 5c2688fdba..e3fca34f54 100644
--- a/Documentation/applications/examples/ajoystick/index.rst
+++ b/Documentation/applications/examples/ajoystick/index.rst
@@ -1,3 +1,4 @@
+=============================
``ajoystick`` Analog Joystick
=============================
diff --git a/Documentation/applications/examples/alarm/index.rst b/Documentation/applications/examples/alarm/index.rst
index 44e50ab53c..f20abc8ecc 100644
--- a/Documentation/applications/examples/alarm/index.rst
+++ b/Documentation/applications/examples/alarm/index.rst
@@ -1,3 +1,4 @@
+===================
``alarm`` RTC Alarm
===================
diff --git a/Documentation/applications/examples/apa102/index.rst b/Documentation/applications/examples/apa102/index.rst
index de9c91ad13..d5b33c2b10 100644
--- a/Documentation/applications/examples/apa102/index.rst
+++ b/Documentation/applications/examples/apa102/index.rst
@@ -1,3 +1,4 @@
+==========================================
``apa102`` Rainbow on ``APA102`` LED Strip
==========================================
diff --git a/Documentation/applications/examples/apds9960/index.rst b/Documentation/applications/examples/apds9960/index.rst
index ae1037eda0..6453980482 100644
--- a/Documentation/applications/examples/apds9960/index.rst
+++ b/Documentation/applications/examples/apds9960/index.rst
@@ -1,3 +1,4 @@
+======================================
``apds9960`` APDS-9960 test pplication
======================================
diff --git a/Documentation/applications/examples/audio_rttl/index.rst b/Documentation/applications/examples/audio_rttl/index.rst
index 2c43788199..563cf37081 100644
--- a/Documentation/applications/examples/audio_rttl/index.rst
+++ b/Documentation/applications/examples/audio_rttl/index.rst
@@ -1,3 +1,4 @@
+===================================
``audio_rttl`` Audio tone generator
===================================
diff --git a/Documentation/applications/examples/bastest/index.rst b/Documentation/applications/examples/bastest/index.rst
index 023db369be..5aa888645b 100644
--- a/Documentation/applications/examples/bastest/index.rst
+++ b/Documentation/applications/examples/bastest/index.rst
@@ -1,3 +1,4 @@
+=================================
``bastest`` Bas BASIC Interpreter
=================================
diff --git a/Documentation/applications/examples/battery/index.rst b/Documentation/applications/examples/battery/index.rst
index 2ecd9918e0..70b0e0e0be 100644
--- a/Documentation/applications/examples/battery/index.rst
+++ b/Documentation/applications/examples/battery/index.rst
@@ -1,3 +1,4 @@
+===================================
``battery`` Battery monitor example
===================================
diff --git a/Documentation/applications/examples/bme680/index.rst b/Documentation/applications/examples/bme680/index.rst
index f444642697..bbd79bb4d6 100644
--- a/Documentation/applications/examples/bme680/index.rst
+++ b/Documentation/applications/examples/bme680/index.rst
@@ -1,3 +1,4 @@
+================================
``bme680`` BME680 sensor example
================================
diff --git a/Documentation/applications/examples/bmi160/index.rst b/Documentation/applications/examples/bmi160/index.rst
index c6a641ea8f..fa08c15e19 100644
--- a/Documentation/applications/examples/bmi160/index.rst
+++ b/Documentation/applications/examples/bmi160/index.rst
@@ -1,3 +1,4 @@
+================================
``bmi160`` BMI160 sensor example
================================
diff --git a/Documentation/applications/examples/bmp180/index.rst b/Documentation/applications/examples/bmp180/index.rst
index 9284aaa285..23e7239442 100644
--- a/Documentation/applications/examples/bmp180/index.rst
+++ b/Documentation/applications/examples/bmp180/index.rst
@@ -1,3 +1,4 @@
+==========================================
``bmp180`` BMP180 Barometer sensor example
==========================================
diff --git a/Documentation/applications/examples/bmp280/index.rst b/Documentation/applications/examples/bmp280/index.rst
index 57361e4f01..62b3a53ec7 100644
--- a/Documentation/applications/examples/bmp280/index.rst
+++ b/Documentation/applications/examples/bmp280/index.rst
@@ -1,3 +1,4 @@
+==========================================
``bmp280`` BMP280 Barometer sensor example
==========================================
diff --git a/Documentation/applications/examples/bridge/index.rst b/Documentation/applications/examples/bridge/index.rst
index 92b8d19e3c..10f5e3d61d 100644
--- a/Documentation/applications/examples/bridge/index.rst
+++ b/Documentation/applications/examples/bridge/index.rst
@@ -1,3 +1,4 @@
+=========================
``bridge`` Network Bridge
=========================
diff --git a/Documentation/applications/examples/buttons/index.rst b/Documentation/applications/examples/buttons/index.rst
index 61074e920f..c06033314a 100644
--- a/Documentation/applications/examples/buttons/index.rst
+++ b/Documentation/applications/examples/buttons/index.rst
@@ -1,3 +1,4 @@
+=============================
``buttons`` Read GPIO Buttons
=============================
diff --git a/Documentation/applications/examples/calib_udelay/index.rst b/Documentation/applications/examples/calib_udelay/index.rst
index b51f622992..d5390fbe69 100644
--- a/Documentation/applications/examples/calib_udelay/index.rst
+++ b/Documentation/applications/examples/calib_udelay/index.rst
@@ -1,3 +1,4 @@
+=============================================
``calib_udelay`` Calibration tool for udelay
=============================================
diff --git a/Documentation/applications/examples/camera/index.rst b/Documentation/applications/examples/camera/index.rst
index 56343d7340..08ad07565f 100644
--- a/Documentation/applications/examples/camera/index.rst
+++ b/Documentation/applications/examples/camera/index.rst
@@ -1,3 +1,4 @@
+==========================
``camera`` Camera Snapshot
==========================
diff --git a/Documentation/applications/examples/can/index.rst b/Documentation/applications/examples/can/index.rst
index 2165e14a18..9fa0b0f709 100644
--- a/Documentation/applications/examples/can/index.rst
+++ b/Documentation/applications/examples/can/index.rst
@@ -1,3 +1,4 @@
+=======================
``can`` CAN Device Test
=======================
diff --git a/Documentation/applications/examples/capture/index.rst b/Documentation/applications/examples/capture/index.rst
index 5d5d4e5d65..3797857b26 100644
--- a/Documentation/applications/examples/capture/index.rst
+++ b/Documentation/applications/examples/capture/index.rst
@@ -1,3 +1,4 @@
+===============================
``capture`` PWM Capture example
===============================
diff --git a/Documentation/applications/examples/cbortest/index.rst b/Documentation/applications/examples/cbortest/index.rst
index 7a22961bff..87d92b54b6 100644
--- a/Documentation/applications/examples/cbortest/index.rst
+++ b/Documentation/applications/examples/cbortest/index.rst
@@ -1,3 +1,4 @@
+==================================
``cbortest`` TinyCBOR Test Example
==================================
diff --git a/Documentation/applications/examples/cctype/index.rst b/Documentation/applications/examples/cctype/index.rst
index fd5f8ec45e..c504b3ab0d 100644
--- a/Documentation/applications/examples/cctype/index.rst
+++ b/Documentation/applications/examples/cctype/index.rst
@@ -1,3 +1,4 @@
+=======================================
``cctype`` Verify C++ cctype operations
=======================================
diff --git a/Documentation/applications/examples/chat/index.rst b/Documentation/applications/examples/chat/index.rst
index a0712f1c45..07b9450f5c 100644
--- a/Documentation/applications/examples/chat/index.rst
+++ b/Documentation/applications/examples/chat/index.rst
@@ -1,3 +1,4 @@
+====================
``chat`` AT over TTY
====================
diff --git a/Documentation/applications/examples/chrono/index.rst b/Documentation/applications/examples/chrono/index.rst
index d0f89d5942..e5164cfe0f 100644
--- a/Documentation/applications/examples/chrono/index.rst
+++ b/Documentation/applications/examples/chrono/index.rst
@@ -1,3 +1,4 @@
+=========================================================
``chrono`` Chronometer example to use with STM32LDiscover
=========================================================
diff --git a/Documentation/applications/examples/configdata/index.rst b/Documentation/applications/examples/configdata/index.rst
index 20af13554c..fbfd78d785 100644
--- a/Documentation/applications/examples/configdata/index.rst
+++ b/Documentation/applications/examples/configdata/index.rst
@@ -1,3 +1,4 @@
+==============================================
``configdata`` Config Data example / unit test
==============================================
diff --git a/Documentation/applications/examples/cordic/index.rst b/Documentation/applications/examples/cordic/index.rst
index 16b9abd0a6..5fab20db4a 100644
--- a/Documentation/applications/examples/cordic/index.rst
+++ b/Documentation/applications/examples/cordic/index.rst
@@ -1,3 +1,4 @@
+================================
``cordic`` CORDIC driver example
================================
diff --git a/Documentation/applications/examples/cpuhog/index.rst b/Documentation/applications/examples/cpuhog/index.rst
index c63f407c3b..2362e23797 100644
--- a/Documentation/applications/examples/cpuhog/index.rst
+++ b/Documentation/applications/examples/cpuhog/index.rst
@@ -1,3 +1,4 @@
+========================
``cpuhog`` Keep CPU Busy
========================
diff --git a/Documentation/applications/examples/cromfs/index.rst b/Documentation/applications/examples/cromfs/index.rst
index 9c1493fcba..f81f4bfc14 100644
--- a/Documentation/applications/examples/cromfs/index.rst
+++ b/Documentation/applications/examples/cromfs/index.rst
@@ -1,3 +1,4 @@
+=========================
``cromfs`` CROMFS Example
=========================
diff --git a/Documentation/applications/examples/dac/index.rst b/Documentation/applications/examples/dac/index.rst
index c006913ccc..1846746374 100644
--- a/Documentation/applications/examples/dac/index.rst
+++ b/Documentation/applications/examples/dac/index.rst
@@ -1,3 +1,4 @@
+====================
``dac`` Write to DAC
====================
diff --git a/Documentation/applications/examples/dhcpd/index.rst b/Documentation/applications/examples/dhcpd/index.rst
index 598519eb99..ca341a2b24 100644
--- a/Documentation/applications/examples/dhcpd/index.rst
+++ b/Documentation/applications/examples/dhcpd/index.rst
@@ -1,3 +1,4 @@
+=====================
``dhcpd`` DHCP Server
=====================
diff --git a/Documentation/applications/examples/discover/index.rst b/Documentation/applications/examples/discover/index.rst
index aec1a9b3a1..de7d2df692 100644
--- a/Documentation/applications/examples/discover/index.rst
+++ b/Documentation/applications/examples/discover/index.rst
@@ -1,3 +1,4 @@
+================================
``discover`` UDP Discover Daemon
================================
diff --git a/Documentation/applications/examples/djoystick/index.rst b/Documentation/applications/examples/djoystick/index.rst
index 182fdd789e..7b885b2682 100644
--- a/Documentation/applications/examples/djoystick/index.rst
+++ b/Documentation/applications/examples/djoystick/index.rst
@@ -1,3 +1,4 @@
+===============================
``djoystick`` Discrete Joystick
===============================
diff --git a/Documentation/applications/examples/dronecan/index.rst b/Documentation/applications/examples/dronecan/index.rst
index b0865652b5..cb567a2e1a 100644
--- a/Documentation/applications/examples/dronecan/index.rst
+++ b/Documentation/applications/examples/dronecan/index.rst
@@ -1,3 +1,4 @@
+=============================
``dronecan`` DroneCAN example
=============================
diff --git a/Documentation/applications/examples/elf/index.rst b/Documentation/applications/examples/elf/index.rst
index 3463c19714..71f9db78b8 100644
--- a/Documentation/applications/examples/elf/index.rst
+++ b/Documentation/applications/examples/elf/index.rst
@@ -1,3 +1,4 @@
+==================
``elf`` ELF loader
==================
diff --git a/Documentation/applications/examples/embedlog/index.rst b/Documentation/applications/examples/embedlog/index.rst
index b8c527763d..36f72ee0d3 100644
--- a/Documentation/applications/examples/embedlog/index.rst
+++ b/Documentation/applications/examples/embedlog/index.rst
@@ -1,3 +1,4 @@
+=============================
``embedlog`` embedlog example
=============================
diff --git a/Documentation/applications/examples/esp32_himem/index.rst b/Documentation/applications/examples/esp32_himem/index.rst
index 942cb780a9..b69fd60fa7 100644
--- a/Documentation/applications/examples/esp32_himem/index.rst
+++ b/Documentation/applications/examples/esp32_himem/index.rst
@@ -1,3 +1,4 @@
+===================================
``esp32_himem`` ESP32 HIMEM Example
===================================
diff --git a/Documentation/applications/examples/etl/index.rst b/Documentation/applications/examples/etl/index.rst
index 241eaae82b..c1fff31889 100644
--- a/Documentation/applications/examples/etl/index.rst
+++ b/Documentation/applications/examples/etl/index.rst
@@ -1,3 +1,4 @@
+===================================================
``etl`` Embedded Template Library (ETL) C++ example
===================================================
diff --git a/Documentation/applications/examples/fb/index.rst b/Documentation/applications/examples/fb/index.rst
index 91fe778e37..4e31adfa48 100644
--- a/Documentation/applications/examples/fb/index.rst
+++ b/Documentation/applications/examples/fb/index.rst
@@ -1,3 +1,4 @@
+==================
``fb`` Framebuffer
==================
diff --git a/Documentation/applications/examples/fboverlay/index.rst b/Documentation/applications/examples/fboverlay/index.rst
index 4cca8d170f..ea94fe45ac 100644
--- a/Documentation/applications/examples/fboverlay/index.rst
+++ b/Documentation/applications/examples/fboverlay/index.rst
@@ -1,3 +1,4 @@
+===========================================
``fboverlay`` Framebuffer overlay test tool
===========================================
diff --git a/Documentation/applications/examples/flash_test/index.rst b/Documentation/applications/examples/flash_test/index.rst
index fd0390ee2a..a2cba1a111 100644
--- a/Documentation/applications/examples/flash_test/index.rst
+++ b/Documentation/applications/examples/flash_test/index.rst
@@ -1,3 +1,4 @@
+===============================
``flash_test`` SMART Flash test
===============================
diff --git a/Documentation/applications/examples/flowc/index.rst b/Documentation/applications/examples/flowc/index.rst
index c6bcbce5e7..7ccf9a0841 100644
--- a/Documentation/applications/examples/flowc/index.rst
+++ b/Documentation/applications/examples/flowc/index.rst
@@ -1,3 +1,4 @@
+======================================
``flowc`` Serial Hardware Flow Control
======================================
diff --git a/Documentation/applications/examples/fmsynth/index.rst b/Documentation/applications/examples/fmsynth/index.rst
index 92c6772740..3fa49f6a8c 100644
--- a/Documentation/applications/examples/fmsynth/index.rst
+++ b/Documentation/applications/examples/fmsynth/index.rst
@@ -1,3 +1,4 @@
+===================================
``fmsynth`` FM Synthesizer examples
===================================
diff --git a/Documentation/applications/examples/foc/index.rst b/Documentation/applications/examples/foc/index.rst
index 5c2303553e..1ddc2e5835 100644
--- a/Documentation/applications/examples/foc/index.rst
+++ b/Documentation/applications/examples/foc/index.rst
@@ -1,3 +1,4 @@
+====================================
``foc`` FOC motor controller example
====================================
diff --git a/Documentation/applications/examples/ft80x/index.rst b/Documentation/applications/examples/ft80x/index.rst
index 936dc38a1b..9020d67baf 100644
--- a/Documentation/applications/examples/ft80x/index.rst
+++ b/Documentation/applications/examples/ft80x/index.rst
@@ -1,3 +1,4 @@
+========================
``ft80x`` FT80x GUI Chip
========================
diff --git a/Documentation/applications/examples/ftpc/index.rst b/Documentation/applications/examples/ftpc/index.rst
index 9641f0bb5d..dec1aadbe9 100644
--- a/Documentation/applications/examples/ftpc/index.rst
+++ b/Documentation/applications/examples/ftpc/index.rst
@@ -1,3 +1,4 @@
+===================
``ftpc`` FTP Client
===================
diff --git a/Documentation/applications/examples/ftpd/index.rst b/Documentation/applications/examples/ftpd/index.rst
index c66d775e47..912e15129a 100644
--- a/Documentation/applications/examples/ftpd/index.rst
+++ b/Documentation/applications/examples/ftpd/index.rst
@@ -1,3 +1,4 @@
+===================
``ftpd`` FTP daemon
===================
diff --git a/Documentation/applications/examples/fxos8700cq_test/index.rst b/Documentation/applications/examples/fxos8700cq_test/index.rst
index d2cd149341..4286bab0f7 100644
--- a/Documentation/applications/examples/fxos8700cq_test/index.rst
+++ b/Documentation/applications/examples/fxos8700cq_test/index.rst
@@ -1,3 +1,4 @@
+===================
``fxos8700cq_test``
===================
diff --git a/Documentation/applications/examples/gpio/index.rst b/Documentation/applications/examples/gpio/index.rst
index 2a6c70f57b..d8bd88edcf 100644
--- a/Documentation/applications/examples/gpio/index.rst
+++ b/Documentation/applications/examples/gpio/index.rst
@@ -1,4 +1,5 @@
+============================
``gpio`` GPIO Read and Write
-----------------------------
+============================
A simple ``test/example`` of the NuttX GPIO driver.
diff --git a/Documentation/applications/examples/gps/index.rst b/Documentation/applications/examples/gps/index.rst
index 24b794bfd0..f81af24c91 100644
--- a/Documentation/applications/examples/gps/index.rst
+++ b/Documentation/applications/examples/gps/index.rst
@@ -1,3 +1,4 @@
+===================
``gps`` GPS example
===================
diff --git a/Documentation/applications/examples/hall/index.rst b/Documentation/applications/examples/hall/index.rst
index c9687633d5..f19ea830e5 100644
--- a/Documentation/applications/examples/hall/index.rst
+++ b/Documentation/applications/examples/hall/index.rst
@@ -1,3 +1,4 @@
+===================================
``hall`` Hall effect sensor example
===================================
diff --git a/Documentation/applications/examples/hdc1008_demo/index.rst b/Documentation/applications/examples/hdc1008_demo/index.rst
index b527183120..7a579df3e1 100644
--- a/Documentation/applications/examples/hdc1008_demo/index.rst
+++ b/Documentation/applications/examples/hdc1008_demo/index.rst
@@ -1,3 +1,4 @@
+=======================================
``hdc1008_demo`` HDC1008 driver example
=======================================
diff --git a/Documentation/applications/examples/hello/index.rst b/Documentation/applications/examples/hello/index.rst
index 262f827e72..37b972ad15 100644
--- a/Documentation/applications/examples/hello/index.rst
+++ b/Documentation/applications/examples/hello/index.rst
@@ -1,3 +1,4 @@
+=====================
``hello`` Hello World
=====================
diff --git a/Documentation/applications/examples/hello_nim/index.rst b/Documentation/applications/examples/hello_nim/index.rst
index 2c55ee36b7..d35ae7b8eb 100644
--- a/Documentation/applications/examples/hello_nim/index.rst
+++ b/Documentation/applications/examples/hello_nim/index.rst
@@ -1,3 +1,4 @@
+================================
``hello_nim`` Hello World in Nim
================================
diff --git a/Documentation/applications/examples/hello_rust/index.rst b/Documentation/applications/examples/hello_rust/index.rst
index 2e23e5ee67..636b2001a2 100644
--- a/Documentation/applications/examples/hello_rust/index.rst
+++ b/Documentation/applications/examples/hello_rust/index.rst
@@ -1,3 +1,4 @@
+==================================
``hello_rust`` Hello World in Rust
==================================
diff --git a/Documentation/applications/examples/hello_wasm/index.rst b/Documentation/applications/examples/hello_wasm/index.rst
index 66090084c4..0a02412ede 100644
--- a/Documentation/applications/examples/hello_wasm/index.rst
+++ b/Documentation/applications/examples/hello_wasm/index.rst
@@ -1,3 +1,4 @@
+==================================
``hello_wasm`` Hello World in WASM
==================================
diff --git a/Documentation/applications/examples/hello_zig/index.rst b/Documentation/applications/examples/hello_zig/index.rst
index 238aca90a4..fecbbb5183 100644
--- a/Documentation/applications/examples/hello_zig/index.rst
+++ b/Documentation/applications/examples/hello_zig/index.rst
@@ -1,3 +1,4 @@
+================================
``hello_zig`` Hello World in Zig
================================
diff --git a/Documentation/applications/examples/helloxx/index.rst b/Documentation/applications/examples/helloxx/index.rst
index 34cd52a853..079587fcf1 100644
--- a/Documentation/applications/examples/helloxx/index.rst
+++ b/Documentation/applications/examples/helloxx/index.rst
@@ -1,3 +1,4 @@
+==============================
``helloxx`` Hello World in C++
==============================
diff --git a/Documentation/applications/examples/hidkbd/index.rst b/Documentation/applications/examples/hidkbd/index.rst
index 26cbf46d1e..a95266e57b 100644
--- a/Documentation/applications/examples/hidkbd/index.rst
+++ b/Documentation/applications/examples/hidkbd/index.rst
@@ -1,3 +1,4 @@
+================================
``hidkbd`` USB Host HID keyboard
================================
diff --git a/Documentation/applications/examples/hts221_reader/index.rst b/Documentation/applications/examples/hts221_reader/index.rst
index dc111c3b98..fad329d20b 100644
--- a/Documentation/applications/examples/hts221_reader/index.rst
+++ b/Documentation/applications/examples/hts221_reader/index.rst
@@ -1,3 +1,4 @@
+============================================
``hts221_reader`` ``HTS221`` Humidity Sensor
============================================
diff --git a/Documentation/applications/examples/i2cchar/index.rst b/Documentation/applications/examples/i2cchar/index.rst
index 3593ca2f6a..47506a8938 100644
--- a/Documentation/applications/examples/i2cchar/index.rst
+++ b/Documentation/applications/examples/i2cchar/index.rst
@@ -1,3 +1,4 @@
+================================
``i2cchar`` Transfer Through I2C
================================
diff --git a/Documentation/applications/examples/i2sloop/index.rst b/Documentation/applications/examples/i2sloop/index.rst
index ebd527c555..d7ecaa3557 100644
--- a/Documentation/applications/examples/i2sloop/index.rst
+++ b/Documentation/applications/examples/i2sloop/index.rst
@@ -1,3 +1,4 @@
+=============================
``i2sloop`` I2S loopback test
=============================
diff --git a/Documentation/applications/examples/igmp/index.rst b/Documentation/applications/examples/igmp/index.rst
index 1c0c859dd2..c5d733934b 100644
--- a/Documentation/applications/examples/igmp/index.rst
+++ b/Documentation/applications/examples/igmp/index.rst
@@ -1,3 +1,4 @@
+=====================
``igmp`` Trivial IGMP
=====================
diff --git a/Documentation/applications/examples/ina219/index.rst b/Documentation/applications/examples/ina219/index.rst
index c5f6c9a276..1b117991d3 100644
--- a/Documentation/applications/examples/ina219/index.rst
+++ b/Documentation/applications/examples/ina219/index.rst
@@ -1,3 +1,4 @@
+=======================================
``ina219`` Current/Power Monitor INA219
=======================================
diff --git a/Documentation/applications/examples/ina226/index.rst b/Documentation/applications/examples/ina226/index.rst
index dff8c9a004..ed2c2d9deb 100644
--- a/Documentation/applications/examples/ina226/index.rst
+++ b/Documentation/applications/examples/ina226/index.rst
@@ -1,4 +1,5 @@
+=======================================
``ina226`` Current/Power Monitor INA219
-======================================
+=======================================
TODO
diff --git a/Documentation/applications/examples/index.rst b/Documentation/applications/examples/index.rst
index 9d7cb53f7a..ba7b557c96 100644
--- a/Documentation/applications/examples/index.rst
+++ b/Documentation/applications/examples/index.rst
@@ -1,3 +1,4 @@
+========
Examples
========
diff --git a/Documentation/applications/examples/ini_dumper/index.rst b/Documentation/applications/examples/ini_dumper/index.rst
index 333534d4b7..2e7a097630 100644
--- a/Documentation/applications/examples/ini_dumper/index.rst
+++ b/Documentation/applications/examples/ini_dumper/index.rst
@@ -1,3 +1,4 @@
+=================================
``ini_dumper`` ini dumper example
=================================
diff --git a/Documentation/applications/examples/ipcfg/index.rst b/Documentation/applications/examples/ipcfg/index.rst
index daffe8ebef..511d4f9f2f 100644
--- a/Documentation/applications/examples/ipcfg/index.rst
+++ b/Documentation/applications/examples/ipcfg/index.rst
@@ -1,3 +1,4 @@
+=======================================
``ipcfg`` IP Configuration file example
=======================================
diff --git a/Documentation/applications/examples/json/index.rst b/Documentation/applications/examples/json/index.rst
index 6e43570001..24e07af4d0 100644
--- a/Documentation/applications/examples/json/index.rst
+++ b/Documentation/applications/examples/json/index.rst
@@ -1,3 +1,4 @@
+==============
``json`` cJSON
==============
diff --git a/Documentation/applications/examples/keyboard/index.rst b/Documentation/applications/examples/keyboard/index.rst
index 4af85b29ab..630e5cb368 100644
--- a/Documentation/applications/examples/keyboard/index.rst
+++ b/Documentation/applications/examples/keyboard/index.rst
@@ -1,3 +1,4 @@
+============
``keyboard``
============
diff --git a/Documentation/applications/examples/leds/index.rst b/Documentation/applications/examples/leds/index.rst
index 53a80d3f9c..4634283792 100644
--- a/Documentation/applications/examples/leds/index.rst
+++ b/Documentation/applications/examples/leds/index.rst
@@ -1,3 +1,4 @@
+====================
``leds`` Toggle LEDs
====================
diff --git a/Documentation/applications/examples/libtest/index.rst b/Documentation/applications/examples/libtest/index.rst
index f7e55425e3..3b887bf3d5 100644
--- a/Documentation/applications/examples/libtest/index.rst
+++ b/Documentation/applications/examples/libtest/index.rst
@@ -1,3 +1,4 @@
+===============================
``libtest`` Static Library Test
===============================
diff --git a/Documentation/applications/examples/lis3dsh_reader/index.rst b/Documentation/applications/examples/lis3dsh_reader/index.rst
index 09c9e648bb..00625035c8 100644
--- a/Documentation/applications/examples/lis3dsh_reader/index.rst
+++ b/Documentation/applications/examples/lis3dsh_reader/index.rst
@@ -1,3 +1,4 @@
+============================================
``lis3dsh_reader`` ``LIS3DSH`` Accelerometer
============================================
diff --git a/Documentation/applications/examples/lp503x/index.rst b/Documentation/applications/examples/lp503x/index.rst
index 3a22466199..94cfdd3784 100644
--- a/Documentation/applications/examples/lp503x/index.rst
+++ b/Documentation/applications/examples/lp503x/index.rst
@@ -1,4 +1,5 @@
+=================================
``lp503x`` LP503X PWM LED example
-================================
+=================================
TODO
diff --git a/Documentation/applications/examples/lsm303_reader/index.rst b/Documentation/applications/examples/lsm303_reader/index.rst
index edb4990ba7..44472e6791 100644
--- a/Documentation/applications/examples/lsm303_reader/index.rst
+++ b/Documentation/applications/examples/lsm303_reader/index.rst
@@ -1,3 +1,4 @@
+=======================================================
``lsm303_reader`` ``LSM303`` Accelerometer/Magnetometer
=======================================================
diff --git a/Documentation/applications/examples/lsm6dsl_reader/index.rst b/Documentation/applications/examples/lsm6dsl_reader/index.rst
index 5989031073..65a7de9d90 100644
--- a/Documentation/applications/examples/lsm6dsl_reader/index.rst
+++ b/Documentation/applications/examples/lsm6dsl_reader/index.rst
@@ -1,3 +1,4 @@
+======================================================
``lsm6dsl_reader`` ``LSM6DSL`` Accelerometer/Gyroscope
======================================================
diff --git a/Documentation/applications/examples/ltr308/index.rst b/Documentation/applications/examples/ltr308/index.rst
index 035dc49b75..71df2bb364 100644
--- a/Documentation/applications/examples/ltr308/index.rst
+++ b/Documentation/applications/examples/ltr308/index.rst
@@ -1,3 +1,4 @@
+==============================================
``ltr308`` LTR308 ambient light sensor example
==============================================
diff --git a/Documentation/applications/examples/lua_module/index.rst b/Documentation/applications/examples/lua_module/index.rst
index 9519417da0..3f9fe2b402 100644
--- a/Documentation/applications/examples/lua_module/index.rst
+++ b/Documentation/applications/examples/lua_module/index.rst
@@ -1,3 +1,4 @@
+=====================================
``lua_module`` Hello World Lua module
=====================================
diff --git a/Documentation/applications/examples/lvgldemo/index.rst b/Documentation/applications/examples/lvgldemo/index.rst
index 176c2286ec..3e72195273 100644
--- a/Documentation/applications/examples/lvgldemo/index.rst
+++ b/Documentation/applications/examples/lvgldemo/index.rst
@@ -1,4 +1,5 @@
+======================
``lvgldemo`` LVGL Demo
-=====================
+======================
TODO
diff --git a/Documentation/applications/examples/lvglterm/index.rst b/Documentation/applications/examples/lvglterm/index.rst
index 8dbc06b8e9..3825fa2ff1 100644
--- a/Documentation/applications/examples/lvglterm/index.rst
+++ b/Documentation/applications/examples/lvglterm/index.rst
@@ -1,3 +1,4 @@
+==============================================
``lvglterm`` LVGL Terminal for NuttShell (NSH)
==============================================
diff --git a/Documentation/applications/examples/max31855/index.rst b/Documentation/applications/examples/max31855/index.rst
index 93e7b67b43..ad4e98dc10 100644
--- a/Documentation/applications/examples/max31855/index.rst
+++ b/Documentation/applications/examples/max31855/index.rst
@@ -1,3 +1,4 @@
+=============================
``max31855`` max31855 example
=============================
diff --git a/Documentation/applications/examples/mcuboot/index.rst b/Documentation/applications/examples/mcuboot/index.rst
index 2b7176c34c..b883deed4c 100644
--- a/Documentation/applications/examples/mcuboot/index.rst
+++ b/Documentation/applications/examples/mcuboot/index.rst
@@ -1,3 +1,4 @@
+============================
``mcuboot`` MCUboot examples
============================
diff --git a/Documentation/applications/examples/media/index.rst b/Documentation/applications/examples/media/index.rst
index 66aa17a689..01cc82841c 100644
--- a/Documentation/applications/examples/media/index.rst
+++ b/Documentation/applications/examples/media/index.rst
@@ -1,3 +1,4 @@
+====================
``media`` Media test
====================
diff --git a/Documentation/applications/examples/mld/index.rst b/Documentation/applications/examples/mld/index.rst
index 48dde4eab1..4ce29182b8 100644
--- a/Documentation/applications/examples/mld/index.rst
+++ b/Documentation/applications/examples/mld/index.rst
@@ -1,4 +1,5 @@
+===================
``mld`` MLD example
-==================
+===================
TODO
diff --git a/Documentation/applications/examples/mlx90614/index.rst b/Documentation/applications/examples/mlx90614/index.rst
index c568e52df8..257903cf79 100644
--- a/Documentation/applications/examples/mlx90614/index.rst
+++ b/Documentation/applications/examples/mlx90614/index.rst
@@ -1,3 +1,4 @@
+==================================
``mlx90614`` MLX90614 Test Example
==================================
diff --git a/Documentation/applications/examples/modbus/index.rst b/Documentation/applications/examples/modbus/index.rst
index cd436cefe8..88f21cc4fd 100644
--- a/Documentation/applications/examples/modbus/index.rst
+++ b/Documentation/applications/examples/modbus/index.rst
@@ -1,3 +1,4 @@
+==================================
``modbus`` FreeModbus demo example
==================================
diff --git a/Documentation/applications/examples/modbusmaster/index.rst b/Documentation/applications/examples/modbusmaster/index.rst
index 87e65f6561..51054aa1b4 100644
--- a/Documentation/applications/examples/modbusmaster/index.rst
+++ b/Documentation/applications/examples/modbusmaster/index.rst
@@ -1,3 +1,4 @@
+======================================
``modbusmaster`` Modbus Master example
======================================
diff --git a/Documentation/applications/examples/module/index.rst b/Documentation/applications/examples/module/index.rst
index 78978945c3..1f1af24889 100644
--- a/Documentation/applications/examples/module/index.rst
+++ b/Documentation/applications/examples/module/index.rst
@@ -1,3 +1,4 @@
+==========================
``module`` Loadable Module
==========================
diff --git a/Documentation/applications/examples/mount/index.rst b/Documentation/applications/examples/mount/index.rst
index bb72176ced..300d135df8 100644
--- a/Documentation/applications/examples/mount/index.rst
+++ b/Documentation/applications/examples/mount/index.rst
@@ -1,3 +1,4 @@
+==========================
``mount`` Mount Filesystem
==========================
diff --git a/Documentation/applications/examples/mqttc/index.rst b/Documentation/applications/examples/mqttc/index.rst
index c411ffabe1..aa6eeea327 100644
--- a/Documentation/applications/examples/mqttc/index.rst
+++ b/Documentation/applications/examples/mqttc/index.rst
@@ -1,3 +1,4 @@
+========================
``mqttc`` MQTT-C Example
========================
diff --git a/Documentation/applications/examples/mtdpart/index.rst b/Documentation/applications/examples/mtdpart/index.rst
index 119a7cf173..eeef38e5f9 100644
--- a/Documentation/applications/examples/mtdpart/index.rst
+++ b/Documentation/applications/examples/mtdpart/index.rst
@@ -1,3 +1,4 @@
+==============================
``mtdpart`` MTD Partition Test
==============================
diff --git a/Documentation/applications/examples/mtdrwb/index.rst b/Documentation/applications/examples/mtdrwb/index.rst
index e723e46712..22c09dad81 100644
--- a/Documentation/applications/examples/mtdrwb/index.rst
+++ b/Documentation/applications/examples/mtdrwb/index.rst
@@ -1,3 +1,4 @@
+=============================================
``mtdrwb`` MTD Read-ahead and Write Buffering
=============================================
diff --git a/Documentation/applications/examples/netlink_route/index.rst b/Documentation/applications/examples/netlink_route/index.rst
index 3ec0219e93..b56dcf6707 100644
--- a/Documentation/applications/examples/netlink_route/index.rst
+++ b/Documentation/applications/examples/netlink_route/index.rst
@@ -1,3 +1,4 @@
+============================================
``netlink_route`` Netlink NETLINK_ROUTE test
============================================
diff --git a/Documentation/applications/examples/netloop/index.rst b/Documentation/applications/examples/netloop/index.rst
index 1cd02e0795..d190234290 100644
--- a/Documentation/applications/examples/netloop/index.rst
+++ b/Documentation/applications/examples/netloop/index.rst
@@ -1,3 +1,4 @@
+===================================
``netloop`` Network loopback device
===================================
diff --git a/Documentation/applications/examples/netpkt/index.rst b/Documentation/applications/examples/netpkt/index.rst
index 5eb6357d7a..5d2ca597de 100644
--- a/Documentation/applications/examples/netpkt/index.rst
+++ b/Documentation/applications/examples/netpkt/index.rst
@@ -1,3 +1,4 @@
+====================================
``netpkt`` ``AF_PACKET`` Raw Sockets
====================================
diff --git a/Documentation/applications/examples/nettest/index.rst b/Documentation/applications/examples/nettest/index.rst
index fd365069e0..0d77760972 100644
--- a/Documentation/applications/examples/nettest/index.rst
+++ b/Documentation/applications/examples/nettest/index.rst
@@ -1,3 +1,4 @@
+==================================
``nettest`` Client/Server Over TCP
==================================
diff --git a/Documentation/applications/examples/nimble/index.rst b/Documentation/applications/examples/nimble/index.rst
index d24a18b4e7..fde804a533 100644
--- a/Documentation/applications/examples/nimble/index.rst
+++ b/Documentation/applications/examples/nimble/index.rst
@@ -1,3 +1,4 @@
+=========================
``nimble`` NimBLE example
=========================
diff --git a/Documentation/applications/examples/nng_test/index.rst b/Documentation/applications/examples/nng_test/index.rst
index 244089f0c9..2f4909eadf 100644
--- a/Documentation/applications/examples/nng_test/index.rst
+++ b/Documentation/applications/examples/nng_test/index.rst
@@ -1,3 +1,4 @@
+===============================
``nng_test`` NNG pubsub program
===============================
diff --git a/Documentation/applications/examples/noteprintf/index.rst b/Documentation/applications/examples/noteprintf/index.rst
index 4df7eb8238..34ed28af81 100644
--- a/Documentation/applications/examples/noteprintf/index.rst
+++ b/Documentation/applications/examples/noteprintf/index.rst
@@ -1,3 +1,4 @@
+=====================================
``noteprintf`` "Note printf!" example
=====================================
diff --git a/Documentation/applications/examples/nrf24l01_btle/index.rst b/Documentation/applications/examples/nrf24l01_btle/index.rst
index 302115c46c..a2e4cc9cfd 100644
--- a/Documentation/applications/examples/nrf24l01_btle/index.rst
+++ b/Documentation/applications/examples/nrf24l01_btle/index.rst
@@ -1,3 +1,4 @@
+=====================================================================
``nrf24l01_btle`` Emulates a nRF8001 temperature beacon with nRF24L01
=====================================================================
diff --git a/Documentation/applications/examples/nrf24l01_term/index.rst b/Documentation/applications/examples/nrf24l01_term/index.rst
index 4ae4593c80..45ff818f9e 100644
--- a/Documentation/applications/examples/nrf24l01_term/index.rst
+++ b/Documentation/applications/examples/nrf24l01_term/index.rst
@@ -1,3 +1,4 @@
+==============================================
``nrf24l01_term`` NRF24L01 Wireless Connection
==============================================
diff --git a/Documentation/applications/examples/null/index.rst b/Documentation/applications/examples/null/index.rst
index 6cd0880bc5..a950a4f6dd 100644
--- a/Documentation/applications/examples/null/index.rst
+++ b/Documentation/applications/examples/null/index.rst
@@ -1,3 +1,4 @@
+=====================
``null`` NULL example
=====================
diff --git a/Documentation/applications/examples/nunchuck/index.rst b/Documentation/applications/examples/nunchuck/index.rst
index 9cc3ffb594..2fb4f918eb 100644
--- a/Documentation/applications/examples/nunchuck/index.rst
+++ b/Documentation/applications/examples/nunchuck/index.rst
@@ -1,3 +1,4 @@
+============
``nunchuck``
============
diff --git a/Documentation/applications/examples/nx/index.rst b/Documentation/applications/examples/nx/index.rst
index e5b8dff3c0..7f0b81a7eb 100644
--- a/Documentation/applications/examples/nx/index.rst
+++ b/Documentation/applications/examples/nx/index.rst
@@ -1,3 +1,4 @@
+==========================
``nx`` NX graphics example
==========================
diff --git a/Documentation/applications/examples/nxdemo/index.rst b/Documentation/applications/examples/nxdemo/index.rst
index bc18d203bb..207462d7f6 100644
--- a/Documentation/applications/examples/nxdemo/index.rst
+++ b/Documentation/applications/examples/nxdemo/index.rst
@@ -1,3 +1,4 @@
+=========================================
``nxdemo`` NX Demo "Graphic test" example
=========================================
diff --git a/Documentation/applications/examples/nxflat/index.rst b/Documentation/applications/examples/nxflat/index.rst
index 787fbabbea..5ac29af9ce 100644
--- a/Documentation/applications/examples/nxflat/index.rst
+++ b/Documentation/applications/examples/nxflat/index.rst
@@ -1,3 +1,4 @@
+========================
``nxflat`` NXFLAT Binary
========================
diff --git a/Documentation/applications/examples/nxhello/index.rst b/Documentation/applications/examples/nxhello/index.rst
index fc85ab8f0f..408db1444f 100644
--- a/Documentation/applications/examples/nxhello/index.rst
+++ b/Documentation/applications/examples/nxhello/index.rst
@@ -1,3 +1,4 @@
+===============================================
``nxhello`` NX graphics "Hello, World!" example
===============================================
diff --git a/Documentation/applications/examples/nximage/index.rst b/Documentation/applications/examples/nximage/index.rst
index af2af721f8..f0651b80ee 100644
--- a/Documentation/applications/examples/nximage/index.rst
+++ b/Documentation/applications/examples/nximage/index.rst
@@ -1,3 +1,4 @@
+==============================
``nximage`` Display NuttX Logo
==============================
diff --git a/Documentation/applications/examples/nxlines/index.rst b/Documentation/applications/examples/nxlines/index.rst
index d24225ad84..3d274c5ca5 100644
--- a/Documentation/applications/examples/nxlines/index.rst
+++ b/Documentation/applications/examples/nxlines/index.rst
@@ -1,3 +1,4 @@
+===========================
``nxlines`` NX Line Drawing
===========================
diff --git a/Documentation/applications/examples/nxscope/index.rst b/Documentation/applications/examples/nxscope/index.rst
index 9aef08145a..1853689f5d 100644
--- a/Documentation/applications/examples/nxscope/index.rst
+++ b/Documentation/applications/examples/nxscope/index.rst
@@ -1,3 +1,4 @@
+===================================
``nxscope`` NxScope library example
===================================
diff --git a/Documentation/applications/examples/nxterm/index.rst b/Documentation/applications/examples/nxterm/index.rst
index 1d24821efd..5deb2d749f 100644
--- a/Documentation/applications/examples/nxterm/index.rst
+++ b/Documentation/applications/examples/nxterm/index.rst
@@ -1,3 +1,4 @@
+================================================
``nxterm`` Display NuttShell (NSH) as NX Console
================================================
diff --git a/Documentation/applications/examples/nxtext/index.rst b/Documentation/applications/examples/nxtext/index.rst
index 445d345fb0..ac97e39804 100644
--- a/Documentation/applications/examples/nxtext/index.rst
+++ b/Documentation/applications/examples/nxtext/index.rst
@@ -1,3 +1,4 @@
+==========================
``nxtext`` Display NX Text
==========================
diff --git a/Documentation/applications/examples/obd2/index.rst b/Documentation/applications/examples/obd2/index.rst
index 58ed454276..2902b285f4 100644
--- a/Documentation/applications/examples/obd2/index.rst
+++ b/Documentation/applications/examples/obd2/index.rst
@@ -1,3 +1,4 @@
+===================================
``obd2`` OBD-II application example
===================================
diff --git a/Documentation/applications/examples/oneshot/index.rst b/Documentation/applications/examples/oneshot/index.rst
index 95ce9ae54b..7f8a3df302 100644
--- a/Documentation/applications/examples/oneshot/index.rst
+++ b/Documentation/applications/examples/oneshot/index.rst
@@ -1,3 +1,4 @@
+=========================
``oneshot`` Oneshot Timer
=========================
diff --git a/Documentation/applications/examples/opencyphal/index.rst b/Documentation/applications/examples/opencyphal/index.rst
index d907954525..7503693d21 100644
--- a/Documentation/applications/examples/opencyphal/index.rst
+++ b/Documentation/applications/examples/opencyphal/index.rst
@@ -1,3 +1,4 @@
+============================================
``opencyphal`` OpenCyphal Cyphal/CAN example
============================================
diff --git a/Documentation/applications/examples/pca9635/index.rst b/Documentation/applications/examples/pca9635/index.rst
index bb53be3644..381b779de1 100644
--- a/Documentation/applications/examples/pca9635/index.rst
+++ b/Documentation/applications/examples/pca9635/index.rst
@@ -1,3 +1,4 @@
+=============================
``pca9635`` ``PCA9635PW`` LED
=============================
diff --git a/Documentation/applications/examples/pdcurses/index.rst b/Documentation/applications/examples/pdcurses/index.rst
index d71ab91282..f667b40ce2 100644
--- a/Documentation/applications/examples/pdcurses/index.rst
+++ b/Documentation/applications/examples/pdcurses/index.rst
@@ -1,3 +1,4 @@
+===========================
``pdcurses`` pdcurses demos
===========================
diff --git a/Documentation/applications/examples/pf_ieee802154/index.rst b/Documentation/applications/examples/pf_ieee802154/index.rst
index 0bd0d8d656..3aa8cb0bfd 100644
--- a/Documentation/applications/examples/pf_ieee802154/index.rst
+++ b/Documentation/applications/examples/pf_ieee802154/index.rst
@@ -1,4 +1,5 @@
+=======================================
``pf_ieee802154`` PF_IEEE802154 example
-======================================
+=======================================
TODO
diff --git a/Documentation/applications/examples/pipe/index.rst b/Documentation/applications/examples/pipe/index.rst
index ab1af3dae1..208c48e10f 100644
--- a/Documentation/applications/examples/pipe/index.rst
+++ b/Documentation/applications/examples/pipe/index.rst
@@ -1,3 +1,4 @@
+=====================
``pipe`` Pipe example
=====================
diff --git a/Documentation/applications/examples/poll/index.rst b/Documentation/applications/examples/poll/index.rst
index f277e6dd6f..864f1a2d19 100644
--- a/Documentation/applications/examples/poll/index.rst
+++ b/Documentation/applications/examples/poll/index.rst
@@ -1,3 +1,4 @@
+=====================
``poll`` Poll example
=====================
diff --git a/Documentation/applications/examples/popen/index.rst b/Documentation/applications/examples/popen/index.rst
index 978a1a7642..6cc24fd1ee 100644
--- a/Documentation/applications/examples/popen/index.rst
+++ b/Documentation/applications/examples/popen/index.rst
@@ -1,3 +1,4 @@
+=========================
``popen`` popen() example
=========================
diff --git a/Documentation/applications/examples/posix_spawn/index.rst b/Documentation/applications/examples/posix_spawn/index.rst
index 57de02a7cc..4d8d7b4e71 100644
--- a/Documentation/applications/examples/posix_spawn/index.rst
+++ b/Documentation/applications/examples/posix_spawn/index.rst
@@ -1,3 +1,4 @@
+=====================================
``posix_spawn`` posix_spawn Unit Test
=====================================
diff --git a/Documentation/applications/examples/powerled/index.rst b/Documentation/applications/examples/powerled/index.rst
index b05f1ec673..2a00a37c20 100644
--- a/Documentation/applications/examples/powerled/index.rst
+++ b/Documentation/applications/examples/powerled/index.rst
@@ -1,3 +1,4 @@
+====================================
``powerled`` Powerled driver example
====================================
diff --git a/Documentation/applications/examples/powermonitor/index.rst b/Documentation/applications/examples/powermonitor/index.rst
index 61e368a42f..5ef375c3e4 100644
--- a/Documentation/applications/examples/powermonitor/index.rst
+++ b/Documentation/applications/examples/powermonitor/index.rst
@@ -1,4 +1,5 @@
-``powermonitor``
-================
+=============================================
+``powermonitor`` LTC4151 powermonitor example
+=============================================
TODO
diff --git a/Documentation/applications/examples/pppd/index.rst b/Documentation/applications/examples/pppd/index.rst
index bcccc75768..8ececd728c 100644
--- a/Documentation/applications/examples/pppd/index.rst
+++ b/Documentation/applications/examples/pppd/index.rst
@@ -1,3 +1,4 @@
+============================
``pppd`` pppd client example
============================
diff --git a/Documentation/applications/examples/pty_test/index.rst b/Documentation/applications/examples/pty_test/index.rst
index 1b751aeda7..caaaac4016 100644
--- a/Documentation/applications/examples/pty_test/index.rst
+++ b/Documentation/applications/examples/pty_test/index.rst
@@ -1,3 +1,4 @@
+=============================
``pty_test`` Pseudo-Terminals
=============================
diff --git a/Documentation/applications/examples/pwfb/index.rst b/Documentation/applications/examples/pwfb/index.rst
index 4df0fb80dd..f8e669bbdc 100644
--- a/Documentation/applications/examples/pwfb/index.rst
+++ b/Documentation/applications/examples/pwfb/index.rst
@@ -1,3 +1,4 @@
+===============================================
``pwfb`` NX Per-Window Framebuffer Text Example
===============================================
diff --git a/Documentation/applications/examples/pwlines/index.rst b/Documentation/applications/examples/pwlines/index.rst
index 16ce0b776a..ca136c44bf 100644
--- a/Documentation/applications/examples/pwlines/index.rst
+++ b/Documentation/applications/examples/pwlines/index.rst
@@ -1,3 +1,4 @@
+======================================================
``pwlines`` NX Per-Window Framebuffer Graphics Example
======================================================
diff --git a/Documentation/applications/examples/pwm/index.rst b/Documentation/applications/examples/pwm/index.rst
index 8b6da9f21e..33519d722f 100644
--- a/Documentation/applications/examples/pwm/index.rst
+++ b/Documentation/applications/examples/pwm/index.rst
@@ -1,3 +1,4 @@
+===========================
``pwm`` General PWM Example
===========================
diff --git a/Documentation/applications/examples/qencoder/index.rst b/Documentation/applications/examples/qencoder/index.rst
index 5a0435bf61..df74fa42ff 100644
--- a/Documentation/applications/examples/qencoder/index.rst
+++ b/Documentation/applications/examples/qencoder/index.rst
@@ -1,3 +1,4 @@
+===============================
``qencoder`` Quadrature Encoder
===============================
diff --git a/Documentation/applications/examples/random/index.rst b/Documentation/applications/examples/random/index.rst
index eeeda94892..432bee8d7f 100644
--- a/Documentation/applications/examples/random/index.rst
+++ b/Documentation/applications/examples/random/index.rst
@@ -1,3 +1,4 @@
+=========================
``random`` Random Numbers
=========================
diff --git a/Documentation/applications/examples/relays/index.rst b/Documentation/applications/examples/relays/index.rst
index b7ab5b929e..be0fe18fb2 100644
--- a/Documentation/applications/examples/relays/index.rst
+++ b/Documentation/applications/examples/relays/index.rst
@@ -1,3 +1,4 @@
+=================
``relays`` Relays
=================
diff --git a/Documentation/applications/examples/rfid_readuid/index.rst b/Documentation/applications/examples/rfid_readuid/index.rst
index cebc71eafe..de3cb41879 100644
--- a/Documentation/applications/examples/rfid_readuid/index.rst
+++ b/Documentation/applications/examples/rfid_readuid/index.rst
@@ -1,3 +1,4 @@
+=============================
``rfid_readuid`` RFID example
=============================
diff --git a/Documentation/applications/examples/rgbled/index.rst b/Documentation/applications/examples/rgbled/index.rst
index c2ffe2da41..d5e88f76ea 100644
--- a/Documentation/applications/examples/rgbled/index.rst
+++ b/Documentation/applications/examples/rgbled/index.rst
@@ -1,3 +1,4 @@
+============================
``rgbled`` RGB LED Using PWM
============================
diff --git a/Documentation/applications/examples/romfs/index.rst b/Documentation/applications/examples/romfs/index.rst
index 03c408b68a..1bd6792f2b 100644
--- a/Documentation/applications/examples/romfs/index.rst
+++ b/Documentation/applications/examples/romfs/index.rst
@@ -1,3 +1,4 @@
+=====================
``romfs`` File System
=====================
diff --git a/Documentation/applications/examples/rpmsgsocket/index.rst b/Documentation/applications/examples/rpmsgsocket/index.rst
index f28707c457..e1836bd3d1 100644
--- a/Documentation/applications/examples/rpmsgsocket/index.rst
+++ b/Documentation/applications/examples/rpmsgsocket/index.rst
@@ -1,3 +1,4 @@
+====================================
``rpmsgsocket`` Rpmsg socket example
====================================
diff --git a/Documentation/applications/examples/sendmail/index.rst b/Documentation/applications/examples/sendmail/index.rst
index e23215d429..94a7c1be3e 100644
--- a/Documentation/applications/examples/sendmail/index.rst
+++ b/Documentation/applications/examples/sendmail/index.rst
@@ -1,3 +1,4 @@
+========================
``sendmail`` SMTP Client
========================
diff --git a/Documentation/applications/examples/serialblaster/index.rst b/Documentation/applications/examples/serialblaster/index.rst
index 6b56449538..15df74c35f 100644
--- a/Documentation/applications/examples/serialblaster/index.rst
+++ b/Documentation/applications/examples/serialblaster/index.rst
@@ -1,3 +1,4 @@
+========================================
``serialblaster`` Serial Blaster example
========================================
diff --git a/Documentation/applications/examples/serialrx/index.rst b/Documentation/applications/examples/serialrx/index.rst
index a7eb9bf823..5ea0900f06 100644
--- a/Documentation/applications/examples/serialrx/index.rst
+++ b/Documentation/applications/examples/serialrx/index.rst
@@ -1,3 +1,4 @@
+==============================
``serialrx`` Serial RX example
==============================
diff --git a/Documentation/applications/examples/serloop/index.rst b/Documentation/applications/examples/serloop/index.rst
index 48ca279dff..6d76547bce 100644
--- a/Documentation/applications/examples/serloop/index.rst
+++ b/Documentation/applications/examples/serloop/index.rst
@@ -1,3 +1,4 @@
+===========================
``serloop`` Serial Loopback
===========================
diff --git a/Documentation/applications/examples/shm_test/index.rst b/Documentation/applications/examples/shm_test/index.rst
index 3ca80dc791..04ab62ac5a 100644
--- a/Documentation/applications/examples/shm_test/index.rst
+++ b/Documentation/applications/examples/shm_test/index.rst
@@ -1,3 +1,4 @@
+========================
``shm_test`` SHM example
========================
diff --git a/Documentation/applications/examples/sht3x/index.rst b/Documentation/applications/examples/sht3x/index.rst
index 96a6d087a2..649c0fb81b 100644
--- a/Documentation/applications/examples/sht3x/index.rst
+++ b/Documentation/applications/examples/sht3x/index.rst
@@ -1,3 +1,4 @@
+==============================
``sht3x`` SHT3x sensor example
==============================
diff --git a/Documentation/applications/examples/slcd/index.rst b/Documentation/applications/examples/slcd/index.rst
index 16e9fc65fc..0874e18109 100644
--- a/Documentation/applications/examples/slcd/index.rst
+++ b/Documentation/applications/examples/slcd/index.rst
@@ -1,3 +1,4 @@
+=================================
``slcd`` Alphanumeric Segment LCD
=================================
diff --git a/Documentation/applications/examples/smps/index.rst b/Documentation/applications/examples/smps/index.rst
index 2b0b652207..7d1b9b3631 100644
--- a/Documentation/applications/examples/smps/index.rst
+++ b/Documentation/applications/examples/smps/index.rst
@@ -1,3 +1,4 @@
+===================================
``smps`` Switched-Mode Power Supply
===================================
diff --git a/Documentation/applications/examples/sotest/index.rst b/Documentation/applications/examples/sotest/index.rst
index cf39999af9..0ab2c0140c 100644
--- a/Documentation/applications/examples/sotest/index.rst
+++ b/Documentation/applications/examples/sotest/index.rst
@@ -1,3 +1,4 @@
+=====================================
``sotest`` Shared Library Module Test
=====================================
diff --git a/Documentation/applications/examples/stat/index.rst b/Documentation/applications/examples/stat/index.rst
index 94f64fd30a..3f3d359162 100644
--- a/Documentation/applications/examples/stat/index.rst
+++ b/Documentation/applications/examples/stat/index.rst
@@ -1,3 +1,4 @@
+==============================================
``stat`` Test of stat(), fstat(), and statfs()
==============================================
diff --git a/Documentation/applications/examples/sx127x_demo/index.rst b/Documentation/applications/examples/sx127x_demo/index.rst
index 41b823a0bb..7e3cc329c9 100644
--- a/Documentation/applications/examples/sx127x_demo/index.rst
+++ b/Documentation/applications/examples/sx127x_demo/index.rst
@@ -1,3 +1,4 @@
+============================
``sx127x_demo`` SX127X Radio
============================
diff --git a/Documentation/applications/examples/system/index.rst b/Documentation/applications/examples/system/index.rst
index da84bb2ba1..34ce39ddf6 100644
--- a/Documentation/applications/examples/system/index.rst
+++ b/Documentation/applications/examples/system/index.rst
@@ -1,3 +1,4 @@
+===========================
``system`` System() example
===========================
diff --git a/Documentation/applications/examples/tcp_ipc_client/index.rst b/Documentation/applications/examples/tcp_ipc_client/index.rst
index 13e285ef52..90bda3508b 100644
--- a/Documentation/applications/examples/tcp_ipc_client/index.rst
+++ b/Documentation/applications/examples/tcp_ipc_client/index.rst
@@ -1,3 +1,4 @@
+===========================================
``tcp_ipc_client`` Client for TCP IPC NuttX
===========================================
diff --git a/Documentation/applications/examples/tcp_ipc_server/index.rst b/Documentation/applications/examples/tcp_ipc_server/index.rst
index f4eb0c42a2..c956b59466 100644
--- a/Documentation/applications/examples/tcp_ipc_server/index.rst
+++ b/Documentation/applications/examples/tcp_ipc_server/index.rst
@@ -1,3 +1,4 @@
+===========================================
``tcp_ipc_server`` Server for TCP IPC NuttX
===========================================
diff --git a/Documentation/applications/examples/tcpblaster/index.rst b/Documentation/applications/examples/tcpblaster/index.rst
index 06700a06d2..79a0a34eb9 100644
--- a/Documentation/applications/examples/tcpblaster/index.rst
+++ b/Documentation/applications/examples/tcpblaster/index.rst
@@ -1,3 +1,4 @@
+===================================
``tcpblaster`` TCP Performance Test
===================================
diff --git a/Documentation/applications/examples/tcpecho/index.rst b/Documentation/applications/examples/tcpecho/index.rst
index afdbdc6a13..90d48bd299 100644
--- a/Documentation/applications/examples/tcpecho/index.rst
+++ b/Documentation/applications/examples/tcpecho/index.rst
@@ -1,3 +1,4 @@
+===========================
``tcpecho`` TCP Echo Server
===========================
diff --git a/Documentation/applications/examples/telnetd/index.rst b/Documentation/applications/examples/telnetd/index.rst
index a43d7619a9..2ce0589a59 100644
--- a/Documentation/applications/examples/telnetd/index.rst
+++ b/Documentation/applications/examples/telnetd/index.rst
@@ -1,3 +1,4 @@
+===============================
``telnetd`` Simple Telnet Shell
===============================
diff --git a/Documentation/applications/examples/termios/index.rst b/Documentation/applications/examples/termios/index.rst
index a0fc8ce56e..31013edf39 100644
--- a/Documentation/applications/examples/termios/index.rst
+++ b/Documentation/applications/examples/termios/index.rst
@@ -1,3 +1,4 @@
+=========================================
``termios`` Simple Termios interface test
=========================================
diff --git a/Documentation/applications/examples/thttpd/index.rst b/Documentation/applications/examples/thttpd/index.rst
index d449026c92..164dccf260 100644
--- a/Documentation/applications/examples/thttpd/index.rst
+++ b/Documentation/applications/examples/thttpd/index.rst
@@ -1,3 +1,4 @@
+========================
``thttpd`` THTTPD server
========================
diff --git a/Documentation/applications/examples/tiff/index.rst b/Documentation/applications/examples/tiff/index.rst
index 26b0eed7e6..b874200061 100644
--- a/Documentation/applications/examples/tiff/index.rst
+++ b/Documentation/applications/examples/tiff/index.rst
@@ -1,3 +1,4 @@
+=====================================
``tiff`` TIFF file generation example
=====================================
diff --git a/Documentation/applications/examples/timer/index.rst b/Documentation/applications/examples/timer/index.rst
index 3352a92122..965e445d66 100644
--- a/Documentation/applications/examples/timer/index.rst
+++ b/Documentation/applications/examples/timer/index.rst
@@ -1,3 +1,4 @@
+=======================
``timer`` Timer example
=======================
diff --git a/Documentation/applications/examples/timer_gpio/index.rst b/Documentation/applications/examples/timer_gpio/index.rst
index 77cb1e2357..969ef5d16f 100644
--- a/Documentation/applications/examples/timer_gpio/index.rst
+++ b/Documentation/applications/examples/timer_gpio/index.rst
@@ -1,3 +1,4 @@
+=================================
``timer_gpio`` Timer GPIO example
=================================
diff --git a/Documentation/applications/examples/touchscreen/index.rst b/Documentation/applications/examples/touchscreen/index.rst
index c12bc95f3a..3a524095ab 100644
--- a/Documentation/applications/examples/touchscreen/index.rst
+++ b/Documentation/applications/examples/touchscreen/index.rst
@@ -1,3 +1,4 @@
+==================================
``touchscreen`` Touchscreen Events
==================================
diff --git a/Documentation/applications/examples/udp/index.rst b/Documentation/applications/examples/udp/index.rst
index d6cf351045..8019582bd7 100644
--- a/Documentation/applications/examples/udp/index.rst
+++ b/Documentation/applications/examples/udp/index.rst
@@ -1,3 +1,4 @@
+==============================
``udp`` Client/Server Over UDP
==============================
diff --git a/Documentation/applications/examples/udpblaster/index.rst b/Documentation/applications/examples/udpblaster/index.rst
index c7ad4e6edc..f06718c8f2 100644
--- a/Documentation/applications/examples/udpblaster/index.rst
+++ b/Documentation/applications/examples/udpblaster/index.rst
@@ -1,3 +1,4 @@
+==================================
``udpblaster`` UDP blaster example
==================================
diff --git a/Documentation/applications/examples/uid/index.rst b/Documentation/applications/examples/uid/index.rst
index 7e44434d31..1cda5d74af 100644
--- a/Documentation/applications/examples/uid/index.rst
+++ b/Documentation/applications/examples/uid/index.rst
@@ -1,3 +1,4 @@
+=======================
``uid`` UID/GID example
=======================
diff --git a/Documentation/applications/examples/unionfs/index.rst b/Documentation/applications/examples/unionfs/index.rst
index 2402bb15ec..de1367018c 100644
--- a/Documentation/applications/examples/unionfs/index.rst
+++ b/Documentation/applications/examples/unionfs/index.rst
@@ -1,3 +1,4 @@
+=============================
``unionfs`` Union File System
=============================
diff --git a/Documentation/applications/examples/usbserial/index.rst b/Documentation/applications/examples/usbserial/index.rst
index 0bae8bcd83..09c0caa0b2 100644
--- a/Documentation/applications/examples/usbserial/index.rst
+++ b/Documentation/applications/examples/usbserial/index.rst
@@ -1,3 +1,4 @@
+====================================
``usbserial`` USB Serial Hello World
====================================
diff --git a/Documentation/applications/examples/userfs/index.rst b/Documentation/applications/examples/userfs/index.rst
index 8c6f91bf75..a661534e71 100644
--- a/Documentation/applications/examples/userfs/index.rst
+++ b/Documentation/applications/examples/userfs/index.rst
@@ -1,3 +1,4 @@
+=============================
``userfs`` UserFS File System
=============================
diff --git a/Documentation/applications/examples/usrsocktest/index.rst b/Documentation/applications/examples/usrsocktest/index.rst
index 3b7370087f..bef25a3245 100644
--- a/Documentation/applications/examples/usrsocktest/index.rst
+++ b/Documentation/applications/examples/usrsocktest/index.rst
@@ -1,4 +1,5 @@
+====================================
``usrsocktest`` USRSOCK test example
-===================================
+====================================
TODO
diff --git a/Documentation/applications/examples/ustream/index.rst b/Documentation/applications/examples/ustream/index.rst
index c8e1c08b17..abf414eaf3 100644
--- a/Documentation/applications/examples/ustream/index.rst
+++ b/Documentation/applications/examples/ustream/index.rst
@@ -1,3 +1,4 @@
+===============================
``ustream`` Unix Stream Sockets
===============================
diff --git a/Documentation/applications/examples/veml6070/index.rst b/Documentation/applications/examples/veml6070/index.rst
index 6409090d3a..6053a5cefc 100644
--- a/Documentation/applications/examples/veml6070/index.rst
+++ b/Documentation/applications/examples/veml6070/index.rst
@@ -1,3 +1,4 @@
+================================================
``veml6070`` VEML6070 UltraViolet sensor example
================================================
diff --git a/Documentation/applications/examples/watcher/index.rst b/Documentation/applications/examples/watcher/index.rst
index 54aad7e0c8..27c07c11b6 100644
--- a/Documentation/applications/examples/watcher/index.rst
+++ b/Documentation/applications/examples/watcher/index.rst
@@ -1,3 +1,4 @@
+=============================
``watcher`` Watcher & Watched
=============================
diff --git a/Documentation/applications/examples/webserver/index.rst b/Documentation/applications/examples/webserver/index.rst
index d2c3c093f3..2a47c79278 100644
--- a/Documentation/applications/examples/webserver/index.rst
+++ b/Documentation/applications/examples/webserver/index.rst
@@ -1,3 +1,4 @@
+==============================
``webserver`` Simple Webserver
==============================
diff --git a/Documentation/applications/examples/wget/index.rst b/Documentation/applications/examples/wget/index.rst
index 68a7ae445e..ff181833c8 100644
--- a/Documentation/applications/examples/wget/index.rst
+++ b/Documentation/applications/examples/wget/index.rst
@@ -1,3 +1,4 @@
+===================
``wget`` Web Client
===================
diff --git a/Documentation/applications/examples/wgetjson/index.rst b/Documentation/applications/examples/wgetjson/index.rst
index 45679c0ada..174ce2c40f 100644
--- a/Documentation/applications/examples/wgetjson/index.rst
+++ b/Documentation/applications/examples/wgetjson/index.rst
@@ -1,3 +1,4 @@
+====================================
``wgetjson`` GET JSON Using ``wget``
====================================
diff --git a/Documentation/applications/examples/wiegand/index.rst b/Documentation/applications/examples/wiegand/index.rst
index ee3bdd50ae..3616aefb74 100644
--- a/Documentation/applications/examples/wiegand/index.rst
+++ b/Documentation/applications/examples/wiegand/index.rst
@@ -1,3 +1,4 @@
+===========================
``wiegand`` Wiegand example
===========================
diff --git a/Documentation/applications/examples/ws2812/index.rst b/Documentation/applications/examples/ws2812/index.rst
index 671c2f8c44..844ab6db60 100644
--- a/Documentation/applications/examples/ws2812/index.rst
+++ b/Documentation/applications/examples/ws2812/index.rst
@@ -1,3 +1,4 @@
+======================
``ws2812`` ws2812 Demo
======================
diff --git a/Documentation/applications/examples/ws2812esp32rmt/index.rst b/Documentation/applications/examples/ws2812esp32rmt/index.rst
index 5e2897c6c8..c981d9a26d 100644
--- a/Documentation/applications/examples/ws2812esp32rmt/index.rst
+++ b/Documentation/applications/examples/ws2812esp32rmt/index.rst
@@ -1,3 +1,4 @@
+==============================================
``ws2812esp32rmt`` ws2812 Demo using ESP32_RMT
==============================================
diff --git a/Documentation/applications/examples/xbc_test/index.rst b/Documentation/applications/examples/xbc_test/index.rst
index 4235670f36..778ee6b5b1 100644
--- a/Documentation/applications/examples/xbc_test/index.rst
+++ b/Documentation/applications/examples/xbc_test/index.rst
@@ -1,3 +1,4 @@
+====================================
``xbc_test`` XBox Controller Example
====================================
diff --git a/Documentation/applications/examples/xmlrpc/index.rst b/Documentation/applications/examples/xmlrpc/index.rst
index 748767e228..e60b9704b3 100644
--- a/Documentation/applications/examples/xmlrpc/index.rst
+++ b/Documentation/applications/examples/xmlrpc/index.rst
@@ -1,3 +1,4 @@
+=========================
``xmlrpc`` XML-RPC Server
=========================
diff --git a/Documentation/applications/examples/zerocross/index.rst b/Documentation/applications/examples/zerocross/index.rst
index 294db21e35..989e78651d 100644
--- a/Documentation/applications/examples/zerocross/index.rst
+++ b/Documentation/applications/examples/zerocross/index.rst
@@ -1,3 +1,4 @@
+==================================
``zerocross`` Zero Crossing Device
==================================
[nuttx] 03/06: Documentaion: migrate examples/mcuboot readme
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 3d7a395f52058f4bcf6e908792a0cbaf497f5db4
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 16:03:13 2023 +0200
Documentaion: migrate examples/mcuboot readme
---
.../applications/examples/mcuboot/index.rst | 127 ++++++++++++++++++++-
1 file changed, 126 insertions(+), 1 deletion(-)
diff --git a/Documentation/applications/examples/mcuboot/index.rst b/Documentation/applications/examples/mcuboot/index.rst
index fa3661d1ab..087144e1f8 100644
--- a/Documentation/applications/examples/mcuboot/index.rst
+++ b/Documentation/applications/examples/mcuboot/index.rst
@@ -1,4 +1,129 @@
``mcuboot``
===========
-TODO
+``swap_test``
+-------------
+
+Description
+~~~~~~~~~~~
+
+MCUboot Swap Image is an application to demostrate firmware upgrade using
+internal flash memory. It simulate MCUboot API steps to switch between two
+valid images.
+
+This application add 3 Builtin Apps to NuttX NSH: version, set_img and confirm.
+After application is build and ``nuttx.bin`` be generated, the binary must be
+signed. Consult your board README file to get instructions how to do it.
+
+How to build and flash
+......................
+
+First step is build your board configuraton using ``mcuboot-loader`` as target.
+That create the bootloader itself. The ``nuttx.bin`` must be flash as usual.
+
+After that, clean up environment and set ``mcuboot-swap-test`` as target. The
+build output will generate the ``nuttx.bin`` file. You should execute the MCUboot
+script called ``imgtool.py`` and sign the binary file two times.
+
+The first time you will use ``--version 1.0.0`` and ``signedv1.bin`` as output file.
+Then, the second sign you need change to ``--version 2.0.0`` and ``signedv2.bin``
+as output file.
+
+The ``signedv1.bin`` file must be at MCUboot Slot-0 partition and ``signedv2.bin``
+at Slot-1.
+
+More instructions about how to sign and flash can be found at board README file.
+
+Running swap image test
+.......................
+
+Open you terminal and reboot your board. You can see a similar output as below.
+You can check builtin apps using command ``?``::
+
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> ?
+ help usage: help [-v] [<cmd>]
+
+ . cd echo hexdump mv rmdir true xd
+ [ cp exec kill printf set truncate
+ ? cmp exit ls ps sleep uname
+ basename dirname false mkdir pwd source umount
+ break dd free mkrd reboot test unset
+ cat df help mount rm time usleep
+
+ Builtin Apps:
+ mcuboot_set_img mcuboot_confirm sh
+ mcuboot_version ramtest nsh
+ nsh>
+
+First step (check version)::
+
+ nsh> mcuboot_version
+ Image version 1.0.0.0
+ nsh>
+
+Second step (mark image as good because it is running). This is an optional
+step that must be executed if you ran ``imgtool.py`` without optional parameter
+``--confirm``::
+
+ nsh> mcuboot_confirm
+ Application Image successfully confirmed!
+ nsh>
+
+Third step (let's reboot and see whats happen)::
+
+ nsh> reboot
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> mcuboot_version
+ Image version 1.0.0.0
+ nsh>
+
+Fourth step (let's switch image)::
+
+ nsh> mcuboot_set_img
+ Requested update for next boot. Restarting...
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> mcuboot_version
+ Image version 2.0.0.0
+ nsh>
+
+Now, we switched from image version 1.0.0 to image 2.0.0. However, we intentionaly
+will not run ``mcuboot_confirm`` app::
+
+ nsh> reboot
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> mcuboot_version
+ Image version 1.0.0.0
+ nsh>
+
+This means that if for any reason App reboot, have a malfunctioning or not boot,
+MCUboot will switch back to old ``good`` image! Remember that we executed
+``mcuboot_confirm`` at step two.
+
+Fifth step (switch to image version 2 and mark as permanent)::
+
+ nsh> mcuboot_set_img
+ Requested update for next boot. Restarting...
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> mcuboot_confirm
+ Application Image successfully confirmed!
+ nsh> mcuboot_version
+ Image version 2.0.0.0
+ nsh>
+
+Sixth step (Reboot and confirm V2 image)::
+
+ nsh> reboot
+ *** Booting MCUboot build 7c890f4b075aed73e4c825ccf875b2fb9ebf2ded ***
+ NuttShell (NSH) NuttX-10.2.0
+ nsh> mcuboot_version
+ Image version 2.0.0.0
+ nsh>
+
+Conclusion, once we boot a newer image and confirm it MCUboot always run that
+image, unless you instruct it to swap again!
[nuttx] 01/06: Documentaion: migrate graphics/lvgl readme
Posted by xi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit c4b2c650780fda3ca53dc032b42f2e369fd92122
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 15:43:50 2023 +0200
Documentaion: migrate graphics/lvgl readme
---
Documentation/applications/graphics/index.rst | 8 ++++++-
Documentation/applications/graphics/lvgl/index.rst | 27 ++++++++++++++++++++++
2 files changed, 34 insertions(+), 1 deletion(-)
diff --git a/Documentation/applications/graphics/index.rst b/Documentation/applications/graphics/index.rst
index af6ce64e76..48494352c5 100644
--- a/Documentation/applications/graphics/index.rst
+++ b/Documentation/applications/graphics/index.rst
@@ -2,10 +2,16 @@
Graphics Support
================
+.. toctree::
+ :glob:
+ :maxdepth: 3
+ :titlesonly:
+
+ */*
+
- ft80x - FTDI/BridgeTek FT80x library
- libjpeg - libjpeg JPEG image encoding
- libyuv - libyuv
-- lvgl - Light and Versatile Graphic Library (LVGL)
- nxwidgets - NxWidgets
- nxwm - NuttX Tiny Window Manager (NxWM)
- pdcurs34 - pdcurses Text User Interface (TUI)
diff --git a/Documentation/applications/graphics/lvgl/index.rst b/Documentation/applications/graphics/lvgl/index.rst
new file mode 100644
index 0000000000..0a18e1251c
--- /dev/null
+++ b/Documentation/applications/graphics/lvgl/index.rst
@@ -0,0 +1,27 @@
+====
+LVGL
+====
+
+Usage
+-----
+
+Import with ``#include <lvgl/lvgl.h>`` or ``#include <lvgl.h>``.
+
+Upstream example ported to NuttX is present at ``examples/lvgldemo``.
+
+LVGL can be used with framebuffer device. To find example boards with this
+preconfigured, search for ``CONFIG_GRAPHICS_LVGL=y`` in ``defconfig`` files. All of
+them have also ``CONFIG_VIDEO_FB=y`` present.
+
+As a second option, LVGL can talk to a display driver and explicitly draw line
+by line. For this case, there is no preconfigured board present. Go to _Porting_
+section of upstream documentation for more hints.
+
+Resources
+---------
+
+- `API documentation with examples <https://docs.lvgl.io/latest/en/html/index.html>`_
+- `GitHub / LVGL / LVGL library <https://github.com/lvgl/lvgl>`_
+- `GitHub / LVGL / Examples, tutorials, applications <https://github.com/lvgl/lv_examples>`_
+- `GitHub / LVGL / Desktop simulator <https://github.com/lvgl/lv_sim_eclipse_sdl>`_
+- `GitHub / LVGL / Web simulator <https://github.com/lvgl/lv_sim_emscripten>`_