Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-30 05:40:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
62161 commits 25 branches 204 tags 555 MiB
Commit graph

23 commits

Author SHA1 Message Date
Tomasz 'CeDeROM' CEDRO
0cfa6f1b96 doc: Migrating the rest of documentation from cwiki. 
* This completes task list in https://github.com/apache/nuttx/issues/11127.
* This preserves selected content from cwiki and moves it to new docs.
* Most pages are simple copy-paste with a simple RST formatting updates,
  with minor updates.
* Content update / reorganization will follow later on when needed.
* Files added (or updated title from cwiki -> current docs):
  * Documentation/implementation:
    * index.
    * cancellation_points.
    * Asynchronous vs. Synchronous Context Switches -> context_switches.rst.
    * ARMv7-M Hardfaults, SVCALL, and Debuggers -> hardfatuls.rst.
    * chip.h FAQ -> chip_h.rst.
    * Debug Output (SYSLOG) Issues -> syslog.rst.
    * Detaching File Descriptors -> file_descriptors.rst.
    * device_nodes.rst.
    * Dynamic Clocking -> power_management.rst.
    * ENOTTY ioctl() Return Value -> ioctl.rst.
    * memory_configurations.rst.
    * kernel_modules_vs_shared_libraries.rst.
    * NAKing USB OUT/IN Tokens -> usb.rst.
    * naming_arch_mcu_board_interfaces.rst.
    * naming_os_internals.rst.
    * nuttx_tasking.rst.
    * oneshot_timers_and_cpu_load.rst.
    * nuttx_initialization_sequence.rst.
    * short_time_delays.rst.
    * Signal Handler Tour -> signal_handlers.rst.
    * smp.rst.
    * syslog.rst.
    * Task Exit Sequence -> nuttx_tasking.rst.
    * tasks_vs_threads.rst.
    * tls.rst.
    * tickless_os.rst.
    * Why Can't Kernel Threads Have pthreads -> kernel_threads_vs_pthreads.rst.
  * Documentation/components/filesystem:
    * smartfs.rst.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
 2026-05-28 09:34:04 +08:00
Sumit6307
b2b78d2f8a fs: Add Kernel-level VFS Performance Profiler 
This adds a kernel-level performance profiler for the VFS.
By enabling CONFIG_FS_PROFILER, the core VFS system calls
(file_read, file_write, file_open, and file_close) are
instrumented to track high-resolution execution times using
clock_systime_timespec() seamlessly.

The collected statistics are exposed dynamically via a new
procfs node at /proc/fs/profile, allowing CI regression
testing without needing external debugging tools.

Signed-off-by: Sumit6307 <sumitkesar6307@gmail.com>
 2026-04-26 11:50:09 -03:00
Huang Qi
e3eeaefd6d style: Fix "the the" typo across the codebase. 
Fix 269 occurrences of duplicate "the" word typo found in 209 files
across source code, header files, and configuration.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
 2026-03-23 11:07:49 +01:00
Matteo Golin
28cd98c561 docs/littlefs: Improve documentation about littelfs on NuttX 
Describes some of the quirks of using littlefs on NuttX and links to an
issue discussing the sync semantics.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
 2025-08-08 02:09:18 +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
chenrun1
2375a55517 v9fs:add Documentation 
Signed-off-by: chenrun1 <chenrun1@xiaomi.com>
 2025-01-20 17:12:14 +08:00
Ludovic Vanasse
482be69db4 Doc: migration filesystem doc 
Migrate these pages from Confluence wiki to official wiki:

* https://cwiki.apache.org/confluence/display/NUTTX/Special+Files+and+Device+Numbers
* https://cwiki.apache.org/confluence/display/NUTTX/Pseudo+File+System
* https://cwiki.apache.org/confluence/display/NUTTX/How+NXFFS+Works
* https://cwiki.apache.org/confluence/display/NUTTX/NuttX+File+System
* https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139630111
 2024-11-11 10:37:56 +08:00
Michal Lenc
dc6f406e7f documentation/inotify: add newly supported events 
IN_CLOSE_WRITE and IN_CLOSE_NOWRITE are now supported and IN_MODIFY
can be used for truncate as well.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
 2024-10-08 08:14:19 +08:00
guohao15
f95b73f9a8 add inotify doc 
Signed-off-by: guohao15 <guohao15@xiaomi.com>
 2024-09-19 03:15:51 +08:00
Saurav Pal
4a4725386d docs/fs/mnemofs: Update new design and NAND flash structure 
Add documentation about the new mnemofs design and the NAND flash structure.

Signed-off-by: Saurav <resyfer.dev@gmail.com>
 2024-08-24 18:24:58 +08:00
Saurav Pal
23b7dc0651 fs/mnemofs: Setup and VFS methods 
The Setup and VFS methods for mnemofs, a NAND Flash File System.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
 2024-07-10 09:25:23 -03:00
Yanfeng Liu
3bd35487f0 docs/comments: add simple document and fix typo 
This patch adds simple document for the shared memory file system.
with typos fix in a other places.

Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
 2024-03-03 01:55:07 +08:00
Saurav Pal
93d03d0418 fs: Add VFS docs 
This commit adds VFS docmentation, and details about the VFS interface.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
 2024-02-20 18:28:09 -08:00
Yanfeng Liu
81d3e123cb docs/rpmsgfs: initial docs on RPMsg file system usage. 
This patch adds steps about configuring and using the RPMsg file system
with simple example.

Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
 2024-02-20 18:25:18 -08:00
Yanfeng Liu
0e55e461a5 docs/tmpfs: add initial document 
This adds initial document for using TMPFS based on my short experience,
hoping to save people's time on guessing how to use.

Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
 2024-02-15 17:49:15 +08:00
Saurav Pal
36ea2929f0 docs/fs/vfat: Improve VFAT documentation 
Improved documentation of File Allocation Table (FAT) or VFAT.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
 2024-02-05 03:43:41 -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
770df6d820 Documentation: remove readme references 2023-10-27 13:21:40 -03:00
raiden00pl
d72c6802c1 Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
raiden00pl
82e260740a Documentation: cosmetics for unionfs.rst 2023-10-27 13:21:40 -03:00
raiden00pl
d98ae9d3e4 Documentation: cosmetics changes 
- various style fixes
- limit the line length to about 80 characters to improve readability in terminal-based IDEs
 2023-10-26 20:01:21 +08:00
raiden00pl
6448135f65 Documentation: migrate /fs 2023-10-26 00:08:54 +08:00