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
ce20211357
Fix various typos in comments and documentation
...
Fix typos in these files:
* Documentation/components/drivers/character/foc.rst
* Documentation/guides/cpp_cmake.rst
* Kconfig
* arch/arm/src/imxrt/imxrt_lpspi.c
* arch/arm/src/kinetis/kinetis_spi.c
* arch/arm/src/kl/kl_spi.c
* arch/arm/src/lpc31xx/lpc31_spi.c
* arch/arm/src/nrf52/nrf52_radio.h
* arch/arm/src/s32k1xx/s32k1xx_lpspi.c
* arch/arm/src/stm32/Kconfig
* arch/arm/src/stm32/stm32_adc.c
* arch/arm/src/stm32/stm32_foc.c
* arch/arm/src/stm32/stm32_foc.h
* arch/arm/src/stm32/stm32_pwm.c
* arch/arm/src/stm32/stm32_spi.c
* arch/arm/src/stm32f0l0g0/stm32_spi.c
* arch/arm/src/stm32f7/Kconfig
* arch/arm/src/stm32f7/stm32_spi.c
* arch/arm/src/stm32h7/Kconfig
* arch/arm/src/stm32h7/stm32_allocateheap.c
* arch/arm/src/stm32h7/stm32_fmc.c
* arch/arm/src/stm32h7/stm32_fmc.h
* arch/arm/src/stm32h7/stm32_pwm.c
* arch/arm/src/stm32h7/stm32_qspi.c
* arch/arm/src/stm32h7/stm32_spi.c
* arch/arm/src/stm32l4/stm32l4_pwm.c
* arch/arm/src/stm32l4/stm32l4_spi.c
* arch/arm/src/stm32l5/Kconfig
* arch/arm/src/stm32l5/stm32l5_spi.c
* arch/renesas/src/rx65n/rx65n_dtc.c
* arch/renesas/src/rx65n/rx65n_usbdev.c
* arch/risc-v/src/rv32m1/rv32m1_serial.c
* boards/arm/stm32/b-g431b-esc1/src/stm32_foc.c
* boards/arm/stm32/nucleo-f103rb/src/stm32_foc_ihm07m1.c
* boards/arm/stm32/nucleo-f302r8/src/stm32_foc_ihm07m1.c
* boards/arm/stm32h7/nucleo-h743zi2/README.txt
* boards/risc-v/rv32m1/rv32m1-vega/README.txt
* boards/sim/sim/sim/scripts/Make.defs
* drivers/1wire/1wire.c
* drivers/1wire/1wire_internal.h
* drivers/lcd/Kconfig
* drivers/syslog/ramlog.c
* fs/fat/Kconfig
* libs/libc/debug/Kconfig
* libs/libc/machine/Kconfig
* libs/libc/stdio/lib_libvsprintf.c
* libs/libc/stdlib/lib_div.c
* libs/libc/stdlib/lib_ldiv.c
* libs/libc/stdlib/lib_lldiv.c
* libs/libdsp/lib_observer.c
2021-07-04 11:23:26 -05:00
26f09cec6d
Documentation: Fix a few typos.
...
* Documentation/contributing/documentation.rst
* Documentation/guides/tasktraceuser.rst
* Documentation/guides/drivers.rst
* Documentation/quickstart/running.rst
* Documentation/quickstart/compiling.rst
* Documentation/components/drivers/character/watchdog.rst
* Documentation/components/drivers/character/foc.rst
* Documentation/components/nxgraphics/nxtk.rst
* Documentation/applications/nsh/login.rst
* Documentation/introduction/detailed_support.rst
* Documentation/introduction/resources.rst
* Documentation/reference/user/01_task_control.rst
* Documentation/reference/os/wqueue.rst
Fix some misspelled words.
Many of these were caught by codespell.
2021-04-28 17:00:23 -03:00
4a75b41b4d
Documentation: Minor fixes
...
Documentation/guides/drivers.rst:
* Replace wrong "Ethernet" with "SD Card"
Documentation/platforms/arm/imxrt/index.rst:
* Fix misspelled "Supported"
Documentation/platforms/xtensa/esp32/index.rst:
* Fix doubled "also"
* Fix "the" -> "to"
Documentation/reference/os/index.rst:
* Fix doubled "also"
* Fix "also" -> "are"
2021-04-20 21:31:18 -05:00
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
08ad202dfb
Update task trace document
2020-11-02 01:12:08 -08:00
23cd1e030e
Docs: Fix broken links and references in docs
...
Also add to the CI a problem matcher to better report issues
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-22 10:22:11 -03:00
d8d19911ef
Add SCHED_INSTRUMENTATION_HIRES support
2020-10-21 00:33:10 +08:00
e1b9c278f8
Update trace command document
2020-10-21 00:31:51 +08:00
eb4121ce38
Change all 'Nuttx' to 'NuttX'
...
Unify the naming convention
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-20 01:45:06 -07:00
598e3eedb4
Documentation: Remove all tail spaces from *.rst and *.html
...
by the below command:
find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 10:51:22 -07:00
1472a913a9
Add documentation for note filters and task trace guides
2020-10-16 10:13:15 +08:00
d788b2e16c
fix bugs in quickstart docs
...
- change Gnu to GNU
- fix formatting and link fixes
- add menuconfig screenshot
- replaced config file edits with kconfig-tweak
- fix section numbering
- removed leftover todo in quickstart/index.rst
- rewrote debugging section to use menuconfig
2020-09-06 22:28:32 +01:00
ce604692db
deleted section on copying driver code
...
- changed to "use for inspiration only"
2020-09-04 20:02:30 -03:00
7632b4d716
formatting fixes
2020-09-04 20:02:30 -03:00
dcf32363c2
fixed copy-paste error in sim
2020-09-04 20:02:30 -03:00
b85fcd7566
PR feedback changes
2020-09-04 20:02:30 -03:00
56b89a89f2
add sim and drivers guides, contributing workflow
2020-09-04 20:02:30 -03:00
4a38a15332
convert TODOs to actual TODO banner and improve general presentation of different sections
2020-08-24 10:29:55 -07:00
4276d6254a
rename doc/ -> Documentation/
2020-08-24 10:29:55 -07:00
Michal Lenc