Commit Graph

87 Commits

Author SHA1 Message Date
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
Nathan Hartman
26e4dd5638 Documentation: Fix various typos 2023-11-23 16:38:19 -08:00
raiden00pl
014029c649 boards: add support for ODrive V3.6 board 2023-11-18 17:07:20 -08:00
Stuart Ianna
90cf37a179 Documentation: Fix sd_bench command help description.
The help prompt usage output for sd_bench was inconsistent with that of
the actual application. Amend this error.
2023-11-16 22:52:30 -08:00
raiden00pl
caef223268 Documentation: migrate "CNxConsole Keyboard Input" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/CNxConsole+Keyboard+Input
2023-11-06 18:42:17 -03:00
raiden00pl
200f709092 Documentation: migrate "NxTerm Example" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/NxTerm+Example
2023-11-06 18:42:17 -03:00
raiden00pl
adc557f545 Documentation: migrate "apps/tools/mkromfsimg.sh" from wiki
link https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629538
2023-11-05 12:11:14 +08:00
raiden00pl
03b4ec60a5 Documentation: migrate "Running Applications from NSH" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Running+Applications+from+NSH
2023-11-05 12:11:14 +08:00
raiden00pl
041308f950 Documentation: review applications/nsh 2023-10-30 20:29:42 +08: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
raiden00pl
8f7be6ce27 Documentation: move nxwidgets to applications as it is apps-side lib 2023-10-27 13:21:40 -03:00
raiden00pl
770df6d820 Documentation: remove readme references 2023-10-27 13:21:40 -03:00
Stuart Ianna
fe468b276e Documentation: Add entry for sd_bench tool. 2023-10-26 09:00:29 +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
afef047c6f Documentation: fix warning introduced by sd_stress
nuttx/Documentation/applications/testing/sd_stress/index.rst:1: WARNING: Title overline too short.
2023-10-26 00:08:54 +08:00
Stuart Ianna
c19c943835 Documentation: Add entry for sd_stress tool. 2023-10-25 09:16:50 +08:00
raiden00pl
962d46186d Documentation/netutils: ignore header for TOC 2023-10-25 00:25:58 +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
6e9cd74e81 Documentaion: migrate tools/readme 2023-10-24 10:29:01 -03:00
raiden00pl
abdcc8d17c Documentation: unify applications/xxx/index.rst 2023-10-24 10:29:01 -03:00
raiden00pl
931096f3f6 Documentation: various cosmetic changes 2023-10-24 10:29:01 -03:00
raiden00pl
e229528d5a Documentation: fix warnings from games 2023-10-24 10:29:01 -03:00
raiden00pl
4520d8676a Documentaion: migrate wireless/readme 2023-10-24 10:29:01 -03:00
raiden00pl
a008eb8669 Documentaion: migrate examples/bastest/readme without test cases 2023-10-24 10:29:01 -03:00
raiden00pl
cffc74c664 Documentaion: migrate system/readme 2023-10-24 10:29:01 -03:00
raiden00pl
a9a1d719da Documentaion: migrate netutils/readme 2023-10-24 10:29:01 -03:00
raiden00pl
7e2a5f6f3f Documentaion: migrate modbus/readme 2023-10-24 10:29:01 -03:00
raiden00pl
0979fd0ab7 Documentaion: migrate interpreters/readme 2023-10-24 10:29:01 -03:00
raiden00pl
05b0b7c9f3 Documentaion: migrate graphics/readme 2023-10-24 10:29:01 -03:00
raiden00pl
454e3a210b Documentaion: migrate crypto/readme 2023-10-24 10:29:01 -03:00
raiden00pl
203f6cd4a9 Documentaion: migrate audioutils/readme 2023-10-24 10:29:01 -03:00
Michal Lenc
8f042f527e Documentation: add fmemopen test entry
Test tool for fmemopen() function added to documentation.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2023-10-24 10:28:01 -03:00
raiden00pl
24bc270d82 Documentation/examples: format the first header as in other files 2023-10-24 13:56:34 +08:00
raiden00pl
731eaefba2 Documentation/examples: add missing titles 2023-10-24 13:56:34 +08:00
raiden00pl
a342d2a7ac Documentaion: migrate testing readmes 2023-10-24 13:56:34 +08:00
raiden00pl
3d7a395f52 Documentaion: migrate examples/mcuboot readme 2023-10-24 13:56:34 +08:00
raiden00pl
e8c135ba0c Documentaion: migrate fsutils/inifile readme 2023-10-24 13:56:34 +08:00
raiden00pl
c4b2c65078 Documentaion: migrate graphics/lvgl readme 2023-10-24 13:56:34 +08:00