Commit Graph

2084 Commits

Author SHA1 Message Date
Matias N
d312eb49f8 docs: reduce main content max width from 1200px to 1000px 2021-03-26 23:41:45 -05:00
Matias N
653bbdedec Documentation: add ESP32 and DevKitC docs 2021-03-25 19:44:24 -07:00
Matias N
75b13c8353 documentation: improve boardctl() docs 2021-03-25 19:03:49 -03: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
raiden00pl
8bf3c5efb9 boards/stm32: add initial support for b-g431b-esc1 board 2021-03-20 21:07:20 -03:00
Jiuzhu Dong
59eb4fa8d6 fs: delete NFILE_DESCRIPTORS for allocating dynamically
Change-Id: Id06d215063796d222b9792d25ab2d6742167729f
Signed-off-by: Jiuzhu Dong <dongjiuzhu1@xiaomi.com>
2021-03-17 06:46:42 -07:00
Byron Ellacott
c9db653c8d symtabs: improve handling of symbol lookups
When CONFIG_SYMTAB_ORDEREDBYNAME is selected most code will use
the ordered search function. When it is not selected no code will
use the ordered search function. This change merges the two
functions and varies its behaviour based on the config setting,
such that all callers can simply call the one search function
and get the best behaviour.

An additional configuration option allows leading underscores to
be stripped from symbols being relocated in loaded objects. This
allows toolchains which prefix C symbol with underscores to make
loadable ELF objects.
2021-03-16 10:18:17 -07:00
Xiang Xiao
c047c1412f Remove all gap8(risc-v) arch and board source code
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-03-11 10:51:11 -08:00
Xiang Xiao
c54d617f2c Remove nr5m100(risc-v) arch and board source code
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-03-11 10:51:11 -08:00
Jiuzhu Dong
3c0354aba6 net/socket: delete config CONFIG_NSOCKET_DESCRIPTORS
N/A

Change-Id: I7d10ec460c351e4fbcdc19b3a8284dcb77073722
Signed-off-by: Jiuzhu Dong <dongjiuzhu1@xiaomi.com>
2021-03-03 19:01:41 -08:00
Alan C. Assis
30468a34dd Fix Ubuntu name and use Windows in upper case 2021-02-07 22:10:48 -08:00
Matias N
f63c189a17 Documentation: document nRF52832 Sparkfun board (improve MDK board a bit) 2021-02-07 17:04:08 -03:00
Matias N
87596d74dd Documentation: introduce hardware platforms documentation 2021-02-07 08:38:51 -03:00
Huang Qi
073912e232 Replace all wget with curl
wget is missing from some system (like macOS and Windows native),
it's better to use curl to simplify build environment.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2020-12-22 03:36:10 -06:00
Sara Souza
071cfceed6 Update Documentation/components/drivers/character/watchdog.rst 2020-12-18 04:07:07 -08:00
David Sidrane
8de9cba43b Update Documentation/components/drivers/character/watchdog.rst 2020-12-18 03:35:54 -08:00
saramonteiro
48b5ac3ec0 Apply suggestions from code review
Co-authored-by: David Sidrane <David.Sidrane@Nscdg.com>
2020-12-18 03:35:54 -08:00
Sara Souza
4029c315f0 Apply 1 suggestion(s) to 1 file(s) 2020-12-18 03:35:54 -08:00
Sara Souza
51a6665925 Apply 1 suggestion(s) to 1 file(s) 2020-12-18 03:35:54 -08:00
Sara Souza
e049afc2a1 Documentation: how to use auto monitor feature to keep the chip alive 2020-12-18 03:35:54 -08:00
Abdelatif Guettouche
452b52a61e boards/xtensa/esp32/common: Fix functions' descriptions.
Signed-off-by: Abdelatif Guettouche <abdelatif.guettouche@espressif.com>
2020-12-10 12:31:17 -06:00
raiden00pl
0c05f2ea38 stm32: add stm32g43x support and nucleo-g431rb board 2020-12-09 09:43:25 -03:00
Matias N
1e7c13dba3 Documentation: merge quickstart with the rest of "getting started" 2020-12-05 21:43:35 -06:00
Matias N
9c83b407b4 Documentation: re-enable prev, next buttons 2020-12-05 21:43:35 -06:00
Michal Lenc
2de4b68389 Docs and README: Add Teensy-4 BSP
Signed-off-by: Michal Lenc <lencmich@fel.cvut.cz>
2020-12-04 10:18:41 -08:00
Matias N
a59c7744f8 Documentation: support versioned docs 2020-11-26 10:58:44 -08:00
Matias N
c91939b5c0 Documentation: improve debugging section 2020-11-24 22:02:49 +01:00
Matias N
d118249566 Documentation: remove empty releases section; put reference up higher 2020-11-21 18:09:19 -08:00
Matias N
3aacc506dc Documentation: various improvements to quickstart section 2020-11-21 18:09:19 -08:00
Matias N
ce146e91ef Documentation: remove empty subheading 2020-11-21 18:09:19 -08:00
Matias N
c6270b552b Documentation: remove TODO 2020-11-21 18:09:19 -08:00
Matias N
31f77461b3 Documentation: reorder introduction in index 2020-11-21 18:09:19 -08:00
Matias N
206402c7e0 Documentation: add TODO 2020-11-21 18:09:19 -08:00
Matias N
2c2f2bc795 Documentation: improve menuselection tag appearance 2020-11-21 18:09:19 -08:00
Diego Herranz
3956787254 Documentation/components/drivers/character/pwm: fix pwm.c location
- pwm.c was moved in 68bbc8438c but the
documentation wasn't updated.
- Also a minor typo fixed.
2020-11-17 22:11:08 +01:00
Sara Souza
8a1960fdf4 Documentation for Watchdog Timer Driver 2020-11-09 08:06:10 -08:00
Nakamura, Yuuichi
08ad202dfb Update task trace document 2020-11-02 01:12:08 -08:00
Yoshinori Sugino
c13f869432 Modify SIGSTP to SIGTSTP
Follow the POSIX description.
SIGTSTP should be sent when the Ctrl-Z characters is encountered, not SIGSTP.

Testing:
Built with hifive1-revb:nsh (CONFIG_SERIAL_TERMIOS=y, CONFIG_SIG_DEFAULT=y and CONFIG_TTY_SIGTSTP=y)
2020-10-29 01:12:43 -07:00
Matias N
aabb30a103 documentation: change non-working URL 2020-10-25 12:25:34 -03:00
Brennan Ashton
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
Brennan Ashton
c412021904 Docs: Bump version of pygments to get new GAS lexer
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-22 10:22:11 -03:00
Diego Herranz
c0719b370d Documentation/quickstart/debugging: rewrite SWD sentence
Original content rather than copy-paste from Wikipedia.
Discussed on https://github.com/apache/incubator-nuttx/pull/2031
2020-10-21 17:09:42 +08:00
Diego Herranz
345f2a7731 Documentation/quickstart/debugging.rst: fix NuttX capitalisation 2020-10-21 13:57:56 +08:00
Diego Herranz
b482cbdd04 Documentation/quickstart/debugging.rst: rewrite JTAG/OpenOCD section
- Add mentions to SWD
- Sony's OpenOCD fork no longer needed since Nuttx support was merged upstream
on http://openocd.zylin.com/#/c/4103/. Recommended to build from source or use
one of the unofficial, more recent builds.
- Amazon link for Olimex adapter was no longer available so removed.
- Reordered and some parts rewritten
2020-10-21 13:57:56 +08:00
Nakamura, Yuuichi
d8d19911ef Add SCHED_INSTRUMENTATION_HIRES support 2020-10-21 00:33:10 +08:00
Nakamura, Yuuichi
e1b9c278f8 Update trace command document 2020-10-21 00:31:51 +08:00
Xiang Xiao
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
Xiang Xiao
a49a3eae51 tools: Remove the special handle for Ubuntu under Windows 10
since the Native Linux support could be reused for this case:
https://lists.apache.org/thread.html/r315682ed20bbeb2f1403cf592f892ef009274423189ffc5b3841a6a9%40%3Cdev.nuttx.apache.org%3E

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:48:19 -07:00
Xiang Xiao
e53779065e Documentation: Fix the broken link in introduction/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
652241a411 Documentation: Format introduction/supported_platforms.rst
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
8a7982bec0 Documentation: Change 32bit arch to 64bit arch
since NuttX support at least 64bit x86 and riscv now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
4f1f25b516 Documentation: Remove the wrong comment about 64bit sim
64bit sim is fully supported now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
55aff276ee Documentation: Reorder Documentation/index.rst
1.Move quickstart to first
2.Move boards after introduction
3.Move reference after guides

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
81465f659d Documentation: Move nsh/ to applications/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
9abe505726 Documentation: Move syslog.rst to components/drivers/special/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
155e98d42c Documentation: Move socketcan.rst to components/drivers/special/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
302d4da341 Documentation: Move note.rst to components/drivers/character/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
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
Diego Herranz
f10261f32f Documentation/quickstart/debugging: fix micro-ros tutorial link 2020-10-18 12:22:54 -04:00
Diego Herranz
9c43ca3d82 Documentation/components/nsh/login.rst: fix a couple of repo links manually
They may have been malformed or the path changed at some point
2020-10-18 12:22:54 -04:00
Diego Herranz
77160c7a32 Documentation: replace bitbucket links with github ones
bitbucket.org/nuttx/nuttx/src/ replaced with github.com/apache/incubator-nuttx/blob/
2020-10-18 12:22:54 -04:00
Yoshinori Sugino
296eff3d40 Fix typos 2020-10-17 09:04:37 +01:00
Nakamura, Yuuichi
1472a913a9 Add documentation for note filters and task trace guides 2020-10-16 10:13:15 +08:00
saramonteiro
d1f0c71d2c Update timer.rst 2020-10-15 19:09:26 -03:00
saramonteiro
b0416202f6 Update timer.rst 2020-10-15 19:09:26 -03:00
saramonteiro
8c4553693b Documentation for the Timer Driver 2020-10-15 19:09:26 -03:00
Nathan Hartman
80ce7800a9 Sources and Docs: Fix typos and nxstyle issues
Documentation/contributing/coding_style.rst:

    * Fix repeated words: ("this this").
    * Remove trailing spaces.

boards/z80/z80/z80sim/README.txt:

    * Fix repeated words: ("this this") and rewrap lines.

graphics/Kconfig,
libs/libc/math/Kconfig:

    * Fix repeated words: ("this this").

arch/arm/src/armv7-a/arm_assert.c,
arch/arm/src/armv7-r/arm_assert.c,
arch/arm/src/imxrt/imxrt_enet.c,
arch/arm/src/kinetis/kinetis_enet.c,
arch/arm/src/kinetis/kinetis_flexcan.c,
arch/arm/src/s32k1xx/s32k1xx_enet.c,
arch/arm/src/s32k1xx/s32k1xx_flexcan.c,
arch/arm/src/stm32/stm32_pwm.c,
arch/arm/src/stm32h7/stm32_pwm.c,
arch/arm/src/stm32l4/stm32l4_pwm.c,
arch/renesas/src/rx65n/rx65n_usbdev.c,
binfmt/libnxflat/libnxflat_bind.c,
drivers/pipes/pipe_common.c,
net/igmp/igmp_input.c,
net/tcp/tcp_conn.c,
sched/sched/sched_roundrobin.c:

    * Fix typo in comment ("this this").

arch/arm/src/cxd56xx/cxd56_usbdev.c,
arch/arm/src/lc823450/lc823450_usbdev.c:

    * Fix typo in comment and rewrap lines.

arch/arm/src/imxrt/imxrt_usbdev.c,
arch/arm/src/stm32/stm32_dac.c,
arch/arm/src/stm32f0l0g0/stm32_pwm.c,
arch/arm/src/stm32f7/stm32_pwm.c,
arch/arm/src/tiva/lm/lm4f_gpio.h,
fs/nxffs/nxffs_write.c,
include/nuttx/analog/pga11x.h,
include/nuttx/usb/usbdev.h,
net/mld/mld_join.c:

    * Fix typo in comment ("this this").
    * Fix nxstyle issues.
2020-10-02 04:54:52 +02:00
Adam Feuer
d32abc164a updated readmes to reflect giant-board support
- also changed most Atmel references to Microchip
  since Microchip has acquired Atmel
2020-09-16 15:56:32 -06:00
Matias N
166242c171 use "export" to expose TOPDIR to all child make instead of passing it around every time 2020-09-15 21:11:33 -07:00
ligd
4d787db5bb Documentation: add gethrtime() API to "Clocks and Timers"
Change-Id: I97a75a14427bcada8a408ced6e0203dc3345f162
Signed-off-by: ligd <liguiding1@xiaomi.com>
2020-09-15 10:28:21 -03:00
Matias N
34b34e2d45 Fix: ensure archive files do not carry object files from prior builds
In some cases, when NuttX configuration changes and this makes the
object list used to build one of the .a libraries change as well,
since the command used to build it is "ar crs" and this simply appends
the list of object files, the library could still include object
files from prior builds. This commit modifies the ARCHIVE macro to
erase the .a file if it already exists.

Since in some cases this behavior was actually expected (object
files from a subdirectory were appended to a library created one
level above) I added a ARCHIVE_ADD which works as ARCHIVE did.

This change should greatly improve behavior of building after
configuration changes.
2020-09-14 15:54:18 +08:00
Matias N
5106c3fe3f documentation: make the "make clean" suggestion a warning 2020-09-12 19:28:24 -07:00
Matias N
94e1a9247c documentation: work on quickstart, add tabs sphinx extension 2020-09-12 19:28:24 -07:00
Matias N
7b965a25d8 Documentation: build documentation using sphinx -j option which parallelizes jobs 2020-09-12 00:43:22 +08:00
Xiang Xiao
b0797263ca libc/stdio: Allocate file_struct dynamically
1.Reduce the default size of task_group_s(~512B each task)
2.Scale better between simple and complex application

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: Ia872137504fddcf64d89c48d6f0593d76d582710
2020-09-11 17:58:17 +08:00
Adam Feuer
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
Matias N
44cee3f211 documentation: split device drivers sections into individual documents 2020-09-06 10:58:12 -03:00
Adam Feuer
b88038a1e1 add quickstart docs from NuttX Companion
- with suggested edits from PR feedback
2020-09-04 20:03:49 -03:00
Adam Feuer
ce604692db deleted section on copying driver code
- changed to "use for inspiration only"
2020-09-04 20:02:30 -03:00
Adam Feuer
7632b4d716 formatting fixes 2020-09-04 20:02:30 -03:00
Adam Feuer
8cd8adb5d9 removed alternative rename and merge flow 2020-09-04 20:02:30 -03:00
Adam Feuer
c1eb911814 removed text about interactive rebase 2020-09-04 20:02:30 -03:00
Adam Feuer
dcf32363c2 fixed copy-paste error in sim 2020-09-04 20:02:30 -03:00
Adam Feuer
5ec5a99631 heading level fix 2020-09-04 20:02:30 -03:00
Adam Feuer
341f496226 PR feedback changes 2020-09-04 20:02:30 -03:00
Adam Feuer
d3414178ae added docs for rebase flow 2020-09-04 20:02:30 -03:00
Adam Feuer
b85fcd7566 PR feedback changes 2020-09-04 20:02:30 -03:00
Adam Feuer
56b89a89f2 add sim and drivers guides, contributing workflow 2020-09-04 20:02:30 -03:00
Matias N
2120eed84f documentation: fix build warning 2020-09-02 13:16:24 -07:00
Brennan Ashton
572be4d74d Docs: Clean up installation requirements and only support pipenv
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-09-02 17:12:32 -03:00
Matias N
9b08cf945f documentation: address various duplicate declarations 2020-09-02 16:00:08 +08:00
Brennan Ashton
4cb193d530 Docs: Update links to old website and wiki
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-08-30 19:16:30 -03:00
Adam Feuer
d655f47d13 convert INVIOLABLES.txt to markdown, add to docs 2020-08-25 16:03:42 -07:00
Matias N
cf3ecdd31b doc: add .python-version to .gitignore 2020-08-25 12:54:24 -07:00
Matias N
f8207ded75 doc: remove todo 2020-08-25 12:54:24 -07:00
Matias N
8d5d5502bc documentation: switch to m2r2 for Markdown support; update requirements.txt 2020-08-25 12:54:24 -07:00
Matias N
407667480a doc: fix typo on contribution workflow 2020-08-24 10:29:55 -07:00
Matias N
1f53dd0e0e documentation: add license headers to various files 2020-08-24 10:29:55 -07:00
Matias N
896ba15f01 support specifying top alignment for tables 2020-08-24 10:29:55 -07:00
Matias N
911cc3f0ea fix wrong "todo" placement 2020-08-24 10:29:55 -07:00