From d1ebe6cd24c6bbbe7cfb078606bd1aabe4650abf Mon Sep 17 00:00:00 2001 From: raiden00pl Date: Tue, 24 Oct 2023 15:35:33 +0200 Subject: [PATCH] Documentation: add dummy apps descriptions The apps description is empty for now but allows to generate nice tables of content with all nuttx-apps functionalities. --- .../applications/audioutils/fmsynt/index.rst | 4 ++ .../applications/audioutils/index.rst | 3 -- .../applications/audioutils/nxaudio/index.rst | 3 ++ .../benchmarks/coremark/index.rst | 3 ++ .../applications/benchmarks/index.rst | 8 ++- .../applications/canutils/candump/index.rst | 3 ++ .../applications/canutils/canlib/index.rst | 3 ++ .../applications/canutils/cansend/index.rst | 3 ++ Documentation/applications/canutils/index.rst | 16 +++--- .../canutils/lely-canopen/index.rst | 3 ++ .../canutils/libcanutils/index.rst | 3 ++ .../canutils/libdronecan/index.rst | 3 ++ .../applications/canutils/libobd2/index.rst | 3 ++ .../canutils/libopecyphal/index.rst | 3 ++ .../applications/canutils/slcan/index.rst | 3 ++ .../applications/crypto/controlse/index.rst | 3 ++ Documentation/applications/crypto/index.rst | 8 --- .../applications/crypto/libsodium/index.rst | 3 ++ .../applications/crypto/libtomcrypt/index.rst | 3 ++ .../applications/crypto/mbedtls/index.rst | 3 ++ .../applications/crypto/tinycrypt/index.rst | 3 ++ .../applications/crypto/tinydtls/index.rst | 3 ++ .../fsutils/flash_eraseall/index.rst | 3 ++ Documentation/applications/fsutils/index.rst | 10 ---- .../applications/fsutils/inih/index.rst | 3 ++ .../applications/fsutils/ipcfg/index.rst | 3 ++ .../fsutils/libtinycbor/index.rst | 3 ++ .../applications/fsutils/mkfatfs/index.rst | 3 ++ .../applications/fsutils/mkgpt/index.rst | 3 ++ .../applications/fsutils/mkmbr/index.rst | 3 ++ .../applications/fsutils/mksmartfs/index.rst | 3 ++ .../applications/fsutils/passwd/index.rst | 3 ++ .../applications/games/brickmatch/index.rst | 6 +-- .../applications/graphics/ft80x/index.rst | 3 ++ Documentation/applications/graphics/index.rst | 7 --- .../applications/graphics/libjpeg/index.rst | 3 ++ .../applications/graphics/libyuv/index.rst | 3 ++ .../graphics/screenshot/index.rst | 3 ++ .../applications/graphics/slcd/index.rst | 3 ++ .../applications/industry/foc/index.rst | 3 ++ Documentation/applications/industry/index.rst | 4 -- .../applications/industry/scpi/index.rst | 3 ++ Documentation/applications/inertial/index.rst | 8 ++- .../applications/inertial/madgwick/index.rst | 3 ++ .../interpreters/duktape/index.rst | 3 ++ .../applications/interpreters/index.rst | 8 --- .../applications/interpreters/lua/index.rst | 8 +++ .../interpreters/luajit/index.rst | 3 ++ .../interpreters/quickjs/index.rst | 3 ++ .../interpreters/toywasm/index.rst | 3 ++ .../applications/interpreters/wamr/index.rst | 3 ++ .../applications/interpreters/wasm3/index.rst | 3 ++ .../applications/lte/alt1250/index.rst | 3 ++ Documentation/applications/lte/index.rst | 9 +++- Documentation/applications/lte/lapi/index.rst | 3 ++ Documentation/applications/math/index.rst | 8 ++- .../applications/math/libtommath/index.rst | 3 ++ .../applications/mlearing/cmsis/index.rst | 3 ++ .../applications/mlearing/darknet/index.rst | 3 ++ Documentation/applications/mlearing/index.rst | 10 ++-- .../mlearing/libnnablart/index.rst | 3 ++ .../applications/netutils/chat/index.rst | 3 ++ .../applications/netutils/codecs/index.rst | 4 ++ .../netutils/cwebsocket/index.rst | 3 ++ .../applications/netutils/dhcp6c/index.rst | 3 ++ Documentation/applications/netutils/index.rst | 19 ------- .../applications/netutils/iptables/index.rst | 3 ++ .../netutils/libcurl4nx/index.rst | 3 ++ .../applications/netutils/mqttc/index.rst | 3 ++ .../applications/netutils/netinit/index.rst | 3 ++ .../applications/netutils/netlib/index.rst | 3 ++ .../applications/netutils/nng/index.rst | 3 ++ .../applications/netutils/pppd/index.rst | 3 ++ .../applications/netutils/ptpd/index.rst | 3 ++ .../applications/netutils/rexec/index.rst | 3 ++ .../applications/netutils/rexecd/index.rst | 3 ++ .../applications/netutils/rtptools/index.rst | 3 ++ .../applications/netutils/wakaama/index.rst | 3 ++ .../applications/netutils/wakeonlan/index.rst | 3 ++ Documentation/applications/sdr/index.rst | 8 ++- .../applications/sdr/liquid_dsp/index.rst | 3 ++ .../applications/system/adb/index.rst | 3 ++ .../applications/system/argtable3/index.rst | 3 ++ .../applications/system/cachespeed/index.rst | 3 ++ .../applications/system/cle/index.rst | 3 ++ .../applications/system/coredump/index.rst | 3 ++ .../applications/system/crimon/index.rst | 3 ++ .../applications/system/cu/index.rst | 3 ++ .../applications/system/dd/index.rst | 3 ++ .../applications/system/dhcp6c/index.rst | 3 ++ .../applications/system/dhcpc/index.rst | 3 ++ .../applications/system/dumpstack/index.rst | 3 ++ .../applications/system/fastboot/index.rst | 3 ++ .../applications/system/fdt/index.rst | 3 ++ .../applications/system/gcov/index.rst | 3 ++ .../applications/system/gdbstub/index.rst | 3 ++ .../applications/system/hex2bin/index.rst | 3 ++ .../applications/system/hexed/index.rst | 3 ++ .../applications/system/hostname/index.rst | 3 ++ Documentation/applications/system/index.rst | 52 ------------------- .../applications/system/input/index.rst | 3 ++ .../applications/system/iptables/index.rst | 3 ++ .../applications/system/lm75/index.rst | 3 ++ .../applications/system/lzf/index.rst | 3 ++ .../applications/system/mdio/index.rst | 3 ++ .../applications/system/memstress/index.rst | 3 ++ .../applications/system/netdb/index.rst | 3 ++ .../applications/system/ntpc/index.rst | 3 ++ .../applications/system/nxcamera/index.rst | 3 ++ .../applications/system/nxlooper/index.rst | 3 ++ .../applications/system/nxrecorder/index.rst | 3 ++ .../applications/system/ofloader/index.rst | 3 ++ .../applications/system/ping/index.rst | 3 ++ .../applications/system/ping6/index.rst | 3 ++ .../applications/system/popen/index.rst | 3 ++ .../applications/system/ptpd/index.rst | 3 ++ .../applications/system/ramspeed/index.rst | 3 ++ .../applications/system/ramtest/index.rst | 3 ++ .../applications/system/readline/index.rst | 3 ++ .../applications/system/sched_note/index.rst | 3 ++ .../applications/system/setlogmask/index.rst | 3 ++ .../system/stackmonitor/index.rst | 3 ++ .../applications/system/system/index.rst | 3 ++ .../applications/system/taskset/index.rst | 3 ++ .../applications/system/tcpdump/index.rst | 3 ++ .../applications/system/tee/index.rst | 3 ++ .../applications/system/telnet/index.rst | 3 ++ .../applications/system/telnetd/index.rst | 3 ++ .../applications/system/ubloxmodem/index.rst | 3 ++ .../applications/system/uniqueid/index.rst | 3 ++ .../applications/system/uorb/index.rst | 3 ++ .../applications/system/vi/index.rst | 3 ++ .../applications/system/zlib/index.rst | 3 ++ .../applications/testing/atomic/index.rst | 3 ++ .../testing/batterydump/index.rst | 3 ++ .../applications/testing/cmocka/index.rst | 3 ++ .../applications/testing/cpuload/index.rst | 3 ++ .../applications/testing/crypto/index.rst | 3 ++ .../applications/testing/drivertest/index.rst | 3 ++ .../applications/testing/fatutf8/index.rst | 3 ++ .../applications/testing/fdsantest/index.rst | 3 ++ .../applications/testing/getprime/index.rst | 3 ++ Documentation/applications/testing/index.rst | 24 --------- .../applications/testing/iozone/index.rst | 3 ++ .../applications/testing/irtest/index.rst | 3 ++ .../applications/testing/lpt/index.rst | 3 ++ .../applications/testing/memtester/index.rst | 3 ++ .../applications/testing/monkey/index.rst | 3 ++ .../applications/testing/nist-sts/index.rst | 3 ++ .../applications/testing/osperf/index.rst | 3 ++ .../applications/testing/scanftest/index.rst | 3 ++ .../applications/testing/sensortest/index.rst | 3 ++ .../applications/testing/setest/index.rst | 3 ++ .../applications/testing/superpi/index.rst | 3 ++ .../testing/uclibcxx_test/index.rst | 3 ++ Documentation/applications/tools/index.rst | 2 +- .../applications/wireless/gs2200m/index.rst | 3 ++ .../applications/wireless/i8shark/index.rst | 3 ++ Documentation/applications/wireless/index.rst | 5 -- .../applications/wireless/ipwan/index.rst | 3 ++ .../applications/wireless/libmac/index.rst | 3 ++ 161 files changed, 486 insertions(+), 162 deletions(-) create mode 100644 Documentation/applications/audioutils/fmsynt/index.rst create mode 100644 Documentation/applications/audioutils/nxaudio/index.rst create mode 100644 Documentation/applications/benchmarks/coremark/index.rst create mode 100644 Documentation/applications/canutils/candump/index.rst create mode 100644 Documentation/applications/canutils/canlib/index.rst create mode 100644 Documentation/applications/canutils/cansend/index.rst create mode 100644 Documentation/applications/canutils/lely-canopen/index.rst create mode 100644 Documentation/applications/canutils/libcanutils/index.rst create mode 100644 Documentation/applications/canutils/libdronecan/index.rst create mode 100644 Documentation/applications/canutils/libobd2/index.rst create mode 100644 Documentation/applications/canutils/libopecyphal/index.rst create mode 100644 Documentation/applications/canutils/slcan/index.rst create mode 100644 Documentation/applications/crypto/controlse/index.rst create mode 100644 Documentation/applications/crypto/libsodium/index.rst create mode 100644 Documentation/applications/crypto/libtomcrypt/index.rst create mode 100644 Documentation/applications/crypto/mbedtls/index.rst create mode 100644 Documentation/applications/crypto/tinycrypt/index.rst create mode 100644 Documentation/applications/crypto/tinydtls/index.rst create mode 100644 Documentation/applications/fsutils/flash_eraseall/index.rst create mode 100644 Documentation/applications/fsutils/inih/index.rst create mode 100644 Documentation/applications/fsutils/ipcfg/index.rst create mode 100644 Documentation/applications/fsutils/libtinycbor/index.rst create mode 100644 Documentation/applications/fsutils/mkfatfs/index.rst create mode 100644 Documentation/applications/fsutils/mkgpt/index.rst create mode 100644 Documentation/applications/fsutils/mkmbr/index.rst create mode 100644 Documentation/applications/fsutils/mksmartfs/index.rst create mode 100644 Documentation/applications/fsutils/passwd/index.rst create mode 100644 Documentation/applications/graphics/ft80x/index.rst create mode 100644 Documentation/applications/graphics/libjpeg/index.rst create mode 100644 Documentation/applications/graphics/libyuv/index.rst create mode 100644 Documentation/applications/graphics/screenshot/index.rst create mode 100644 Documentation/applications/graphics/slcd/index.rst create mode 100644 Documentation/applications/industry/foc/index.rst create mode 100644 Documentation/applications/industry/scpi/index.rst create mode 100644 Documentation/applications/inertial/madgwick/index.rst create mode 100644 Documentation/applications/interpreters/duktape/index.rst create mode 100644 Documentation/applications/interpreters/luajit/index.rst create mode 100644 Documentation/applications/interpreters/quickjs/index.rst create mode 100644 Documentation/applications/interpreters/toywasm/index.rst create mode 100644 Documentation/applications/interpreters/wamr/index.rst create mode 100644 Documentation/applications/interpreters/wasm3/index.rst create mode 100644 Documentation/applications/lte/alt1250/index.rst create mode 100644 Documentation/applications/lte/lapi/index.rst create mode 100644 Documentation/applications/math/libtommath/index.rst create mode 100644 Documentation/applications/mlearing/cmsis/index.rst create mode 100644 Documentation/applications/mlearing/darknet/index.rst create mode 100644 Documentation/applications/mlearing/libnnablart/index.rst create mode 100644 Documentation/applications/netutils/chat/index.rst create mode 100644 Documentation/applications/netutils/codecs/index.rst create mode 100644 Documentation/applications/netutils/cwebsocket/index.rst create mode 100644 Documentation/applications/netutils/dhcp6c/index.rst create mode 100644 Documentation/applications/netutils/iptables/index.rst create mode 100644 Documentation/applications/netutils/libcurl4nx/index.rst create mode 100644 Documentation/applications/netutils/mqttc/index.rst create mode 100644 Documentation/applications/netutils/netinit/index.rst create mode 100644 Documentation/applications/netutils/netlib/index.rst create mode 100644 Documentation/applications/netutils/nng/index.rst create mode 100644 Documentation/applications/netutils/pppd/index.rst create mode 100644 Documentation/applications/netutils/ptpd/index.rst create mode 100644 Documentation/applications/netutils/rexec/index.rst create mode 100644 Documentation/applications/netutils/rexecd/index.rst create mode 100644 Documentation/applications/netutils/rtptools/index.rst create mode 100644 Documentation/applications/netutils/wakaama/index.rst create mode 100644 Documentation/applications/netutils/wakeonlan/index.rst create mode 100644 Documentation/applications/sdr/liquid_dsp/index.rst create mode 100644 Documentation/applications/system/adb/index.rst create mode 100644 Documentation/applications/system/argtable3/index.rst create mode 100644 Documentation/applications/system/cachespeed/index.rst create mode 100644 Documentation/applications/system/cle/index.rst create mode 100644 Documentation/applications/system/coredump/index.rst create mode 100644 Documentation/applications/system/crimon/index.rst create mode 100644 Documentation/applications/system/cu/index.rst create mode 100644 Documentation/applications/system/dd/index.rst create mode 100644 Documentation/applications/system/dhcp6c/index.rst create mode 100644 Documentation/applications/system/dhcpc/index.rst create mode 100644 Documentation/applications/system/dumpstack/index.rst create mode 100644 Documentation/applications/system/fastboot/index.rst create mode 100644 Documentation/applications/system/fdt/index.rst create mode 100644 Documentation/applications/system/gcov/index.rst create mode 100644 Documentation/applications/system/gdbstub/index.rst create mode 100644 Documentation/applications/system/hex2bin/index.rst create mode 100644 Documentation/applications/system/hexed/index.rst create mode 100644 Documentation/applications/system/hostname/index.rst create mode 100644 Documentation/applications/system/input/index.rst create mode 100644 Documentation/applications/system/iptables/index.rst create mode 100644 Documentation/applications/system/lm75/index.rst create mode 100644 Documentation/applications/system/lzf/index.rst create mode 100644 Documentation/applications/system/mdio/index.rst create mode 100644 Documentation/applications/system/memstress/index.rst create mode 100644 Documentation/applications/system/netdb/index.rst create mode 100644 Documentation/applications/system/ntpc/index.rst create mode 100644 Documentation/applications/system/nxcamera/index.rst create mode 100644 Documentation/applications/system/nxlooper/index.rst create mode 100644 Documentation/applications/system/nxrecorder/index.rst create mode 100644 Documentation/applications/system/ofloader/index.rst create mode 100644 Documentation/applications/system/ping/index.rst create mode 100644 Documentation/applications/system/ping6/index.rst create mode 100644 Documentation/applications/system/popen/index.rst create mode 100644 Documentation/applications/system/ptpd/index.rst create mode 100644 Documentation/applications/system/ramspeed/index.rst create mode 100644 Documentation/applications/system/ramtest/index.rst create mode 100644 Documentation/applications/system/readline/index.rst create mode 100644 Documentation/applications/system/sched_note/index.rst create mode 100644 Documentation/applications/system/setlogmask/index.rst create mode 100644 Documentation/applications/system/stackmonitor/index.rst create mode 100644 Documentation/applications/system/system/index.rst create mode 100644 Documentation/applications/system/taskset/index.rst create mode 100644 Documentation/applications/system/tcpdump/index.rst create mode 100644 Documentation/applications/system/tee/index.rst create mode 100644 Documentation/applications/system/telnet/index.rst create mode 100644 Documentation/applications/system/telnetd/index.rst create mode 100644 Documentation/applications/system/ubloxmodem/index.rst create mode 100644 Documentation/applications/system/uniqueid/index.rst create mode 100644 Documentation/applications/system/uorb/index.rst create mode 100644 Documentation/applications/system/vi/index.rst create mode 100644 Documentation/applications/system/zlib/index.rst create mode 100644 Documentation/applications/testing/atomic/index.rst create mode 100644 Documentation/applications/testing/batterydump/index.rst create mode 100644 Documentation/applications/testing/cmocka/index.rst create mode 100644 Documentation/applications/testing/cpuload/index.rst create mode 100644 Documentation/applications/testing/crypto/index.rst create mode 100644 Documentation/applications/testing/drivertest/index.rst create mode 100644 Documentation/applications/testing/fatutf8/index.rst create mode 100644 Documentation/applications/testing/fdsantest/index.rst create mode 100644 Documentation/applications/testing/getprime/index.rst create mode 100644 Documentation/applications/testing/iozone/index.rst create mode 100644 Documentation/applications/testing/irtest/index.rst create mode 100644 Documentation/applications/testing/lpt/index.rst create mode 100644 Documentation/applications/testing/memtester/index.rst create mode 100644 Documentation/applications/testing/monkey/index.rst create mode 100644 Documentation/applications/testing/nist-sts/index.rst create mode 100644 Documentation/applications/testing/osperf/index.rst create mode 100644 Documentation/applications/testing/scanftest/index.rst create mode 100644 Documentation/applications/testing/sensortest/index.rst create mode 100644 Documentation/applications/testing/setest/index.rst create mode 100644 Documentation/applications/testing/superpi/index.rst create mode 100644 Documentation/applications/testing/uclibcxx_test/index.rst create mode 100644 Documentation/applications/wireless/gs2200m/index.rst create mode 100644 Documentation/applications/wireless/i8shark/index.rst create mode 100644 Documentation/applications/wireless/ipwan/index.rst create mode 100644 Documentation/applications/wireless/libmac/index.rst diff --git a/Documentation/applications/audioutils/fmsynt/index.rst b/Documentation/applications/audioutils/fmsynt/index.rst new file mode 100644 index 0000000000..754d7688e8 --- /dev/null +++ b/Documentation/applications/audioutils/fmsynt/index.rst @@ -0,0 +1,4 @@ +================================== +``fmsynth`` FM Synthesizer Library +================================== + diff --git a/Documentation/applications/audioutils/index.rst b/Documentation/applications/audioutils/index.rst index 23f456aed9..0291cadae5 100644 --- a/Documentation/applications/audioutils/index.rst +++ b/Documentation/applications/audioutils/index.rst @@ -9,6 +9,3 @@ Audio Utility libraries :caption: Contents */index* - -- fmsynth - FM Synthesizer Library -- nxaudio - NX Audio Library diff --git a/Documentation/applications/audioutils/nxaudio/index.rst b/Documentation/applications/audioutils/nxaudio/index.rst new file mode 100644 index 0000000000..995fdbd6b5 --- /dev/null +++ b/Documentation/applications/audioutils/nxaudio/index.rst @@ -0,0 +1,3 @@ +============================ +``nxaudio`` NX Audio Library +============================ diff --git a/Documentation/applications/benchmarks/coremark/index.rst b/Documentation/applications/benchmarks/coremark/index.rst new file mode 100644 index 0000000000..9d665cae15 --- /dev/null +++ b/Documentation/applications/benchmarks/coremark/index.rst @@ -0,0 +1,3 @@ +=============================== +``coremark`` CoreMark Benchmark +=============================== diff --git a/Documentation/applications/benchmarks/index.rst b/Documentation/applications/benchmarks/index.rst index 3679931b24..88e97af486 100644 --- a/Documentation/applications/benchmarks/index.rst +++ b/Documentation/applications/benchmarks/index.rst @@ -2,4 +2,10 @@ Benchmark Applications ====================== -- coremark - CoreMark Benchmark +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/canutils/candump/index.rst b/Documentation/applications/canutils/candump/index.rst new file mode 100644 index 0000000000..f8d97f9aad --- /dev/null +++ b/Documentation/applications/canutils/candump/index.rst @@ -0,0 +1,3 @@ +================================== +``candump`` SocketCAN candump tool +================================== diff --git a/Documentation/applications/canutils/canlib/index.rst b/Documentation/applications/canutils/canlib/index.rst new file mode 100644 index 0000000000..9c1ef10afe --- /dev/null +++ b/Documentation/applications/canutils/canlib/index.rst @@ -0,0 +1,3 @@ +============================== +``canlib`` CAN utility library +============================== diff --git a/Documentation/applications/canutils/cansend/index.rst b/Documentation/applications/canutils/cansend/index.rst new file mode 100644 index 0000000000..2344678ba1 --- /dev/null +++ b/Documentation/applications/canutils/cansend/index.rst @@ -0,0 +1,3 @@ +================================== +``cansend`` SocketCAN cansend tool +================================== diff --git a/Documentation/applications/canutils/index.rst b/Documentation/applications/canutils/index.rst index ff6571ff72..15d2e1c3bf 100644 --- a/Documentation/applications/canutils/index.rst +++ b/Documentation/applications/canutils/index.rst @@ -2,12 +2,10 @@ CAN Utilities ============= -- candump - SocketCAN candump tool -- canlib - CAN utility library -- cansend - SocketCAN cansend tool -- lely-canopen - Lely CANopen support -- libcanutils - CAN-utils support library -- libdronecan - libcanard DroneCAN Library -- libobd2 - OBD-II Library -- libopencyphal - libcanard OpenCyphal Cyphal/CAN Library -- slcan - SocketCAN slcan tool +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/canutils/lely-canopen/index.rst b/Documentation/applications/canutils/lely-canopen/index.rst new file mode 100644 index 0000000000..a15bbc43b2 --- /dev/null +++ b/Documentation/applications/canutils/lely-canopen/index.rst @@ -0,0 +1,3 @@ +===================================== +``lely-canopen`` Lely CANopen support +===================================== diff --git a/Documentation/applications/canutils/libcanutils/index.rst b/Documentation/applications/canutils/libcanutils/index.rst new file mode 100644 index 0000000000..8f133c9d37 --- /dev/null +++ b/Documentation/applications/canutils/libcanutils/index.rst @@ -0,0 +1,3 @@ +========================================= +``libcanutils`` CAN-utils support library +========================================= diff --git a/Documentation/applications/canutils/libdronecan/index.rst b/Documentation/applications/canutils/libdronecan/index.rst new file mode 100644 index 0000000000..dbbef171df --- /dev/null +++ b/Documentation/applications/canutils/libdronecan/index.rst @@ -0,0 +1,3 @@ +========================================== +``libdronecan`` libcanard DroneCAN Library +========================================== diff --git a/Documentation/applications/canutils/libobd2/index.rst b/Documentation/applications/canutils/libobd2/index.rst new file mode 100644 index 0000000000..e4118092f1 --- /dev/null +++ b/Documentation/applications/canutils/libobd2/index.rst @@ -0,0 +1,3 @@ +========================== +``libobd2`` OBD-II Library +========================== diff --git a/Documentation/applications/canutils/libopecyphal/index.rst b/Documentation/applications/canutils/libopecyphal/index.rst new file mode 100644 index 0000000000..a7ad80abf2 --- /dev/null +++ b/Documentation/applications/canutils/libopecyphal/index.rst @@ -0,0 +1,3 @@ +========================================================= +``libopencyphal`` libcanard OpenCyphal Cyphal/CAN Library +========================================================= diff --git a/Documentation/applications/canutils/slcan/index.rst b/Documentation/applications/canutils/slcan/index.rst new file mode 100644 index 0000000000..9e9afa35a8 --- /dev/null +++ b/Documentation/applications/canutils/slcan/index.rst @@ -0,0 +1,3 @@ +============================== +``slcan`` SocketCAN slcan tool +============================== diff --git a/Documentation/applications/crypto/controlse/index.rst b/Documentation/applications/crypto/controlse/index.rst new file mode 100644 index 0000000000..7b77bf3af4 --- /dev/null +++ b/Documentation/applications/crypto/controlse/index.rst @@ -0,0 +1,3 @@ +=========================================== +``controlse`` Control Secure Element device +=========================================== diff --git a/Documentation/applications/crypto/index.rst b/Documentation/applications/crypto/index.rst index 536936c851..a404d0c0fe 100644 --- a/Documentation/applications/crypto/index.rst +++ b/Documentation/applications/crypto/index.rst @@ -9,11 +9,3 @@ Cryptography Library Support :caption: Contents */index* - -- controlse - Control Secure Element device -- libsodium - Libsodium Cryptography Library -- libtomcrypt - LibTomCrypt CrypographyLibrary -- mbedtls - Mbed TLS Cryptography Library -- tinycrypt - TinyCrypt cryptography library -- tinydtls - Eclipse Tinydtls -- wolfssl - diff --git a/Documentation/applications/crypto/libsodium/index.rst b/Documentation/applications/crypto/libsodium/index.rst new file mode 100644 index 0000000000..8f9ffa4baa --- /dev/null +++ b/Documentation/applications/crypto/libsodium/index.rst @@ -0,0 +1,3 @@ +============================================ +``libsodium`` Libsodium Cryptography Library +============================================ diff --git a/Documentation/applications/crypto/libtomcrypt/index.rst b/Documentation/applications/crypto/libtomcrypt/index.rst new file mode 100644 index 0000000000..2042b6162c --- /dev/null +++ b/Documentation/applications/crypto/libtomcrypt/index.rst @@ -0,0 +1,3 @@ +============================================== +``libtomcrypt`` LibTomCrypt CrypographyLibrary +============================================== diff --git a/Documentation/applications/crypto/mbedtls/index.rst b/Documentation/applications/crypto/mbedtls/index.rst new file mode 100644 index 0000000000..7599ec6266 --- /dev/null +++ b/Documentation/applications/crypto/mbedtls/index.rst @@ -0,0 +1,3 @@ +========================================= +``mbedtls`` Mbed TLS Cryptography Library +========================================= diff --git a/Documentation/applications/crypto/tinycrypt/index.rst b/Documentation/applications/crypto/tinycrypt/index.rst new file mode 100644 index 0000000000..323a68daf7 --- /dev/null +++ b/Documentation/applications/crypto/tinycrypt/index.rst @@ -0,0 +1,3 @@ +============================================ +``tinycrypt`` TinyCrypt cryptography library +============================================ diff --git a/Documentation/applications/crypto/tinydtls/index.rst b/Documentation/applications/crypto/tinydtls/index.rst new file mode 100644 index 0000000000..ba9e4638bf --- /dev/null +++ b/Documentation/applications/crypto/tinydtls/index.rst @@ -0,0 +1,3 @@ +============================= +``tinydtls`` Eclipse Tinydtls +============================= diff --git a/Documentation/applications/fsutils/flash_eraseall/index.rst b/Documentation/applications/fsutils/flash_eraseall/index.rst new file mode 100644 index 0000000000..19f5ce1c29 --- /dev/null +++ b/Documentation/applications/fsutils/flash_eraseall/index.rst @@ -0,0 +1,3 @@ +============================================ +``flash_eraseall`` flash_eraseall() function +============================================ diff --git a/Documentation/applications/fsutils/index.rst b/Documentation/applications/fsutils/index.rst index d1ed4182aa..8c2f3937de 100644 --- a/Documentation/applications/fsutils/index.rst +++ b/Documentation/applications/fsutils/index.rst @@ -9,13 +9,3 @@ File System Utilities :caption: Contents */index* - -- flash_eraseall - flash_eraseall() function -- inih - inih ini file parser -- ipcfg - IP Configuration File Support -- libtinycbor - TinyCBOR Library (RFC 8949) -- mkfatfs - mkfatfs utility -- mkgpt - mkgpt utility -- mkmbr - mkmbr utility -- mksmartfs - mksmartfs utility -- passwd - Password file support diff --git a/Documentation/applications/fsutils/inih/index.rst b/Documentation/applications/fsutils/inih/index.rst new file mode 100644 index 0000000000..3049c88e94 --- /dev/null +++ b/Documentation/applications/fsutils/inih/index.rst @@ -0,0 +1,3 @@ +============================= +``inih`` inih ini file parser +============================= diff --git a/Documentation/applications/fsutils/ipcfg/index.rst b/Documentation/applications/fsutils/ipcfg/index.rst new file mode 100644 index 0000000000..db0808647e --- /dev/null +++ b/Documentation/applications/fsutils/ipcfg/index.rst @@ -0,0 +1,3 @@ +======================================= +``ipcfg`` IP Configuration File Support +======================================= diff --git a/Documentation/applications/fsutils/libtinycbor/index.rst b/Documentation/applications/fsutils/libtinycbor/index.rst new file mode 100644 index 0000000000..d53c7ed6a6 --- /dev/null +++ b/Documentation/applications/fsutils/libtinycbor/index.rst @@ -0,0 +1,3 @@ +=========================================== +``libtinycbor`` TinyCBOR Library (RFC 8949) +=========================================== diff --git a/Documentation/applications/fsutils/mkfatfs/index.rst b/Documentation/applications/fsutils/mkfatfs/index.rst new file mode 100644 index 0000000000..28ac72e332 --- /dev/null +++ b/Documentation/applications/fsutils/mkfatfs/index.rst @@ -0,0 +1,3 @@ +=========================== +``mkfatfs`` mkfatfs utility +=========================== diff --git a/Documentation/applications/fsutils/mkgpt/index.rst b/Documentation/applications/fsutils/mkgpt/index.rst new file mode 100644 index 0000000000..daf609266b --- /dev/null +++ b/Documentation/applications/fsutils/mkgpt/index.rst @@ -0,0 +1,3 @@ +======================= +``mkgpt`` mkgpt utility +======================= diff --git a/Documentation/applications/fsutils/mkmbr/index.rst b/Documentation/applications/fsutils/mkmbr/index.rst new file mode 100644 index 0000000000..2626e9218f --- /dev/null +++ b/Documentation/applications/fsutils/mkmbr/index.rst @@ -0,0 +1,3 @@ +======================= +``mkmbr`` mkmbr utility +======================= diff --git a/Documentation/applications/fsutils/mksmartfs/index.rst b/Documentation/applications/fsutils/mksmartfs/index.rst new file mode 100644 index 0000000000..fa43f649e6 --- /dev/null +++ b/Documentation/applications/fsutils/mksmartfs/index.rst @@ -0,0 +1,3 @@ +=============================== +``mksmartfs`` mksmartfs utility +=============================== diff --git a/Documentation/applications/fsutils/passwd/index.rst b/Documentation/applications/fsutils/passwd/index.rst new file mode 100644 index 0000000000..97bd361542 --- /dev/null +++ b/Documentation/applications/fsutils/passwd/index.rst @@ -0,0 +1,3 @@ +================================== +``passwd`` - Password file support +================================== diff --git a/Documentation/applications/games/brickmatch/index.rst b/Documentation/applications/games/brickmatch/index.rst index 3c0820f730..c6e918a89d 100644 --- a/Documentation/applications/games/brickmatch/index.rst +++ b/Documentation/applications/games/brickmatch/index.rst @@ -1,6 +1,6 @@ -========== -Brickmatch -========== +========================= +``brickmatch`` Brickmatch +========================= Brickmatch is a kind puzzle game like a mix between tetris and Candy Crush. It is a 6x6 matrix with blocks (cells) with different colors. diff --git a/Documentation/applications/graphics/ft80x/index.rst b/Documentation/applications/graphics/ft80x/index.rst new file mode 100644 index 0000000000..1f4c17bc2c --- /dev/null +++ b/Documentation/applications/graphics/ft80x/index.rst @@ -0,0 +1,3 @@ +====================================== +``ft80x`` FTDI/BridgeTek FT80x library +====================================== diff --git a/Documentation/applications/graphics/index.rst b/Documentation/applications/graphics/index.rst index 91c9c4eebe..a7436d443f 100644 --- a/Documentation/applications/graphics/index.rst +++ b/Documentation/applications/graphics/index.rst @@ -9,10 +9,3 @@ Graphics Support :caption: Contents */index* - -- ft80x - FTDI/BridgeTek FT80x library -- libjpeg - libjpeg JPEG image encoding -- libyuv - libyuv -- screenshot - TIFF screenshot utility -- slcd - Segment LCD Emulaton -- twm4nx - Minimal Tom's Window Manager (TWM) for NuttX (Twm4Nx) diff --git a/Documentation/applications/graphics/libjpeg/index.rst b/Documentation/applications/graphics/libjpeg/index.rst new file mode 100644 index 0000000000..726770892a --- /dev/null +++ b/Documentation/applications/graphics/libjpeg/index.rst @@ -0,0 +1,3 @@ +======================================= +``libjpeg`` libjpeg JPEG image encoding +======================================= diff --git a/Documentation/applications/graphics/libyuv/index.rst b/Documentation/applications/graphics/libyuv/index.rst new file mode 100644 index 0000000000..701936c974 --- /dev/null +++ b/Documentation/applications/graphics/libyuv/index.rst @@ -0,0 +1,3 @@ +================= +``libyuv`` libyuv +================= diff --git a/Documentation/applications/graphics/screenshot/index.rst b/Documentation/applications/graphics/screenshot/index.rst new file mode 100644 index 0000000000..995f31dde2 --- /dev/null +++ b/Documentation/applications/graphics/screenshot/index.rst @@ -0,0 +1,3 @@ +====================================== +``screenshot`` TIFF screenshot utility +====================================== diff --git a/Documentation/applications/graphics/slcd/index.rst b/Documentation/applications/graphics/slcd/index.rst new file mode 100644 index 0000000000..fa95d3638c --- /dev/null +++ b/Documentation/applications/graphics/slcd/index.rst @@ -0,0 +1,3 @@ +============================= +``slcd`` Segment LCD Emulaton +============================= diff --git a/Documentation/applications/industry/foc/index.rst b/Documentation/applications/industry/foc/index.rst new file mode 100644 index 0000000000..4098a3c5ef --- /dev/null +++ b/Documentation/applications/industry/foc/index.rst @@ -0,0 +1,3 @@ +================================================= +``foc`` Field Oriented Control user-space library +================================================= diff --git a/Documentation/applications/industry/index.rst b/Documentation/applications/industry/index.rst index 76721d705f..4751b4a12d 100644 --- a/Documentation/applications/industry/index.rst +++ b/Documentation/applications/industry/index.rst @@ -9,7 +9,3 @@ Industrial Applications :caption: Contents */index* - -- foc - Field Oriented Control user-space library -- scpi - SCPI instrument side parser -- modbus - Modbus support using FreeModbus diff --git a/Documentation/applications/industry/scpi/index.rst b/Documentation/applications/industry/scpi/index.rst new file mode 100644 index 0000000000..fd42bdd587 --- /dev/null +++ b/Documentation/applications/industry/scpi/index.rst @@ -0,0 +1,3 @@ +==================================== +``scpi`` SCPI instrument side parser +==================================== diff --git a/Documentation/applications/inertial/index.rst b/Documentation/applications/inertial/index.rst index 9c06bd5574..4f2c09e4eb 100644 --- a/Documentation/applications/inertial/index.rst +++ b/Documentation/applications/inertial/index.rst @@ -2,4 +2,10 @@ Inertial Libraries Support ========================== -- madgwick - Madgwick Fusion Algorithm +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/inertial/madgwick/index.rst b/Documentation/applications/inertial/madgwick/index.rst new file mode 100644 index 0000000000..9bc5118fb2 --- /dev/null +++ b/Documentation/applications/inertial/madgwick/index.rst @@ -0,0 +1,3 @@ +====================================== +``madgwick`` Madgwick Fusion Algorithm +====================================== diff --git a/Documentation/applications/interpreters/duktape/index.rst b/Documentation/applications/interpreters/duktape/index.rst new file mode 100644 index 0000000000..0c8fb1a5da --- /dev/null +++ b/Documentation/applications/interpreters/duktape/index.rst @@ -0,0 +1,3 @@ +========================================== +``duktape`` Duktape JavaScript interpreter +========================================== diff --git a/Documentation/applications/interpreters/index.rst b/Documentation/applications/interpreters/index.rst index db7ff68cdc..3bc36a1574 100644 --- a/Documentation/applications/interpreters/index.rst +++ b/Documentation/applications/interpreters/index.rst @@ -12,11 +12,3 @@ incorporated into NuttX. :caption: Contents */index* - -- duktape - Duktape JavaScript interpreter -- luajit - LuaJIT interpreter -- luamodules: cjson, lfs, luasyslog, luv -- quickjs - QuickJS JavaScript interpreter -- toywasm - Toywasm Webassembly Runtime -- wamr - Webassembly Micro Runtime -- wasm3 - WASM3 Webassembly Runtime diff --git a/Documentation/applications/interpreters/lua/index.rst b/Documentation/applications/interpreters/lua/index.rst index 1b088df1e1..4a85c1c357 100644 --- a/Documentation/applications/interpreters/lua/index.rst +++ b/Documentation/applications/interpreters/lua/index.rst @@ -15,3 +15,11 @@ toolchain provided math library. The following configs are recommended for a full featured Lua interpreter: - ``LIBC_FLOATINGPOINT`` - ``SYSTEM_READLINE`` + + +Lua modules: + +- cjson +- lfs +- luasyslog +- luv diff --git a/Documentation/applications/interpreters/luajit/index.rst b/Documentation/applications/interpreters/luajit/index.rst new file mode 100644 index 0000000000..3754feecfe --- /dev/null +++ b/Documentation/applications/interpreters/luajit/index.rst @@ -0,0 +1,3 @@ +============================= +``luajit`` LuaJIT interpreter +============================= diff --git a/Documentation/applications/interpreters/quickjs/index.rst b/Documentation/applications/interpreters/quickjs/index.rst new file mode 100644 index 0000000000..e7c835e357 --- /dev/null +++ b/Documentation/applications/interpreters/quickjs/index.rst @@ -0,0 +1,3 @@ +========================================== +``quickjs`` QuickJS JavaScript interpreter +========================================== diff --git a/Documentation/applications/interpreters/toywasm/index.rst b/Documentation/applications/interpreters/toywasm/index.rst new file mode 100644 index 0000000000..a62a05674f --- /dev/null +++ b/Documentation/applications/interpreters/toywasm/index.rst @@ -0,0 +1,3 @@ +======================================= +``toywasm`` Toywasm Webassembly Runtime +======================================= diff --git a/Documentation/applications/interpreters/wamr/index.rst b/Documentation/applications/interpreters/wamr/index.rst new file mode 100644 index 0000000000..44e0fc5ed3 --- /dev/null +++ b/Documentation/applications/interpreters/wamr/index.rst @@ -0,0 +1,3 @@ +================================== +``wamr`` Webassembly Micro Runtime +================================== diff --git a/Documentation/applications/interpreters/wasm3/index.rst b/Documentation/applications/interpreters/wasm3/index.rst new file mode 100644 index 0000000000..c07f0155b3 --- /dev/null +++ b/Documentation/applications/interpreters/wasm3/index.rst @@ -0,0 +1,3 @@ +=================================== +``wasm3`` WASM3 Webassembly Runtime +=================================== diff --git a/Documentation/applications/lte/alt1250/index.rst b/Documentation/applications/lte/alt1250/index.rst new file mode 100644 index 0000000000..3b79c697aa --- /dev/null +++ b/Documentation/applications/lte/alt1250/index.rst @@ -0,0 +1,3 @@ +================================== +``alt1250`` ALT1250 usrsock daemon +================================== diff --git a/Documentation/applications/lte/index.rst b/Documentation/applications/lte/index.rst index a631851648..59a8055963 100644 --- a/Documentation/applications/lte/index.rst +++ b/Documentation/applications/lte/index.rst @@ -2,5 +2,10 @@ LTE Libraries and NSH Add-Ons ============================= -- alt1250 - ALT1250 usrsock daemon -- lapi - LTE Configuration Library +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/lte/lapi/index.rst b/Documentation/applications/lte/lapi/index.rst new file mode 100644 index 0000000000..7a46d7bc72 --- /dev/null +++ b/Documentation/applications/lte/lapi/index.rst @@ -0,0 +1,3 @@ +================================== +``lapi`` LTE Configuration Library +================================== diff --git a/Documentation/applications/math/index.rst b/Documentation/applications/math/index.rst index 55e5bee67d..1cc465b2a0 100644 --- a/Documentation/applications/math/index.rst +++ b/Documentation/applications/math/index.rst @@ -2,4 +2,10 @@ Math Library Support ==================== -- libtommath - LibTomMath MPI Math Library +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/math/libtommath/index.rst b/Documentation/applications/math/libtommath/index.rst new file mode 100644 index 0000000000..3b5e8cb4e3 --- /dev/null +++ b/Documentation/applications/math/libtommath/index.rst @@ -0,0 +1,3 @@ +========================================== +``libtommath`` LibTomMath MPI Math Library +========================================== diff --git a/Documentation/applications/mlearing/cmsis/index.rst b/Documentation/applications/mlearing/cmsis/index.rst new file mode 100644 index 0000000000..a1a066b9eb --- /dev/null +++ b/Documentation/applications/mlearing/cmsis/index.rst @@ -0,0 +1,3 @@ +========================= +``cmsis`` CMSIS Libraries +========================= diff --git a/Documentation/applications/mlearing/darknet/index.rst b/Documentation/applications/mlearing/darknet/index.rst new file mode 100644 index 0000000000..d366659234 --- /dev/null +++ b/Documentation/applications/mlearing/darknet/index.rst @@ -0,0 +1,3 @@ +============================================ +``darknet`` YOLO: Real-Time Object Detection +============================================ diff --git a/Documentation/applications/mlearing/index.rst b/Documentation/applications/mlearing/index.rst index 9a0022467d..5186f123f9 100644 --- a/Documentation/applications/mlearing/index.rst +++ b/Documentation/applications/mlearing/index.rst @@ -2,6 +2,10 @@ Machine Learning Support ======================== -- cmsis - CMSIS Libraries -- darknet - YOLO: Real-Time Object Detection -- libnnablart - NNABLA Runtime Libraries +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/mlearing/libnnablart/index.rst b/Documentation/applications/mlearing/libnnablart/index.rst new file mode 100644 index 0000000000..4fc9249f4e --- /dev/null +++ b/Documentation/applications/mlearing/libnnablart/index.rst @@ -0,0 +1,3 @@ +======================================== +``libnnablart`` NNABLA Runtime Libraries +======================================== diff --git a/Documentation/applications/netutils/chat/index.rst b/Documentation/applications/netutils/chat/index.rst new file mode 100644 index 0000000000..4591e16c83 --- /dev/null +++ b/Documentation/applications/netutils/chat/index.rst @@ -0,0 +1,3 @@ +================== +``chat`` Chat tool +================== diff --git a/Documentation/applications/netutils/codecs/index.rst b/Documentation/applications/netutils/codecs/index.rst new file mode 100644 index 0000000000..0428904354 --- /dev/null +++ b/Documentation/applications/netutils/codecs/index.rst @@ -0,0 +1,4 @@ +======================================================== +``codecs`` CODEC Library: Base64 coding, URL coding, MD5 +======================================================== + diff --git a/Documentation/applications/netutils/cwebsocket/index.rst b/Documentation/applications/netutils/cwebsocket/index.rst new file mode 100644 index 0000000000..fba4154a7f --- /dev/null +++ b/Documentation/applications/netutils/cwebsocket/index.rst @@ -0,0 +1,3 @@ +======================================= +``cwebsocket`` WebSocket Client Library +======================================= diff --git a/Documentation/applications/netutils/dhcp6c/index.rst b/Documentation/applications/netutils/dhcp6c/index.rst new file mode 100644 index 0000000000..0f5a78816d --- /dev/null +++ b/Documentation/applications/netutils/dhcp6c/index.rst @@ -0,0 +1,3 @@ +======================== +``dhcp6c`` DHCPv6 client +======================== diff --git a/Documentation/applications/netutils/index.rst b/Documentation/applications/netutils/index.rst index 32bbdd39da..e5f3e03532 100644 --- a/Documentation/applications/netutils/index.rst +++ b/Documentation/applications/netutils/index.rst @@ -10,25 +10,6 @@ Network Utilities */index* - -- chat - Chat tool -- codecs - CODEC Library: Base64 coding, URL coding, MD5 -- cwebsocket - WebSocket Client Library -- dhcp6c - DHCPv6 client -- iptables - iptables libary -- libcurl4nx - cURL4nx HTTP client library -- mqttc - MQTT-C library -- netinit - Network initialization -- netlib - Network support library -- nng - Nanomsg NG -- pppd - PPP server -- ptpd - PTPD client/server -- rexec - Remote execution client -- rexecd - Remote Execution Server -- rtptools - RTP Tools -- wakaama - Eclipse Wakaama (formerly liblwm2m) - an implementation of LWM2M protocol. -- wakeonlan - WakeOnLAN support - uIP Applications ---------------- diff --git a/Documentation/applications/netutils/iptables/index.rst b/Documentation/applications/netutils/iptables/index.rst new file mode 100644 index 0000000000..45c88ae9da --- /dev/null +++ b/Documentation/applications/netutils/iptables/index.rst @@ -0,0 +1,3 @@ +============================ +``iptables`` iptables libary +============================ diff --git a/Documentation/applications/netutils/libcurl4nx/index.rst b/Documentation/applications/netutils/libcurl4nx/index.rst new file mode 100644 index 0000000000..54209f1f75 --- /dev/null +++ b/Documentation/applications/netutils/libcurl4nx/index.rst @@ -0,0 +1,3 @@ +========================================== +``libcurl4nx`` cURL4nx HTTP client library +========================================== diff --git a/Documentation/applications/netutils/mqttc/index.rst b/Documentation/applications/netutils/mqttc/index.rst new file mode 100644 index 0000000000..94f71ab13b --- /dev/null +++ b/Documentation/applications/netutils/mqttc/index.rst @@ -0,0 +1,3 @@ +======================== +``mqttc`` MQTT-C library +======================== diff --git a/Documentation/applications/netutils/netinit/index.rst b/Documentation/applications/netutils/netinit/index.rst new file mode 100644 index 0000000000..f07a5d7dac --- /dev/null +++ b/Documentation/applications/netutils/netinit/index.rst @@ -0,0 +1,3 @@ +================================== +``netinit`` Network initialization +================================== diff --git a/Documentation/applications/netutils/netlib/index.rst b/Documentation/applications/netutils/netlib/index.rst new file mode 100644 index 0000000000..6099b31da4 --- /dev/null +++ b/Documentation/applications/netutils/netlib/index.rst @@ -0,0 +1,3 @@ +================================== +``netlib`` Network support library +================================== diff --git a/Documentation/applications/netutils/nng/index.rst b/Documentation/applications/netutils/nng/index.rst new file mode 100644 index 0000000000..46ce1a1e91 --- /dev/null +++ b/Documentation/applications/netutils/nng/index.rst @@ -0,0 +1,3 @@ +================== +``nng`` Nanomsg NG +================== diff --git a/Documentation/applications/netutils/pppd/index.rst b/Documentation/applications/netutils/pppd/index.rst new file mode 100644 index 0000000000..2c173939d7 --- /dev/null +++ b/Documentation/applications/netutils/pppd/index.rst @@ -0,0 +1,3 @@ +=================== +``pppd`` PPP server +=================== diff --git a/Documentation/applications/netutils/ptpd/index.rst b/Documentation/applications/netutils/ptpd/index.rst new file mode 100644 index 0000000000..cbeebe0de0 --- /dev/null +++ b/Documentation/applications/netutils/ptpd/index.rst @@ -0,0 +1,3 @@ +=========================== +``ptpd`` PTPD client/server +=========================== diff --git a/Documentation/applications/netutils/rexec/index.rst b/Documentation/applications/netutils/rexec/index.rst new file mode 100644 index 0000000000..4f8792203c --- /dev/null +++ b/Documentation/applications/netutils/rexec/index.rst @@ -0,0 +1,3 @@ +================================= +``rexec`` Remote execution client +================================= diff --git a/Documentation/applications/netutils/rexecd/index.rst b/Documentation/applications/netutils/rexecd/index.rst new file mode 100644 index 0000000000..de6fb0e7f6 --- /dev/null +++ b/Documentation/applications/netutils/rexecd/index.rst @@ -0,0 +1,3 @@ +================================== +``rexecd`` Remote Execution Server +================================== diff --git a/Documentation/applications/netutils/rtptools/index.rst b/Documentation/applications/netutils/rtptools/index.rst new file mode 100644 index 0000000000..894a609256 --- /dev/null +++ b/Documentation/applications/netutils/rtptools/index.rst @@ -0,0 +1,3 @@ +====================== +``rtptools`` RTP Tools +====================== diff --git a/Documentation/applications/netutils/wakaama/index.rst b/Documentation/applications/netutils/wakaama/index.rst new file mode 100644 index 0000000000..f625ea04cf --- /dev/null +++ b/Documentation/applications/netutils/wakaama/index.rst @@ -0,0 +1,3 @@ +================================================================ +``wakaama`` Eclipse Wakaama (formerly liblwm2m) - LWM2M protocol +================================================================ diff --git a/Documentation/applications/netutils/wakeonlan/index.rst b/Documentation/applications/netutils/wakeonlan/index.rst new file mode 100644 index 0000000000..bd60bea0fc --- /dev/null +++ b/Documentation/applications/netutils/wakeonlan/index.rst @@ -0,0 +1,3 @@ +=============================== +``wakeonlan`` WakeOnLAN support +=============================== diff --git a/Documentation/applications/sdr/index.rst b/Documentation/applications/sdr/index.rst index e146c4f3c9..68f860b534 100644 --- a/Documentation/applications/sdr/index.rst +++ b/Documentation/applications/sdr/index.rst @@ -2,4 +2,10 @@ Software Define Radio Libraries =============================== -- liquid_dsp - Liquid DSP Library +.. toctree:: + :glob: + :maxdepth: 1 + :titlesonly: + :caption: Contents + + */index* diff --git a/Documentation/applications/sdr/liquid_dsp/index.rst b/Documentation/applications/sdr/liquid_dsp/index.rst new file mode 100644 index 0000000000..ffc385f1f7 --- /dev/null +++ b/Documentation/applications/sdr/liquid_dsp/index.rst @@ -0,0 +1,3 @@ +================================= +``liquid_dsp`` Liquid DSP Library +================================= diff --git a/Documentation/applications/system/adb/index.rst b/Documentation/applications/system/adb/index.rst new file mode 100644 index 0000000000..3115339aee --- /dev/null +++ b/Documentation/applications/system/adb/index.rst @@ -0,0 +1,3 @@ +============================== +``adb`` ADB daemon application +============================== diff --git a/Documentation/applications/system/argtable3/index.rst b/Documentation/applications/system/argtable3/index.rst new file mode 100644 index 0000000000..afd1950739 --- /dev/null +++ b/Documentation/applications/system/argtable3/index.rst @@ -0,0 +1,3 @@ +=============================== +``argtable3`` ARGTABLE3 library +=============================== diff --git a/Documentation/applications/system/cachespeed/index.rst b/Documentation/applications/system/cachespeed/index.rst new file mode 100644 index 0000000000..ccc84f0ba7 --- /dev/null +++ b/Documentation/applications/system/cachespeed/index.rst @@ -0,0 +1,3 @@ +=============================== +``cachespeed`` CACHE Speed Test +=============================== diff --git a/Documentation/applications/system/cle/index.rst b/Documentation/applications/system/cle/index.rst new file mode 100644 index 0000000000..0ecec5a4b1 --- /dev/null +++ b/Documentation/applications/system/cle/index.rst @@ -0,0 +1,3 @@ +====================================== +``cle`` EMACS-like Command Line Editor +====================================== diff --git a/Documentation/applications/system/coredump/index.rst b/Documentation/applications/system/coredump/index.rst new file mode 100644 index 0000000000..9c9fed0b9f --- /dev/null +++ b/Documentation/applications/system/coredump/index.rst @@ -0,0 +1,3 @@ +================================================ +``coredump`` Coredump tool capture system status +================================================ diff --git a/Documentation/applications/system/crimon/index.rst b/Documentation/applications/system/crimon/index.rst new file mode 100644 index 0000000000..6392a9a3e7 --- /dev/null +++ b/Documentation/applications/system/crimon/index.rst @@ -0,0 +1,3 @@ +=================================== +``critmon`` Critcal Section Monitor +=================================== diff --git a/Documentation/applications/system/cu/index.rst b/Documentation/applications/system/cu/index.rst new file mode 100644 index 0000000000..e171336e8c --- /dev/null +++ b/Documentation/applications/system/cu/index.rst @@ -0,0 +1,3 @@ +================================= +``cu`` CU minimal serial terminal +================================= diff --git a/Documentation/applications/system/dd/index.rst b/Documentation/applications/system/dd/index.rst new file mode 100644 index 0000000000..f70217e98b --- /dev/null +++ b/Documentation/applications/system/dd/index.rst @@ -0,0 +1,3 @@ +========================== +``dd`` system 'dd' command +========================== diff --git a/Documentation/applications/system/dhcp6c/index.rst b/Documentation/applications/system/dhcp6c/index.rst new file mode 100644 index 0000000000..a64f00ec6b --- /dev/null +++ b/Documentation/applications/system/dhcp6c/index.rst @@ -0,0 +1,3 @@ +==================================== +``dhcp6c`` DHCP IPv6 Address Renewal +==================================== diff --git a/Documentation/applications/system/dhcpc/index.rst b/Documentation/applications/system/dhcpc/index.rst new file mode 100644 index 0000000000..d49619ed8f --- /dev/null +++ b/Documentation/applications/system/dhcpc/index.rst @@ -0,0 +1,3 @@ +============================== +``dhcpc`` DHCP Address Renewal +============================== diff --git a/Documentation/applications/system/dumpstack/index.rst b/Documentation/applications/system/dumpstack/index.rst new file mode 100644 index 0000000000..0d83df3f41 --- /dev/null +++ b/Documentation/applications/system/dumpstack/index.rst @@ -0,0 +1,3 @@ +======================================================== +``dumpstack`` dumpstack tool for show the task backtrace +======================================================== diff --git a/Documentation/applications/system/fastboot/index.rst b/Documentation/applications/system/fastboot/index.rst new file mode 100644 index 0000000000..6e9eb7b6a6 --- /dev/null +++ b/Documentation/applications/system/fastboot/index.rst @@ -0,0 +1,3 @@ +====================== +``fastboot`` fastbootd +====================== diff --git a/Documentation/applications/system/fdt/index.rst b/Documentation/applications/system/fdt/index.rst new file mode 100644 index 0000000000..9417ab7e35 --- /dev/null +++ b/Documentation/applications/system/fdt/index.rst @@ -0,0 +1,3 @@ +========================= +``fdt`` fdt utility tools +========================= diff --git a/Documentation/applications/system/gcov/index.rst b/Documentation/applications/system/gcov/index.rst new file mode 100644 index 0000000000..4bae9d5950 --- /dev/null +++ b/Documentation/applications/system/gcov/index.rst @@ -0,0 +1,3 @@ +================== +``gcov`` gcov tool +================== diff --git a/Documentation/applications/system/gdbstub/index.rst b/Documentation/applications/system/gdbstub/index.rst new file mode 100644 index 0000000000..fa1ad2e219 --- /dev/null +++ b/Documentation/applications/system/gdbstub/index.rst @@ -0,0 +1,3 @@ +=================== +``gdbstub`` GDBSTUB +=================== diff --git a/Documentation/applications/system/hex2bin/index.rst b/Documentation/applications/system/hex2bin/index.rst new file mode 100644 index 0000000000..a0ba4841fb --- /dev/null +++ b/Documentation/applications/system/hex2bin/index.rst @@ -0,0 +1,3 @@ +========================================== +``hex2bin`` Intel HEX to binary conversion +========================================== diff --git a/Documentation/applications/system/hexed/index.rst b/Documentation/applications/system/hexed/index.rst new file mode 100644 index 0000000000..bd632be887 --- /dev/null +++ b/Documentation/applications/system/hexed/index.rst @@ -0,0 +1,3 @@ +==================== +``hexed`` Hex editor +==================== diff --git a/Documentation/applications/system/hostname/index.rst b/Documentation/applications/system/hostname/index.rst new file mode 100644 index 0000000000..7b9d335be8 --- /dev/null +++ b/Documentation/applications/system/hostname/index.rst @@ -0,0 +1,3 @@ +=============================== +``hostname`` "hostname" command +=============================== diff --git a/Documentation/applications/system/index.rst b/Documentation/applications/system/index.rst index 919ede8d9f..1a1d55020d 100644 --- a/Documentation/applications/system/index.rst +++ b/Documentation/applications/system/index.rst @@ -9,55 +9,3 @@ System Libraries and NSH Add-Ons :caption: Contents */index* - -- adb - ADB daemon application -- argtable3 - ARGTABLE3 library -- cachespeed - CACHE Speed Test -- cle - EMACS-like Command Line Editor -- coredump - Coredump tool capture system status -- critmon - Critcal Section Monitor -- cu - CU minimal serial terminal -- dd - system 'dd' command -- dhcp6c - DHCP IPv6 Address Renewal -- dhcpc - DHCP Address Renewal -- dumpstack - dumpstack tool for show the task backtrace -- fastboot - fastbootd -- fdt - fdt utility tools -- gcov - gcov tool -- gdbstub - GDBSTUB -- hexed - Hex editor -- hex2bin - Intel HEX to binary conversion -- hostname - 'hostname' command -- input - input tool -- iptables - 'iptables' command -- lm75 - LM75 Temperature -- lzf - LZF compression tool -- mdio - PHY MDIO tool -- memstress - memory stress test -- netdb - netdb interface -- ntpc - NTP Daemon Commands -- nxcamera - NxCamera video test application -- nxlooper - NxLooper audio test application -- nxrecorder - NxRecorder pcm raw data Recorder -- ping - ICMP 'ping' command -- ping6 - ICMPv6 'ping6' command -- popen - popen()/pclose() Functions -- ptpd - PTP daemon commands -- ramspeed - RAM Speed Test -- ramtest - RAM Test -- readline - readline() Support -- sched_note - Scheduler monitor -- setlogmask - 'setlogmask' command -- stackmonitor - Stack Monitor -- system - System Command -- taskset - Taskset Command -- tcpdump - tcpdump command -- tee - Tee Command -- telnet - Telnet chat daemon -- telnetd - Telnet daemon application -- ubloxmodem - u-blox modem configuration tool -- uniqueid - 'uniqueid' command -- uorb - uorb(micro object request broker) -- vi - VI Work-Alike Text Editor -- ofloader - Open flash loader -- zlib - zlib data compression library diff --git a/Documentation/applications/system/input/index.rst b/Documentation/applications/system/input/index.rst new file mode 100644 index 0000000000..84d90714ba --- /dev/null +++ b/Documentation/applications/system/input/index.rst @@ -0,0 +1,3 @@ +==================== +``input`` input tool +==================== diff --git a/Documentation/applications/system/iptables/index.rst b/Documentation/applications/system/iptables/index.rst new file mode 100644 index 0000000000..248bde7227 --- /dev/null +++ b/Documentation/applications/system/iptables/index.rst @@ -0,0 +1,3 @@ +=============================== +``iptables`` "iptables" command +=============================== diff --git a/Documentation/applications/system/lm75/index.rst b/Documentation/applications/system/lm75/index.rst new file mode 100644 index 0000000000..62bae02818 --- /dev/null +++ b/Documentation/applications/system/lm75/index.rst @@ -0,0 +1,3 @@ +========================= +``lm75`` LM75 Temperature +========================= diff --git a/Documentation/applications/system/lzf/index.rst b/Documentation/applications/system/lzf/index.rst new file mode 100644 index 0000000000..4fe8c761d3 --- /dev/null +++ b/Documentation/applications/system/lzf/index.rst @@ -0,0 +1,3 @@ +============================ +``lzf`` LZF compression tool +============================ diff --git a/Documentation/applications/system/mdio/index.rst b/Documentation/applications/system/mdio/index.rst new file mode 100644 index 0000000000..eebc17a1c1 --- /dev/null +++ b/Documentation/applications/system/mdio/index.rst @@ -0,0 +1,3 @@ +====================== +``mdio`` PHY MDIO tool +====================== diff --git a/Documentation/applications/system/memstress/index.rst b/Documentation/applications/system/memstress/index.rst new file mode 100644 index 0000000000..338761bb83 --- /dev/null +++ b/Documentation/applications/system/memstress/index.rst @@ -0,0 +1,3 @@ +================================ +``memstress`` memory stress test +================================ diff --git a/Documentation/applications/system/netdb/index.rst b/Documentation/applications/system/netdb/index.rst new file mode 100644 index 0000000000..005f8fd0f6 --- /dev/null +++ b/Documentation/applications/system/netdb/index.rst @@ -0,0 +1,3 @@ +========================= +``netdb`` netdb interface +========================= diff --git a/Documentation/applications/system/ntpc/index.rst b/Documentation/applications/system/ntpc/index.rst new file mode 100644 index 0000000000..fc1d9d0cd8 --- /dev/null +++ b/Documentation/applications/system/ntpc/index.rst @@ -0,0 +1,3 @@ +============================ +``ntpc`` NTP Daemon Commands +============================ diff --git a/Documentation/applications/system/nxcamera/index.rst b/Documentation/applications/system/nxcamera/index.rst new file mode 100644 index 0000000000..a9b3987251 --- /dev/null +++ b/Documentation/applications/system/nxcamera/index.rst @@ -0,0 +1,3 @@ +============================================ +``nxcamera`` NxCamera video test application +============================================ diff --git a/Documentation/applications/system/nxlooper/index.rst b/Documentation/applications/system/nxlooper/index.rst new file mode 100644 index 0000000000..23303dac12 --- /dev/null +++ b/Documentation/applications/system/nxlooper/index.rst @@ -0,0 +1,3 @@ +============================================ +``nxlooper`` NxLooper audio test application +============================================ diff --git a/Documentation/applications/system/nxrecorder/index.rst b/Documentation/applications/system/nxrecorder/index.rst new file mode 100644 index 0000000000..e119185105 --- /dev/null +++ b/Documentation/applications/system/nxrecorder/index.rst @@ -0,0 +1,3 @@ +=============================================== +``nxrecorder`` NxRecorder pcm raw data Recorder +=============================================== diff --git a/Documentation/applications/system/ofloader/index.rst b/Documentation/applications/system/ofloader/index.rst new file mode 100644 index 0000000000..558bef7b98 --- /dev/null +++ b/Documentation/applications/system/ofloader/index.rst @@ -0,0 +1,3 @@ +============================== +``ofloader`` Open flash loader +============================== diff --git a/Documentation/applications/system/ping/index.rst b/Documentation/applications/system/ping/index.rst new file mode 100644 index 0000000000..01571ad65d --- /dev/null +++ b/Documentation/applications/system/ping/index.rst @@ -0,0 +1,3 @@ +============================ +``ping`` ICMP "ping" command +============================ diff --git a/Documentation/applications/system/ping6/index.rst b/Documentation/applications/system/ping6/index.rst new file mode 100644 index 0000000000..304ccc146d --- /dev/null +++ b/Documentation/applications/system/ping6/index.rst @@ -0,0 +1,3 @@ +================================ +``ping6`` ICMPv6 "ping6" command +================================ diff --git a/Documentation/applications/system/popen/index.rst b/Documentation/applications/system/popen/index.rst new file mode 100644 index 0000000000..7a97adce80 --- /dev/null +++ b/Documentation/applications/system/popen/index.rst @@ -0,0 +1,3 @@ +==================================== +``popen`` popen()/pclose() Functions +==================================== diff --git a/Documentation/applications/system/ptpd/index.rst b/Documentation/applications/system/ptpd/index.rst new file mode 100644 index 0000000000..e431980ef6 --- /dev/null +++ b/Documentation/applications/system/ptpd/index.rst @@ -0,0 +1,3 @@ +============================ +``ptpd`` PTP daemon commands +============================ diff --git a/Documentation/applications/system/ramspeed/index.rst b/Documentation/applications/system/ramspeed/index.rst new file mode 100644 index 0000000000..bffcd99848 --- /dev/null +++ b/Documentation/applications/system/ramspeed/index.rst @@ -0,0 +1,3 @@ +=========================== +``ramspeed`` RAM Speed Test +=========================== diff --git a/Documentation/applications/system/ramtest/index.rst b/Documentation/applications/system/ramtest/index.rst new file mode 100644 index 0000000000..8ba98d77b3 --- /dev/null +++ b/Documentation/applications/system/ramtest/index.rst @@ -0,0 +1,3 @@ +==================== +``ramtest`` RAM Test +==================== diff --git a/Documentation/applications/system/readline/index.rst b/Documentation/applications/system/readline/index.rst new file mode 100644 index 0000000000..eae18136cc --- /dev/null +++ b/Documentation/applications/system/readline/index.rst @@ -0,0 +1,3 @@ +=============================== +``readline`` readline() Support +=============================== diff --git a/Documentation/applications/system/sched_note/index.rst b/Documentation/applications/system/sched_note/index.rst new file mode 100644 index 0000000000..1153e94a8c --- /dev/null +++ b/Documentation/applications/system/sched_note/index.rst @@ -0,0 +1,3 @@ +================================ +``sched_note`` Scheduler monitor +================================ diff --git a/Documentation/applications/system/setlogmask/index.rst b/Documentation/applications/system/setlogmask/index.rst new file mode 100644 index 0000000000..3308be9f40 --- /dev/null +++ b/Documentation/applications/system/setlogmask/index.rst @@ -0,0 +1,3 @@ +=================================== +``setlogmask`` "setlogmask" command +=================================== diff --git a/Documentation/applications/system/stackmonitor/index.rst b/Documentation/applications/system/stackmonitor/index.rst new file mode 100644 index 0000000000..2a94a4b1ef --- /dev/null +++ b/Documentation/applications/system/stackmonitor/index.rst @@ -0,0 +1,3 @@ +============================== +``stackmonitor`` Stack Monitor +============================== diff --git a/Documentation/applications/system/system/index.rst b/Documentation/applications/system/system/index.rst new file mode 100644 index 0000000000..c86d9f81ce --- /dev/null +++ b/Documentation/applications/system/system/index.rst @@ -0,0 +1,3 @@ +========================= +``system`` System Command +========================= diff --git a/Documentation/applications/system/taskset/index.rst b/Documentation/applications/system/taskset/index.rst new file mode 100644 index 0000000000..1859bc60a9 --- /dev/null +++ b/Documentation/applications/system/taskset/index.rst @@ -0,0 +1,3 @@ +=========================== +``taskset`` Taskset Command +=========================== diff --git a/Documentation/applications/system/tcpdump/index.rst b/Documentation/applications/system/tcpdump/index.rst new file mode 100644 index 0000000000..c83214a2e9 --- /dev/null +++ b/Documentation/applications/system/tcpdump/index.rst @@ -0,0 +1,3 @@ +=========================== +``tcpdump`` tcpdump command +=========================== diff --git a/Documentation/applications/system/tee/index.rst b/Documentation/applications/system/tee/index.rst new file mode 100644 index 0000000000..6c8b55ce65 --- /dev/null +++ b/Documentation/applications/system/tee/index.rst @@ -0,0 +1,3 @@ +=================== +``tee`` Tee Command +=================== diff --git a/Documentation/applications/system/telnet/index.rst b/Documentation/applications/system/telnet/index.rst new file mode 100644 index 0000000000..9d31785f20 --- /dev/null +++ b/Documentation/applications/system/telnet/index.rst @@ -0,0 +1,3 @@ +============================= +``telnet`` Telnet chat daemon +============================= diff --git a/Documentation/applications/system/telnetd/index.rst b/Documentation/applications/system/telnetd/index.rst new file mode 100644 index 0000000000..8fde031844 --- /dev/null +++ b/Documentation/applications/system/telnetd/index.rst @@ -0,0 +1,3 @@ +===================================== +``telnetd`` Telnet daemon application +===================================== diff --git a/Documentation/applications/system/ubloxmodem/index.rst b/Documentation/applications/system/ubloxmodem/index.rst new file mode 100644 index 0000000000..45dba955b0 --- /dev/null +++ b/Documentation/applications/system/ubloxmodem/index.rst @@ -0,0 +1,3 @@ +============================================== +``ubloxmodem`` u-blox modem configuration tool +============================================== diff --git a/Documentation/applications/system/uniqueid/index.rst b/Documentation/applications/system/uniqueid/index.rst new file mode 100644 index 0000000000..b3b204f59a --- /dev/null +++ b/Documentation/applications/system/uniqueid/index.rst @@ -0,0 +1,3 @@ +=============================== +``uniqueid`` "uniqueid" command +=============================== diff --git a/Documentation/applications/system/uorb/index.rst b/Documentation/applications/system/uorb/index.rst new file mode 100644 index 0000000000..217d6834c1 --- /dev/null +++ b/Documentation/applications/system/uorb/index.rst @@ -0,0 +1,3 @@ +========================================== +``uorb`` uorb(micro object request broker) +========================================== diff --git a/Documentation/applications/system/vi/index.rst b/Documentation/applications/system/vi/index.rst new file mode 100644 index 0000000000..ea1f99c5d1 --- /dev/null +++ b/Documentation/applications/system/vi/index.rst @@ -0,0 +1,3 @@ +================================ +``vi`` VI Work-Alike Text Editor +================================ diff --git a/Documentation/applications/system/zlib/index.rst b/Documentation/applications/system/zlib/index.rst new file mode 100644 index 0000000000..1546baaf6f --- /dev/null +++ b/Documentation/applications/system/zlib/index.rst @@ -0,0 +1,3 @@ +====================================== +``zlib`` zlib data compression library +====================================== diff --git a/Documentation/applications/testing/atomic/index.rst b/Documentation/applications/testing/atomic/index.rst new file mode 100644 index 0000000000..24302e46da --- /dev/null +++ b/Documentation/applications/testing/atomic/index.rst @@ -0,0 +1,3 @@ +================================ +``atomic`` "Test atomic" testing +================================ diff --git a/Documentation/applications/testing/batterydump/index.rst b/Documentation/applications/testing/batterydump/index.rst new file mode 100644 index 0000000000..613ea5abb4 --- /dev/null +++ b/Documentation/applications/testing/batterydump/index.rst @@ -0,0 +1,3 @@ +===================================== +``batterydump`` Battery dump for test +===================================== diff --git a/Documentation/applications/testing/cmocka/index.rst b/Documentation/applications/testing/cmocka/index.rst new file mode 100644 index 0000000000..8e4910bc3b --- /dev/null +++ b/Documentation/applications/testing/cmocka/index.rst @@ -0,0 +1,3 @@ +==================== +``cmocka`` libcmocka +==================== diff --git a/Documentation/applications/testing/cpuload/index.rst b/Documentation/applications/testing/cpuload/index.rst new file mode 100644 index 0000000000..91c825c9d6 --- /dev/null +++ b/Documentation/applications/testing/cpuload/index.rst @@ -0,0 +1,3 @@ +======================== +``cpuload`` cpuload test +======================== diff --git a/Documentation/applications/testing/crypto/index.rst b/Documentation/applications/testing/crypto/index.rst new file mode 100644 index 0000000000..446a004f77 --- /dev/null +++ b/Documentation/applications/testing/crypto/index.rst @@ -0,0 +1,3 @@ +====================== +``crypto`` crypto test +====================== diff --git a/Documentation/applications/testing/drivertest/index.rst b/Documentation/applications/testing/drivertest/index.rst new file mode 100644 index 0000000000..a12603f3fe --- /dev/null +++ b/Documentation/applications/testing/drivertest/index.rst @@ -0,0 +1,3 @@ +====================================== +``drivertest`` vela cmocka driver test +====================================== diff --git a/Documentation/applications/testing/fatutf8/index.rst b/Documentation/applications/testing/fatutf8/index.rst new file mode 100644 index 0000000000..fd91ac75d2 --- /dev/null +++ b/Documentation/applications/testing/fatutf8/index.rst @@ -0,0 +1,3 @@ +========================= +``fatutf8`` FAT UTF8 test +========================= diff --git a/Documentation/applications/testing/fdsantest/index.rst b/Documentation/applications/testing/fdsantest/index.rst new file mode 100644 index 0000000000..d6b7505e55 --- /dev/null +++ b/Documentation/applications/testing/fdsantest/index.rst @@ -0,0 +1,3 @@ +==================================== +``fdsantest`` vela cmocka fdsan test +==================================== diff --git a/Documentation/applications/testing/getprime/index.rst b/Documentation/applications/testing/getprime/index.rst new file mode 100644 index 0000000000..193f217bee --- /dev/null +++ b/Documentation/applications/testing/getprime/index.rst @@ -0,0 +1,3 @@ +============================= +``getprime`` getprime example +============================= diff --git a/Documentation/applications/testing/index.rst b/Documentation/applications/testing/index.rst index 6378d13427..90dda90635 100644 --- a/Documentation/applications/testing/index.rst +++ b/Documentation/applications/testing/index.rst @@ -18,27 +18,3 @@ with little value as usage examples. :caption: Contents */index* - -- atomic - "Test atomic" testing -- batterydump - Battery dump for test -- cmocka - libcmocka -- cpuload - cpuload test -- crypto - crypto test -- drivertest - vela cmocka driver test -- fatutf8 - FAT UTF8 test -- fdsantest - vela cmocka fdsan test -- fmemopen - fmemopen() test -- fopencookie - fopencookie() test -- getprime - getprime example -- iozone - IOzone, filesystem benchmark tool -- irtest - IR driver test -- ltp - Linux Test Project -- memtester - utils_memtester -- monkey - Monkey test -- nist-sts - NIST Statistical Test Suite -- osperf - System performance profiling -- scanftest - sscanf() test -- sensortest - Sensor driver test -- setest - Secure Element driver test -- superpi - SuperPI test -- uclibcxx_test - uclibcxx test diff --git a/Documentation/applications/testing/iozone/index.rst b/Documentation/applications/testing/iozone/index.rst new file mode 100644 index 0000000000..c735c21fdc --- /dev/null +++ b/Documentation/applications/testing/iozone/index.rst @@ -0,0 +1,3 @@ +============================================ +``iozone`` IOzone, filesystem benchmark tool +============================================ diff --git a/Documentation/applications/testing/irtest/index.rst b/Documentation/applications/testing/irtest/index.rst new file mode 100644 index 0000000000..a3aa5ad3e9 --- /dev/null +++ b/Documentation/applications/testing/irtest/index.rst @@ -0,0 +1,3 @@ +========================= +``irtest`` IR driver test +========================= diff --git a/Documentation/applications/testing/lpt/index.rst b/Documentation/applications/testing/lpt/index.rst new file mode 100644 index 0000000000..835723528f --- /dev/null +++ b/Documentation/applications/testing/lpt/index.rst @@ -0,0 +1,3 @@ +========================== +``ltp`` Linux Test Project +========================== diff --git a/Documentation/applications/testing/memtester/index.rst b/Documentation/applications/testing/memtester/index.rst new file mode 100644 index 0000000000..fd6b91fbd7 --- /dev/null +++ b/Documentation/applications/testing/memtester/index.rst @@ -0,0 +1,3 @@ +============================= +``memtester`` utils_memtester +============================= diff --git a/Documentation/applications/testing/monkey/index.rst b/Documentation/applications/testing/monkey/index.rst new file mode 100644 index 0000000000..f49368be3b --- /dev/null +++ b/Documentation/applications/testing/monkey/index.rst @@ -0,0 +1,3 @@ +====================== +``monkey`` Monkey test +====================== diff --git a/Documentation/applications/testing/nist-sts/index.rst b/Documentation/applications/testing/nist-sts/index.rst new file mode 100644 index 0000000000..06d70cf5e4 --- /dev/null +++ b/Documentation/applications/testing/nist-sts/index.rst @@ -0,0 +1,3 @@ +======================================== +``nist-sts`` NIST Statistical Test Suite +======================================== diff --git a/Documentation/applications/testing/osperf/index.rst b/Documentation/applications/testing/osperf/index.rst new file mode 100644 index 0000000000..80f7d27690 --- /dev/null +++ b/Documentation/applications/testing/osperf/index.rst @@ -0,0 +1,3 @@ +======================================= +``osperf`` System performance profiling +======================================= diff --git a/Documentation/applications/testing/scanftest/index.rst b/Documentation/applications/testing/scanftest/index.rst new file mode 100644 index 0000000000..47bbaa5be0 --- /dev/null +++ b/Documentation/applications/testing/scanftest/index.rst @@ -0,0 +1,3 @@ +=========================== +``scanftest`` sscanf() test +=========================== diff --git a/Documentation/applications/testing/sensortest/index.rst b/Documentation/applications/testing/sensortest/index.rst new file mode 100644 index 0000000000..eae107f176 --- /dev/null +++ b/Documentation/applications/testing/sensortest/index.rst @@ -0,0 +1,3 @@ +================================= +``sensortest`` Sensor driver test +================================= diff --git a/Documentation/applications/testing/setest/index.rst b/Documentation/applications/testing/setest/index.rst new file mode 100644 index 0000000000..ac01130824 --- /dev/null +++ b/Documentation/applications/testing/setest/index.rst @@ -0,0 +1,3 @@ +===================================== +``setest`` Secure Element driver test +===================================== diff --git a/Documentation/applications/testing/superpi/index.rst b/Documentation/applications/testing/superpi/index.rst new file mode 100644 index 0000000000..49aa21ea1e --- /dev/null +++ b/Documentation/applications/testing/superpi/index.rst @@ -0,0 +1,3 @@ +======================== +``superpi`` SuperPI test +======================== diff --git a/Documentation/applications/testing/uclibcxx_test/index.rst b/Documentation/applications/testing/uclibcxx_test/index.rst new file mode 100644 index 0000000000..94e35aeb42 --- /dev/null +++ b/Documentation/applications/testing/uclibcxx_test/index.rst @@ -0,0 +1,3 @@ +=============================== +``uclibcxx_test`` uclibcxx test +=============================== diff --git a/Documentation/applications/tools/index.rst b/Documentation/applications/tools/index.rst index 1504ed7be7..7b7329d262 100644 --- a/Documentation/applications/tools/index.rst +++ b/Documentation/applications/tools/index.rst @@ -2,7 +2,7 @@ Host Side Tools =============== -NxWidgets ``bitmap_converter.py`` +``bitmap_converter.py`` NxWidgets --------------------------------- This script converts from any image type supported by Python imaging library to diff --git a/Documentation/applications/wireless/gs2200m/index.rst b/Documentation/applications/wireless/gs2200m/index.rst new file mode 100644 index 0000000000..1705a9bba1 --- /dev/null +++ b/Documentation/applications/wireless/gs2200m/index.rst @@ -0,0 +1,3 @@ +======================================== +``gs2200m`` Telit GS2200M usrsock daemon +======================================== diff --git a/Documentation/applications/wireless/i8shark/index.rst b/Documentation/applications/wireless/i8shark/index.rst new file mode 100644 index 0000000000..8eb7e43d37 --- /dev/null +++ b/Documentation/applications/wireless/i8shark/index.rst @@ -0,0 +1,3 @@ +=========================================== +``i8shark`` IEEE 802.15.4 Wireshark adapter +=========================================== diff --git a/Documentation/applications/wireless/index.rst b/Documentation/applications/wireless/index.rst index 2e41494f10..a1960b353b 100644 --- a/Documentation/applications/wireless/index.rst +++ b/Documentation/applications/wireless/index.rst @@ -9,8 +9,3 @@ Wireless Libraries and NSH Add-Ons :caption: Contents */index* - -- gs2200m - Telit GS2200M usrsock daemon -- i8shark - IEEE 802.15.4 Wireshark adapter -- libmac - IEEE 802.15.4 MAC library routines -- ipwan - IEEE 802.15.4 Command Line Tool diff --git a/Documentation/applications/wireless/ipwan/index.rst b/Documentation/applications/wireless/ipwan/index.rst new file mode 100644 index 0000000000..99b300f21b --- /dev/null +++ b/Documentation/applications/wireless/ipwan/index.rst @@ -0,0 +1,3 @@ +========================================= +``ipwan`` IEEE 802.15.4 Command Line Tool +========================================= diff --git a/Documentation/applications/wireless/libmac/index.rst b/Documentation/applications/wireless/libmac/index.rst new file mode 100644 index 0000000000..f752472cb2 --- /dev/null +++ b/Documentation/applications/wireless/libmac/index.rst @@ -0,0 +1,3 @@ +============================================= +``libmac`` IEEE 802.15.4 MAC library routines +=============================================