Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-09-14 06:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
60363 commits 24 branches 205 tags 541 MiB
Commit graph

62 commits

Author SHA1 Message Date
p-szafonimateusz
e1fb0498b2 doc: update citests.rst and move to Testing 
update citests.rst and move page from Guides to Testing

Signed-off-by: p-szafonimateusz <p-szafonimateusz@xiaomi.com>
 2026-01-04 09:40:12 -03:00
Luchian Mihai
172dd3959a docs/guides/lwl: move lwl's README.txt to lwl.rst 
This PR moves the lwl's READEME.txt file to Documentation/guides/lwl.rst

Signed-off-by: Luchian Mihai <luchiann.mihai@gmail.com>
 2025-12-23 15:20:06 +01:00
raiden00pl
1b358af82f Documentation: add notes about TAP configuration for qemu 
add notes how to configure QEMU network with TAP.

Signed-off-by: raiden00pl <raiden00@railab.me>
 2025-12-18 11:39:54 -03:00
Côme VINCENT
ec64401c62 docs: Add Nix flake development environment guide 
This commit introduces a new guide in  that details how to set up a reproducible development environment for NuttX using Nix flakes.

The guide covers:
- Prerequisites for using Nix flakes.
- Steps to enter the NuttX development shell.
- Benefits of using the Nix flake (reproducibility, simplified onboarding, dependency management).
- An overview of the  contents.

A link to this new guide has also been added in index.rst to ensure discoverability.

Signed-off-by: Côme VINCENT <44554692+comejv@users.noreply.github.com>
 2025-07-26 20:55:29 +08:00
George Poulios
16143b82b3 Documentation/guides/optee: Add an OP-TEE guide 
The guide:
 - explains the different OP-TEE transports available
   in NuttX
 - gives brief instructions on how to enable the OP-TEE
   driver
 - documents the IOCTLs supported, and
 - shows typical usage in a NuttX app

Signed-off-by: George Poulios <gpoulios@census-labs.com>
 2025-05-09 10:29:26 +08:00
raiden00pl
9394962cf6 Documentation: move debug pages to a separate top level page 
Move debug related pages from Guides to a separate top level page.
This way all pages related to debugging will be in one place
which is more user friendly.

Related Github issue: https://github.com/apache/nuttx/issues/15667

Signed-off-by: raiden00pl <raiden00@railab.me>
 2025-03-24 20:23:47 +08:00
wangmingrong1
49460518a9 Doc: Fortify Instructions 
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
 2025-01-23 15:36:14 +08:00
wangmingrong1
7774271ad6 Docu: Stack overflow check 
Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
 2025-01-23 14:14:38 +08:00
Huang Qi
a8ba833cde Documentation: Add Rust integration guide for NuttX 
Add a new guide documenting how to integrate Rust with NuttX, including:
- Prerequisites and supported platforms
- Setup instructions for Rust toolchain
- Required NuttX configurations
- Example build and run instructions for RISCV32 target

The guide provides an experimental but working example of running
a Rust application on NuttX using the rv-virt:nsh board.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
 2025-01-09 15:43:10 +08:00
Ludovic Vanasse
c55c2511ad Doc: improve and add documentations for the guide section of the wiki 
* Add a migration warning to the update release system and the elf
programs documentation pages. This is just to add a papertrail from
where the documentation originate in case of error during the migration
process.
* Improve the building nuttx with app out of source tree
* Add new guide pages
	* Building uclibc++
	* Custom app directories
	* Debugging ELF loadable modules
	* Multiple NSH sessions
	* NSH network link management
	* RAM & ROM disks
	* Reading CAN messages
	* Remove device drivers with NSH
 2024-12-30 12:32:42 +08:00
Ludovic Vanasse
04c7391162 Doc: loading ELF program 
Migrate the Updating a release System with ELF programs with child pages
to official wiki
 2024-12-29 14:23:27 +08:00
Takuya Miyasita
f66c4a0733 Documentation/guides: add the guide:how to port. 
I think the guy who wants to port NuttX is expected to understand NuttX kernel code and related configurations,
but the getting enough knowledge needs to read the kernel codes deeply.

To reduce the time for NuttX beginner who wants to port,
I tried to make the guide (how to port) based on my porting journey.
 2024-12-12 21:52:24 +08:00
wangmingrong1
9555f9ff55 arm64/mte: Add support for arm64 mte 
For details, please refer to the kernel's introduction to this at "https://docs.kernel.org/arch/arm64/memory-tagging-extension.html" and Android's introduction to this at "https://source.android.com/docs/security/test/memory-safety/arm-mte"

Of course, there is also the following detailed principle introduction
https://developer.arm.com/-/media/Arm%20Developer%20Community/PDF/Arm_Memory_Tagging_Extension_Whitepaper.pdf

The modification of this patch is only to merge the simplest MTE function support. In the future, the MTE function will be integrated into the kernel to a greater extent, for example, hardware MTE Kasan will be supported in the future.

Signed-off-by: wangmingrong1 <wangmingrong1@xiaomi.com>
 2024-12-02 11:04:11 -03:00
Ludovic Vanasse
2c2a794240 Doc: Migrate Smaller Vector Tables 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Smaller+Vector+Tables
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-28 09:35:07 +08:00
Ludovic Vanasse
2532a79c13 Doc: Migration Signaling Semaphores and priority inheritance 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Signaling+Semaphores+and+Priority+Inheritance
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-28 09:35:07 +08:00
Ludovic Vanasse
a5e714a71e Doc: Migrate Signaling Events from Interrupt Handlers doc 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Signaling+Events+from+Interrupt+Handlers
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-28 09:35:07 +08:00
raiden00pl
8b9337fb52 Documentation: add some notes about running NuttX on Renode 
add some notes about running NuttX on Renode
 2024-10-26 19:37:10 +08:00
Ludovic Vanasse
d73d34b1a0 Doc: Migrate Semihosting 
Migrate https://cwiki.apache.org/confluence/display/NUTTX/Semihosting to
official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-21 09:23:07 +08:00
Ludovic Vanasse
aef4d78e70 Doc: Migrate Porting drivers to stm32f7 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Porting+Drivers+to+the+STM32+F7
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-21 09:23:07 +08:00
Ludovic Vanasse
9cf3cae3a2 Doc: Migrate Platform Directories 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Platform+Directories
to the official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-21 09:23:07 +08:00
Ludovic Vanasse
b0679cbeee Doc: Migrate NuttX Protected Build 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/NuttX+Protected+Build
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-20 17:36:40 -03:00
Ludovic Vanasse
e9548e46b9 Doc: Migrate Integrating with Newlib 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Integrating+with+Newlib
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-20 17:36:40 -03:00
Ludovic Vanasse
035faaccc7 Doc: Migrate IPv6 
Migrate https://cwiki.apache.org/confluence/display/NUTTX/IPv6 to
official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-20 17:36:40 -03:00
Ludovic Vanasse
e9c107e0ba Doc: Migrate logging to a ram buffer 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Logging+to+a+RAM+Buffer
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-20 17:36:40 -03:00
Ludovic Vanasse
678d0484b4 Doc: Migrate Versioning and Task Names 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Versioning+and+Task+Names
to the official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-15 09:45:43 +08:00
Ludovic Vanasse
5e002d99e5 Doc: Migrate Kernel Threads with Custom Stacks 
Migrate
https://cwiki.apache.org/confluence/display/NUTTX/Kernel+Threads+with+Custom+Stacks
to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-15 03:15:55 +08:00
Ludovic Vanasse
6ff7c84a7f Doc: Migrate Put special stuff in NuttX header files 
Migrate the page "Why can't I put my special stuff in NuttX header
files?" page (https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629466) to the official wiki.

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-15 01:22:59 +08:00
Ludovic Vanasse
2d6df43ca2 Doc: Migrate including files in board.h 
Migrate including files in board.h (https://cwiki.apache.org/confluence/display/NUTTX/Including+Files+in+board.h) to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-15 01:22:59 +08:00
Ludovic Vanasse
30b1660cc2 Doc: Migrate Disabling the Stack Dump During Debugging 
Migrate https://cwiki.apache.org/confluence/display/NUTTX/Disabling+the+Stack+Dump+During+Debugging
to the official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-15 01:22:59 +08:00
Ludovic Vanasse
14c115b20f Doc: Migrate ARMv7-M run time stack checking doc 
Migrate the ARMv7-M run time stack checking documentation page from the
Confluence wiki to the official documentation.

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-14 17:51:31 +08:00
Ludovic Vanasse
41c4e3a5a1 Doc: Migrate Using Kernel Threads 
Migrate page Using Kernel Threads from Confluence wiki to official wiki

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-14 13:41:00 +08:00
Ludovic Vanasse
c13600a91f Doc: Migrate changing the system clock configuration 
Migrate the Changing the System Clock Configuration documentation from
the Confluence wiki to the official documentation

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-14 12:53:24 +08:00
Ludovic Vanasse
35f8b082a7 Doc: Migrate debugging/flashing NuttX with hw debugger 
Migrate debugging/flashing NuttX with hw debbuger documentation from
Confluence to official documentation

Signed-off-by: Ludovic Vanasse <ludovicvanasse@gmail.com>
 2024-10-12 14:03:42 +08:00
liaoao
02c292a25a fdt: add fdt description document 
Signed-off-by: liaoao <liaoao@xiaomi.com>
 2024-09-30 14:20:49 +08:00
wangmingrong
ae3facda53 kasan: Implementation of Kasan based on software tags. 
Currently, only aarch64 is supported

Signed-off-by: wangmingrong <wangmingrong@xiaomi.com>
 2024-09-19 03:15:29 +08:00
liaoao
b98d68599e coresight: add document for coresight 
Signed-off-by: liaoao <liaoao@xiaomi.com>
 2024-09-13 09:09:19 +08:00
anjiahao
ce4969e881 Documentation:update gdbserver Documentation 
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
 2024-08-21 18:01:06 +08:00
Huang Qi
ae0ef94438 doc: Add a simple guide for thread local storage 
Explain the basic concept of thread local storage and
the usage, limits of CONFIG_SCHED_THREAD_LOCAL.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
 2024-07-16 08:34:55 -03: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
anjiahao
1295ccdd0e Documentation:add Documentation for stack statistics 
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
 2023-12-11 02:06:51 -08:00
Michal Lenc
d7c53a6939 docs: add description about local CI tests 
This page adds description how to run CI tests locally.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
 2023-11-17 19:36:53 +01:00
raiden00pl
c347343e09 Documentation: migrate "STM32 CCM Allocator" from wiki 
link: https://cwiki.apache.org/confluence/display/NUTTX/STM32+CCM+Allocator

Co-authored-by: hartmannathan <59230071+hartmannathan@users.noreply.github.com>
 2023-11-08 15:54:54 +08:00
raiden00pl
3e0d1e9b52 Documentation: migrate "STM32 Null Pointer Detection" from wiki 
link: https://cwiki.apache.org/confluence/display/NUTTX/STM32+Null+Pointer+Detection

Co-authored-by: hartmannathan <59230071+hartmannathan@users.noreply.github.com>
 2023-11-08 15:54:54 +08:00
raiden00pl
4d65d9908b Documentation: migrate "Auto-Mounter" from wiki 
link: https://cwiki.apache.org/confluence/display/NUTTX/Auto-Mounter
 2023-11-06 18:42:17 -03:00
raiden00pl
2214eecddc Documentation: migrate "Testing TCP/IP Network Stacks" from wiki 
link: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629530
 2023-11-06 09:03:07 +08:00
raiden00pl
b7f94fbf22 Documentation: various cosmetic changes 2023-10-30 20:29:54 +08:00
Tomáš Pilný
3b6b4788c9 Added minidumpserver into index 2023-08-22 23:35:29 +08:00
anjiahao
79f6efb977 ofloader:add Documentation for ofloader 
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
 2023-08-05 12:40:02 -07:00
anjiahao
1dfcb1f12d Documentation:Add documentation related to gdb python script debugging 
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
 2023-06-25 18:17:30 +08:00
chao an
ff6f280b95 Documentation/coredump: add coredump chapter 
Signed-off-by: chao an <anchao@xiaomi.com>
 2023-05-26 09:33:42 +08:00