Huang Qi
ba4769d412
doc: Fix code blocks in thread_local_storage.rst
...
Add missing blank line before the code block to
render it correctly.
Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2024-08-03 21:15:05 +08:00
Alan Carvalho de Assis
a1a0315b9c
Doc: Fix CustomApps/CustomHello example
...
NuttX generates the app main name from Kconfig symbol
xxxx_PROGNAME. The documentation was defining manually
the entry point as custom_hello(int char, char *argv[])
and pointing CONFIG_INIT_ENTRYPOINT="custom_hello".
The right thing to do is creating the application entry
point as "int main(int char, char *argv[])" and the build
system will add "_main" to the PROGNAME.
Signed-off-by: Alan C. Assis <acassis@gmail.com>
2024-07-20 13:17:48 +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
anjiahao
67b7152034
Documentation:update qemugdb usage
...
Remove nuttx-gdbinit,use tools/gdb/__init__.py instead
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
2024-04-20 18:42:28 +08:00
TimJTi
87dc54d755
Correct error/omissions in Custom Boards guide
2024-04-04 23:07:39 +08:00
TimJTi
f9a81d3912
Correct error/omissions in Custom Apps guide
2024-04-04 23:06:53 +08:00
Alan Carvalho de Assis
a7fbf7c5cf
DOC: Fix https://github.com/apache/nuttx/issues/11760
...
The Make.defs to CustomHello example was missing.
Signed-off-by: Alan C. Assis <acassis@gmail.com>
2024-02-23 15:33:53 +01: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
anjiahao
35051dd715
coredump: support coredump save to block device when crash
...
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
2023-12-10 07:02:03 -08:00
Nathan Hartman
26e4dd5638
Documentation: Fix various typos
2023-11-23 16:38:19 -08:00
Nathan Hartman
9b77b2ba0b
Documentation: Remove executable bit from reStructuredText file.
2023-11-23 16:37:28 -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
20fd7f588f
Documentation: CONFIG_USER_ENTRYPOINT was changed to CONFIG_INIT_ENTRYPOINT
2023-11-05 12:11:14 +08:00
raiden00pl
b7f94fbf22
Documentation: various cosmetic changes
2023-10-30 20:29:54 +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
dlstjq7685
74885b1d48
fix correct spell Cirectory -> directory
2023-09-12 21:54:54 +08:00
Tomáš Pilný
24adf144e1
Fixed doc build warning cause by chinese-coded full-width comma - changed to normal comma and space
2023-08-22 23:35:29 +08:00
Tomáš Pilný
3b6b4788c9
Added minidumpserver into index
2023-08-22 23:35:29 +08:00
Tomáš Pilný
4cfd5048b6
Fixed old bugs preventing doc build
2023-08-22 23:35:29 +08:00
anjiahao
6168bdf9e0
minidumpserver: Add usage documentation
...
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
2023-08-21 18:27:05 +08:00
yinshengkai
1e164b7f75
note: add noteram crash dump
...
Dump all content when a crash occurs
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
2023-08-19 21:48:56 +08:00
anjiahao
79f6efb977
ofloader:add Documentation for ofloader
...
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
2023-08-05 12:40:02 -07:00
zhanghongyu
27d6f1e0c4
documentation: correct the nfs command format
...
Change the command format to the actual one in the system
Signed-off-by: zhanghongyu <zhanghongyu@xiaomi.com>
2023-07-03 10:18:00 -03: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
yanghuatao
29a336d6a8
sched/tls: remove PTHREAD_CLEANUP from Kconfig
...
use PTHREAD_CLEANUP_STACKSIZE to enable or disable interfaces pthread_cleanup_push() and pthread_cleanup_pop().
reasons:(1)same as TLS_TASK_NELEM (2)it is no need to use two variables
Signed-off-by: yanghuatao <yanghuatao@xiaomi.com>
2023-06-14 12:00:48 +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
Nathan Hartman
50d1de93ed
Documentation: Import "Analyzing Cortex-M Hardfaults" from CWIKI
...
* Documentation/guides/cortexmhardfaults.rst:
New. Migrated from [1] with conversion to reStructuredText,
minor typo fixes, and a link to a Narkive archive of the
original quoted question.
* Documentation/guides/index.rst:
Add above to TOC.
[1] https://cwiki.apache.org/confluence/display/NUTTX/Analyzing+Cortex-M+Hardfaults
2023-05-24 17:31:33 -03:00
Brennan Ashton
14d311ca0a
docs: Add copy button for code blocks
2023-05-20 12:58:32 +08:00
Brennan Ashton
4d3ce8f706
docs: Fix sphinx warnings listed in issue #9306
...
Fixes these errors:
```
/home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
/home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
```
2023-05-20 12:40:52 +08:00
Nathan Hartman
e299af410a
Documentation: Import Nested Interrupts page from CWIKI
...
* Documentation/guides/nestedinterrupts.rst:
New. Imported from [1] and converted from CWIKI to reStructuredText.
* Documentation/guides/index.rst:
Link to the new page.
* Documentation/guides/zerolatencyinterrupts.rst:
Replace link to the CWIKI Nested Interrupts page with link to the
above.
[1] https://cwiki.apache.org/confluence/display/NUTTX/Nested+Interrupts
2023-05-19 23:20:43 +08:00
Nathan Hartman
33bf661413
Documentation: Improve "High Performance, Zero Latency Interrupts"
...
* Documentation/guides/zerolatencyinterrupts.rst:
Add paragraph that defines jitter. Fix a few minor typos. Fix
incorrect reStructuredText formatting for bulletpoints (they were
being rendered like 2nd level bulletpoints).
* Documentation/guides/index.rst:
Add zerolatencyinterrupts.rst to the TOC, which I forgot to do in PR
# 9302.
2023-05-19 10:22:50 +08:00
Nathan Hartman
242127556c
Documentation: Add "High Performance, Zero Latency Interrupts"
...
* Documentation/guides/zerolatencyinterrupts.rst: New. This document is
converted from CWIKI (see [1]) to reStructuredText and brought into
the Documentation tree in the repo.
[1] https://cwiki.apache.org/confluence/display/NUTTX/High+Performance%2C+Zero+Latency+Interrupts
2023-05-17 02:23:19 +08:00
Tiago Medicci Serrano
5a1efdecfd
documentation: add references to RTP Tools' defconfigs
...
Added examples of using the RTP Tools (`rtpdump`, in particular)
to receive RTP packets and 1) print the data and/or 2) playback
audio content through I2S.
2023-05-03 07:57:11 +02:00
Lucas Saavedra Vaz
c961edbe6c
Documentation: Fix compilation warnings
2023-03-25 12:23:35 +02:00
Alan Carvalho de Assis
dd0f389e72
doc: Add guide how to use QEMU and GDB to debug NuttX
...
This guide is based on steps from this issue:
https://github.com/apache/nuttx/issues/8616
2023-02-26 01:14:41 +08:00
yinshengkai
55ce5d0511
note: remove SCHED_INSTRUMENTATION_HIRES
...
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
2023-02-23 22:30:07 +08:00
chao an
ee1e1108a7
drivers/note: fix build break by note rename change
...
Regression by:
| commit ee24396d77
| Author: Xiang Xiao <xiaoxiang@xiaomi.com>
| Date: Tue Feb 14 01:11:48 2023 +0800
|
| drivers/note: Change DRIVER_NOTExxx to DRIVERS_NOTExxx
|
| follow other driver config style
|
| Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Signed-off-by: chao an <anchao@xiaomi.com>
2023-02-20 16:19:57 +08:00
Jackson R
491c3b564f
Repeated Command "sudo port install"
...
The merged code had Repeated Command.
2023-02-16 14:09:50 +08:00
Jackson R
37db965cff
This simulator was tested on ARM MacBook.
...
Updating Simulator for macOS
macOS requires genromfs and X11 Libraries to run Simulators.
* Added instructions to install genromfs
* Added instructions to install X11
Adding Xorg Server
The linker was unable to identify the location of X11 libraries.
removed -L/opt/X11/lib from ln 145
Updating Changes to streamline with other Hosts
2023-02-16 09:27:54 +08:00
Alan Carvalho de Assis
8564b49469
doc: Add USB RNDIS tutorial to documentation.
2023-01-29 10:09:13 +08:00
yinshengkai
dd32eccfc3
drivers/note: Move taskname related functions to note_driver.c
...
so all note drivers can retrieve the task name even after the task exit
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
2022-12-26 15:03:57 +08:00
Alan Carvalho de Assis
3d016db226
Doc: Fix ping to external IP on simulator
2022-12-23 00:32:10 +08:00
TimJTi
83c76eaa93
Documentation file typo's corrected
...
Correct "Nuttx" to "NuttX"
2022-10-13 18:26:17 +08:00
TimJTi
538365e362
Documentation for Custom Boards and Apps
2022-10-12 14:56:31 -03:00