Commit graph

32 commits

Author SHA1 Message Date
Felipe Moura
4662ac5edf docs/applications/smf: added state machine framework example documentation
Update Doc - WIP

SFM doc updated - WIP

Finished first documentation release

Update documentation after source code changes

Signed-off-by: Felipe Moura <moura.fmo@gmail.com>
2026-01-05 09:47:23 +08:00
dongjiuzhu1
e1991fd14b Documentaion/ptp: add documentaion about system ptpd
add introduction about ptpd

Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-12-30 10:22:09 -03:00
wangchen
302731ad1a docs: add ICMP ping guide (usage, options, examples)
Add index.rst: ping usage, flags (-c -i -W -s -I), output, examples, errors.

Signed-off-by: wangchen <wangchen41@xiaomi.com>
2025-12-29 22:41:40 +08:00
chenxiaoyi
43405d34c4 Documentation: update the gprof usage
Update the usage part to demostrate two easily accessible environments,
one QEMU and one real board.

Signed-off-by: chenxiaoyi <chenxiaoyi@xiaomi.com>
2025-12-13 13:31:46 +08:00
Filipe Cavalcanti
484a8d1534 documentation: add documentation for NTP Daemon
Add documentation explaining usage of NTP Daemon system tool.

Signed-off-by: Filipe Cavalcanti <filipe.cavalcanti@espressif.com>
2025-09-05 23:47:44 +02:00
Windsor Schmidt
6bbc8c701a documentation: spelling and grammar fixes 2025-07-24 14:44:02 +08:00
Matteo Golin
3b6648c742 docs/syslogd: Update syslogd docs to reflect implementation
The documentation for `syslogd` is now updated to reflect its use of
`posix_spawn` to run the daemon in the background.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-06-18 01:34:22 +08:00
Matteo Golin
a5f43aa8e8 docs/syslog: Add documentation for RFC 5424 support
Introduces two documentation additions. First, the RFC 5424 support is
documented on the main syslog documentation page, with information about
how to use it effectively. Second is the application documentation for
the `syslogd` application addition, which enables easy use of the new
RFC 5424 support.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-06-13 20:26:57 +08:00
Lars Kruse
ccc974b224 WIP: Documentation: replace first person perspectives
Documentation containing first person perspective phrasing may be
understood as belonging to a single person project (instead of a
community project).
2025-05-19 20:21:33 +08:00
Lars Kruse
b333ad3ab5 style: fix typos
Thanks, codespell!
2025-04-30 13:45:46 +08:00
chao an
f8fa86fca3 Documentation/uorb: fix typo in uorb chapter
fix typo "Two Tpyes" -> "Two Types"

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-03-12 10:35:32 -03:00
wangjianyu3
677c2187b9 Documentation/fastboot: Add usage for fastboot oem shell
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2025-03-04 12:28:12 +08:00
wangmingrong1
cd9f2d7099 Docu/gcov: Modify the description and fix the script error
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2025-01-22 21:41:06 +08:00
chao an
e1285d73fa Documentation: Replace NSH_LINELEN with LINE_MAX
forget in:
commit 38a0049f56
Author: Xiang Xiao <xiaoxiang@xiaomi.com>
Date:   Sun Jan 19 11:59:01 2025 +0800

    Documentation: Replace NSH_LINELEN with LINE_MAX

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-01-20 16:44:55 +08:00
Xiang Xiao
38a0049f56 Documentation: Replace NSH_LINELEN with LINE_MAX
forget in:
commit 71a37b4f2d
Author: chao an <anchao.archer@bytedance.com>
Date:   Wed Jan 15 09:56:44 2025 +0800

    Documentation: clean up of CONFIG_NSH_LINELEN define

    Signed-off-by: chao an <anchao.archer@bytedance.com>

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2025-01-19 18:38:46 +08:00
dongjiuzhu1
500b55c330 Documentation: update uorb and sensor driver doc
Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-01-15 08:57:57 +01:00
Eren Terzioglu
5e2fc181c2 tools/Unix.mk: Add host_info target to print nxdiag output
Nxdiag examples scripts  modified to print system information
without building and flashing nxdiag application to get report
about system without reflash or reconfigure.
2025-01-07 01:03:44 +08:00
wangmingrong1
eff13d6004 gcov: Add usage documentation
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2024-11-26 16:32:50 +08:00
yinshengkai
b8670e905a docs: add gprof usage documentation
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>

g 请为您的变更输入提交说明。以 '#' 开始的行将被忽略,而一个空的提交
2024-10-10 18:46:51 +08:00
JianyuWang
a2dd0638b3 Documentation: Add guide for fastboot
See https://github.com/apache/nuttx-apps/pull/2562

Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2024-09-12 01:35:52 +08:00
Huang Qi
9d5b9b7c05 Documentation: Add usage guide for the debugpoint command
See https://github.com/apache/nuttx-apps/pull/2549

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2024-09-08 21:43:47 +08:00
Alan C. Assis
a409c42d13 Doc: Fix broken SPI Tool documentation 2024-08-15 13:36:50 +08:00
shizhenghui
f2b1c649eb nxcodec: add .rst documentation
Signed-off-by: shizhenghui <shizhenghui@xiaomi.com>
2024-07-09 10:46:17 -03:00
Alan Carvalho de Assis
468e9fcde5 Documentation: Fix typos
I used codespell to find typos in the documentation.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2023-10-29 10:35:51 +08:00
crafcat7
3d78859737 applications:Move the test tools in the system directory to the testing directory.
by pr#2161

The following four tools were moved:
1.memstress
2.ramtest
3.ramspeed
4.cachespeed

Signed-off-by: crafcat7 <crafcat7@outlook.com>
2023-10-26 00:09:28 +08:00
raiden00pl
d1ebe6cd24 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.
2023-10-25 00:25:58 +08:00
raiden00pl
abdcc8d17c Documentation: unify applications/xxx/index.rst 2023-10-24 10:29:01 -03:00
raiden00pl
cffc74c664 Documentaion: migrate system/readme 2023-10-24 10:29:01 -03:00
raiden00pl
af8548097f Documentation: migrate system/i2c readme 2023-10-23 19:52:53 +08:00
raiden00pl
e93eb76017 Documentation: list all supported libs tools and apps 2023-10-23 19:52:53 +08:00
raiden00pl
f84cb54515 Documentation: move nxdiag to applications/system 2023-10-23 19:52:53 +08:00
raiden00pl
131f4151b7 Documentation: reflects the structure of nuttx-apps 2023-10-23 19:52:53 +08:00