Commit Graph

23 Commits

Author SHA1 Message Date
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
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
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
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
Alan Carvalho de Assis
8564b49469 doc: Add USB RNDIS tutorial to documentation. 2023-01-29 10:09:13 +08:00
TimJTi
538365e362 Documentation for Custom Boards and Apps 2022-10-12 14:56:31 -03:00
Michal Lenc
c456b15916 Documentation: add guide for pysimCoder integration with NuttX
This commit adds documentation for compiling NuttX for pysimCoder and
then running pysimCoder designed applications on NuttX. PysimCoder is
a Rapid Control Application Development Tool that can transfer block
diagrams into C code and can be used in real time control applications.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2021-08-11 18:04:09 +02:00
Flavio Alves
bbdec3c4f4 Adding example to build cmake projects in NuttX
Section adjustments

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Reviewed introduction to the document

Add the motivation for writing the document.

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Adding caption and name for files

Correcting caption

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

test: Separating the file from the document

Revert "test: Separating the file from the document"

This reverts commit beec4788bdb574d9c99f1817b7ffe6e90a18fe46.

Removing captions

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>
2021-03-23 06:41:16 -07:00
Nakamura, Yuuichi
1472a913a9 Add documentation for note filters and task trace guides 2020-10-16 10:13:15 +08:00
Adam Feuer
56b89a89f2 add sim and drivers guides, contributing workflow 2020-09-04 20:02:30 -03:00
Matias N
4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00