Commit Graph

2520 Commits

Author SHA1 Message Date
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
Zhe Weng
6403965075 Documentation: Add netdev description with multiple IPv6 addresses
Signed-off-by: Zhe Weng <wengzhe@xiaomi.com>
2023-11-07 19:30:36 +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
1c6e5cc0c4 Documentation: migrate "Work Queue Deadlocks" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Work+Queue+Deadlocks
2023-11-06 18:42:17 -03:00
raiden00pl
2d8c4e6645 Documentation: migrate "SLIP Configuration" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/SLIP+Configuration
2023-11-06 18:42:17 -03:00
raiden00pl
8a8111c2fc Documentation: migrate "CONFIG_NET_GUARDSIZE" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/CONFIG_NET_GUARDSIZE
2023-11-06 18:42:17 -03:00
raiden00pl
1f9e17f5c7 Documentation: add SystemView configuration instructions 2023-11-06 18:42:17 -03: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
Michal Lenc
784aa526b1 documentation/contributing: remove copyright notice in file header
Copyright notice and author contact/information should not be included
in file header anymore. Only standard Apache 2.0 licensing information
should be used.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2023-11-07 01:01:18 +08: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
afa9e29272 Documentation: migrate "Effects of Disabling Interrupts or Pre-Emption on Response Latency" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Effects+of+Disabling+Interrupts+or+Pre-Emption+on+Response+Latency
2023-11-06 09:03:07 +08:00
raiden00pl
0b17238714 Documentation: migrate "Per-Thread Interrupt Controls" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Per-Thread+Interrupt+Controls
2023-11-06 09:03:07 +08:00
raiden00pl
fdc671fa3e Documentation: migrate "Critical Section Monitor" from wiki
links: https://cwiki.apache.org/confluence/display/NUTTX/Critical+Section+Monitor
2023-11-05 12:11:14 +08:00
raiden00pl
f96064db75 Documentation: migrate "SMP Critical Sections" from wiki
links: https://cwiki.apache.org/confluence/display/NUTTX/SMP+Critical+Sections
2023-11-05 12:11:14 +08:00
raiden00pl
20fd7f588f Documentation: CONFIG_USER_ENTRYPOINT was changed to CONFIG_INIT_ENTRYPOINT 2023-11-05 12:11:14 +08: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
3b23a693ac Documentation: migrate "Linux Processes vs NuttX Tasks" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Linux+Processes+vs+NuttX+Tasks
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
de564d38e9 Documentation: migrate "Wide Font Support" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Wide+Font+Support
2023-11-05 12:11:14 +08:00
raiden00pl
63558cf72f Documentation: migrate "NuttX Graphics Subsystem (NX)" from wiki
link to wiki: https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=139629474
2023-11-05 12:11:14 +08:00
raiden00pl
bfd342b4eb Documentation: fix warning 2023-11-05 12:11:14 +08:00
raiden00pl
43be20d67e Documentation: fix warning
Documentation/legacy_README.md:675: WARNING: duplicate label introduction/resources:installation, other instance in Documentation/introduction/resources.rst
2023-10-30 20:29:54 +08:00
raiden00pl
649cd00c8b Documentation: review quickstart/install.rst 2023-10-30 20:29:54 +08:00
raiden00pl
afa2be4a1e Documentation: fix warning 2023-10-30 20:29:54 +08:00
raiden00pl
b7f94fbf22 Documentation: various cosmetic changes 2023-10-30 20:29:54 +08:00
raiden00pl
64be5c6958 Documentation: update organization.rst 2023-10-30 20:29:54 +08:00
raiden00pl
93f1d62f34 Documentation: fix warning
Documentation/legacy_README.md: WARNING: document isn't included in any toctree
2023-10-30 20:29:54 +08:00
raiden00pl
ce97fccf9a Documentation: split some long lines 2023-10-30 20:29:54 +08:00
raiden00pl
82bcc3f7d4 Documentation: fix warnings 2023-10-30 20:29:42 +08:00
raiden00pl
041308f950 Documentation: review applications/nsh 2023-10-30 20:29:42 +08:00
Rodrigo Sim
54a16e8f74 Documentation: add documentation for STM32F401RC-RS485 board 2023-10-29 20:50:00 -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
Filipe Cavalcanti
b7288c4db9 Gathering community recommendations
testing badges

Converted legacy readme from .md to .rst

Revert "Converted legacy readme from .md to .rst"

This reverts commit e33fef7a5aaa5dd377f87b90a667a2704b9fb834.
2023-10-28 13:55:56 +08:00
raiden00pl
f9d088590a Documentation: migrate boards/{z16|z80}/xxx/configs/README.txt 2023-10-28 13:55:22 +08:00
raiden00pl
8f7be6ce27 Documentation: move nxwidgets to applications as it is apps-side lib 2023-10-27 13:21:40 -03:00
raiden00pl
579a35dc68 Documentation: fix ugly formating around some inline literals 2023-10-27 13:21:40 -03: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
870139e45f Documentation: move socketcan.rst to net/ 2023-10-27 13:21:40 -03:00
raiden00pl
8090fb9d5c Documentation: add dummy pages for missing top directories
crypto, openamp, video and wireless
2023-10-27 13:21:40 -03:00
raiden00pl
9c4f042c57 Documentation: add missing directories in net 2023-10-27 13:21:40 -03:00
raiden00pl
408441bf15 Documentation: initialize cmake doc 2023-10-27 13:21:40 -03:00
raiden00pl
a2bb55d8b7 Documentation: update copyright year 2023-10-27 13:21:40 -03:00
raiden00pl
82e260740a Documentation: cosmetics for unionfs.rst 2023-10-27 13:21:40 -03:00
raiden00pl
01500f8b20 Documentation: fix latexpdf build 2023-10-26 18:13:34 -03:00
raiden00pl
56529d2944 Documentation: migrate the rest boards
- migrated /README are removed from /boards

- there are a lot of READMEs that should be further converted to rst.
  At the moment they are moved to Documentation/platforms and included in rst files
2023-10-26 18:13:34 -03:00
raiden00pl
443e900188 Documentation: migrate the rest of drivers readmes 2023-10-26 20:02:03 +08: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
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
raiden00pl
9bef53bbdd Documentation: migrate /drivers 2023-10-26 00:08:54 +08:00
raiden00pl
8e40cfd1b6 Documentation: migrate /arch 2023-10-26 00:08:54 +08:00
raiden00pl
8a330ca0bc Documentation: migrate /tools 2023-10-26 00:08:54 +08:00
raiden00pl
64b924d18c Documentation: migrate /syscall 2023-10-26 00:08:54 +08:00
raiden00pl
00d14665d1 Documentation: migrate /mm 2023-10-26 00:08:54 +08:00
raiden00pl
ebcf8f0d16 Documentation: migrate /net 2023-10-26 00:08:54 +08:00
raiden00pl
61cdd105ef Documentation: migrate /libs 2023-10-26 00:08:54 +08:00
raiden00pl
6448135f65 Documentation: migrate /fs 2023-10-26 00:08:54 +08:00
raiden00pl
1822b1c37f Documentation: migrate /audio 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
Alan Carvalho de Assis
10e1540b53 games: Add documentation
This commit add support to Games documentation on NuttX.

Signed-off-by: Alan Carvalho de Assis <acassis@gmail.com>
2023-10-24 13:54:32 +08:00
raiden00pl
c87a967806 Documentation: format the NSH command list
command names will be more visible and look nicer
2023-10-23 14:53:59 +03:00
raiden00pl
bca2a7925c Documentation: migrate industry/abnt_codi readme 2023-10-23 19:52:53 +08:00
raiden00pl
af8548097f Documentation: migrate system/i2c readme 2023-10-23 19:52:53 +08:00
raiden00pl
ecbc8aa62c Documentation: migrate nimble 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
f486c59f6f Documentation: move wapi to applications/wireless 2023-10-23 19:52:53 +08:00
raiden00pl
a03b41291b Documentation: migrate apps/logging doc 2023-10-23 19:52:53 +08:00
raiden00pl
61359f7fcc Documentation: migrate apps/boot doc 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
raiden00pl
88b7ce80a0 Documentation: add missing platforms to platforms/ and remove introduction/platforms 2023-10-22 19:06:44 +08:00
raiden00pl
52ec2326b3 Documentation: fix esp32-devkitc errors 2023-10-22 19:06:44 +08:00
raiden00pl
97fa781de7 Documentation: move a64 from arm to arm64 2023-10-22 19:06:44 +08:00
halyssonJr
48a878fd06 Adding initial support to board esp32-2432S028, is a board with SD Card, RGB LED, output for speak and display LCD
Signed-off-by: halyssonJr <halysson1007@gmail.com>
2023-10-22 00:57:36 +08:00
raiden00pl
3cccb0dd17 Documentation: migrate apps/example/README.md 2023-10-21 22:13:55 +08:00