Commit graph

124 commits

Author SHA1 Message Date
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
57a7cb503a Documentation: fix spelling 2025-05-15 11:33:41 +08:00
Lars Kruse
b333ad3ab5 style: fix typos
Thanks, codespell!
2025-04-30 13:45:46 +08:00
dongjiuzhu1
b233d1494d Documentation: remove unused dd config
Signed-off-by: dongjiuzhu1 <dongjiuzhu1@xiaomi.com>
2025-04-20 00:41:26 +08:00
Laczen JMS
dd29b8a4cf Documentation/applications/examples/elf/index.rst: Update for PR #3062 in nuttx-apps
Update the documentation to align with https://github.com/apache/nuttx-apps/pull/3062

Signed-off-by: Laczen JMS <laczenjms@gmail.com>
2025-04-19 08:55:13 -03:00
chao an
52482219c8 libc/elf: rename modlib to libelf
Renaming "modlib" to "libelf" is more in line with the implementation content,
which makes it easier for individual developers to understand the capabilities of this module.

CONFIG_LIBC_MODLIB -> CONFIG_LIBC_ELF

Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-04-11 09:43:22 +08:00
Tiago Medicci Serrano
85d9078a98 Documentation/testing: Add MTD transfer rate test app docs
Add documentation entry for the `mtd` test/benchmark application.

Signed-off-by: Tiago Medicci Serrano <tiago.medicci@espressif.com>
2025-03-24 16:08:42 -03:00
Eren Terzioglu
8ffc6689f4 Documentation/games: Add snake game docs
Add snake game documentation on docs

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-03-21 10:28:45 -03:00
Michal Lenc
ac3b0adb42 documentation/boot/nxboot: update nxboot documentation
This updates nxboot documentation with the last changes in nuttx-apps
repository.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2025-03-12 11:18:57 -03: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
Tiago Medicci Serrano
597b7efffc Documentation/python: Add entries for Python on ESP32-S3
This commit adds the entries in the documentation about running
Python on ESP32-S3.

Signed-off-by: Tiago Medicci Serrano <tiago.medicci@espressif.com>
2025-03-08 06:49:23 -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
Stepan Pressl
e376e22f93 Documentation/applications/benchmarks/cyclictest: -q
-q (--quiet) option added

Signed-off-by: Stepan Pressl <pressl.stepan@gmail.com>
2025-03-03 16:00:07 +01:00
Stepan Pressl
e53de96692 Documentation: add cyclictest benchmark utility documentation
The documentation concerns the cyclictest in apps/benchmarks/cyclictest.
The documentation describes the usage of the NuttX device timer
in this benchmark, the app usage and an example with an output.

Signed-off-by: Stepan Pressl <pressl.stepan@gmail.com>
2025-02-27 11:30:55 -03:00
Eren Terzioglu
a66e58cf59 Docs/brickmatch: Update brickmatch game docs
Update brickmatch game docs after I/O option additions

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
2025-02-27 12:12:20 +01:00
Tiago Medicci Serrano
798a73ac1a Documentation/python: Fix tutorial for running Python
After https://github.com/apache/nuttx-apps/pull/2982, there is no
need to mount the modules and manually set the required environment
variables: they are all set by the new Python wrapper application.

Signed-off-by: Tiago Medicci Serrano <tiago.medicci@espressif.com>
2025-02-21 15:34:48 +01:00
Huang Qi
69495f8a40 docs: Add Rust examples including JSON handling and Slint UI framework
Summary:
- Added two new Rust example applications to the documentation:
  - `hello` example showcasing JSON serialization/deserialization, async runtime usage, and C interoperability in a NuttX environment
  - `slint` example demonstrating the integration of the Slint UI framework with NuttX's framebuffer and touchscreen devices for creating GUI applications in Rust
- Each example includes detailed explanations of key features and how they are implemented using Rust's modern language capabilities

Impact:
- Enhances the documentation for Rust development within NuttX, providing clear and practical examples for developers
- Facilitates easier adoption of Rust for new projects by demonstrating how to leverage its features while maintaining compatibility with existing NuttX infrastructure
- No changes to the core NuttX system; the additions are entirely within the documentation and examples directory

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-01-30 13:45:01 +08:00
Huang Qi
68d1750c12 docs: Rename hello_rust to rust/baremetal to reflect the actual codebase
Summary:
- The `hello_rust` example has been moved to `rust/baremetal` to better reflect its purpose as a bare-metal Rust application.
- The move also helps in organizing the Rust examples more clearly, separating them into categories based on their environment (bare-metal vs. non-bare-metal).
- A new directory structure has been created under `rust/baremetal`, and the `index.rst` file has been updated to describe the `baremetal` example in detail.
- The top-level `rust/index.rst` file has been created to include the new `rust/baremetal` directory in the toctree.

Impact:
- The new file structure and documentation improvements will help new contributors and users understand the purpose and setup of the example more easily.
- This change aligns the documentation with the actual codebase, enhancing the overall maintainability and clarity of the project.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2025-01-29 12:41:06 +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
chao an
71a37b4f2d Documentation: clean up of CONFIG_NSH_LINELEN define
Signed-off-by: chao an <anchao.archer@bytedance.com>
2025-01-15 23:17:51 +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
Tiago Medicci Serrano
154a91c323 Documentation: Update Python documentation for socket module
Update Python documentation after supporting Python's socket module
to reflect the commands used to run the RISC-V QEMU.
2025-01-08 09:27:25 +08: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
Tiago Medicci Serrano
89d8a8a193 Documentation: Add entry for Python on NuttX
This commit adds entries in the documentation referring to the
Python's port for NuttX.
2024-12-12 23:38:35 +08:00
buxiasen
3164f201fb document/drivertest: add more information in drivertest
Signed-off-by: buxiasen <buxiasen@xiaomi.com>
2024-12-11 00:33:48 +08:00
simbit18
e0106b00b3 docs: Fix example ina226
added example of doc ina226
2024-12-10 09:38:40 -03:00
wangmingrong1
eff13d6004 gcov: Add usage documentation
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
2024-11-26 16:32:50 +08:00
Felipe Moura
0fad2ee73f riscv/common/espressif: Fix spi slave driver
Fix defconfigs and documentation
2024-11-05 14:59:37 +08:00
Michal Lenc
9930a64de7 docs: add nxboot documentation entry
This commit adds documentation entry for NuttX based bootloader nxboot.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2024-11-01 11:32:44 -03:00
Felipe Moura
d291ed0afd Writing documentation related to SPI slave.
Fix build issues
2024-10-24 20:56:36 +08:00
Matteo Golin
bbc95d70db adc: Implement ADC driver interface for MCP3008 over SPI. Includes documentation page for the driver, and inclusion of driver registration code for RP2040-based boards. 2024-10-22 13:56:23 +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
Matheus Catarino
1936e68f40 risc-v/qemu-rv: Add Build Config for leds64_zig
This PR adds a new Build Config `rv-virt:leds64_zig` that builds the Zig App `leds_zig` for QEMU RISC-V 64-bit.
ref.: https://github.com/apache/nuttx-apps/pull/2534
2024-09-05 11:28:12 +08:00
Alan C. Assis
a409c42d13 Doc: Fix broken SPI Tool documentation 2024-08-15 13:36:50 +08:00
Lup Yuen Lee
3862b71728 risc-v/qemu-rv: Add Build Config for leds64_rust
This PR adds a new Build Config `rv-virt:leds64_rust` that builds the Rust App `leds_rust` for QEMU RISC-V 64-bit. The build requires the [Rust Target `riscv64gc-unknown-none-elf`](https://github.com/apache/nuttx/pull/12858):

```bash
rustup target add riscv64gc-unknown-none-elf
```

New Files:

`boards/risc-v/qemu-rv/rv-virt/configs/leds64_rust/defconfig`: Add new Build Config `rv-virt:leds64_rust`

Updated Docs:

`applications/examples/leds_rust/index.rst`: Add `leds_rust` example app

`platforms/risc-v/qemu-rv/boards/rv-virt/index.rst`: Add `rv-virt:leds64_rust` config
2024-08-08 12:19:25 +08:00
shizhenghui
f2b1c649eb nxcodec: add .rst documentation
Signed-off-by: shizhenghui <shizhenghui@xiaomi.com>
2024-07-09 10:46:17 -03:00
Yanfeng Liu
afb368afd2 docs/wamr: initial WAMR guide
This briefs how to get started with WAMR in NuttX.

Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
2024-06-11 10:13:20 +08:00
chenrun1
52f381fdd4 Adjust the apps/benchmarks directory and add some new Profile tools
Based on the adjustment of https://github.com/apache/nuttx-apps/pull/2346, update the Document

Signed-off-by: chenrun1 <chenrun1@xiaomi.com>
2024-04-07 18:49:16 +08:00
Saurav Pal
1bec133385 drivers/mtd/mtd_nandram: Adds virtual NAND Flash device simulator.
Adds virtual NAND Flash device simulator, NAND flash log wrapper, and documentation for it.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
2024-03-04 10:38:08 -03:00
raiden00pl
a99275ec1a various cosmetic changes related to ieee802154 2024-02-18 07:40:41 -08:00
Junbo Zheng
149d648129 Documentation: add -u and +%format description for date command
Reference:
- https://github.com/apache/nuttx-apps/pull/745
- https://github.com/apache/nuttx-apps/pull/2273

Signed-off-by: Junbo Zheng <zhengjunbo1@xiaomi.com>
2024-01-29 05:43:40 -08:00
Junbo Zheng
60fa280715 Documentation: add expr command description
Reference: https://github.com/apache/nuttx-apps/pull/2268

Signed-off-by: Junbo Zheng <zhengjunbo1@xiaomi.com>
2024-01-29 05:43:40 -08:00
Junbo Zheng
6e4c72f7bf Documentation: add uptime command description
Reference: https://github.com/apache/nuttx-apps/pull/1319

Signed-off-by: Junbo Zheng <zhengjunbo1@xiaomi.com>
2024-01-29 05:43:40 -08:00
Junbo Zheng
0a23fe3bd6 Documentation: add -h option description for ls command
Reference: https://github.com/apache/nuttx-apps/pull/1821

Signed-off-by: Junbo Zheng <zhengjunbo1@xiaomi.com>
2024-01-29 05:43:40 -08:00
fangxinyong
5d40882d4c Documentation: update doc for etc romfs
as apache/nuttx#11498, need update documentation for etc romfs,
that mount etc romfs from nsh to sched/init.
2024-01-21 06:11:46 -08:00
Michal Lenc
34afef5cfb Documentation: add open_memstream test entry
Test tool for open_memstream() function added to documentation.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2023-11-27 03:24:53 -08:00