Commit Graph

2059 Commits

Author SHA1 Message Date
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
Adam Feuer
8e56cf8d92 added hyperlinks to supported platforms page
- and fixed formatting in detailed support to
  enable hyperlinks to section headers

Squashed commit of the following:

commit 59e31d2ac13255f35f21d49c407494af23f16f6e
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 19:01:58 2020 -0700

    removed formatting |br|s, will use css

    - to line up columns

commit bcee59a14180bad6823e82990be52bc626e85911
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 18:55:57 2020 -0700

    remove migration not complete message

commit bc23b19ef65bdc13f3df04aae1693c61aa4abe04
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 18:16:07 2020 -0700

    table formatting adjustments

commit c6fdc907825a31218d2bdcbe1c1079e197779f02
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 16:03:07 2020 -0700

    fixing table formatting

commit c84d5e41a553e7a108b23d610e71f41ff6f5b751
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:35:16 2020 -0700

    trying to fix table formatting

commit 0d036dd2f309ad93f31a43c7f668befb6032c458
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:28:02 2020 -0700

    hyperlinks for supported boards for TI

commit e30840123f6ec2e7edb8335a165f9527919fefcc
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:13:40 2020 -0700

    links for supported boards by manufacturer - STM32

commit 7b5faf61901fc0fc3b945dbda4697a2d3f266126
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 14:13:18 2020 -0700

    supported boards by manufacturer hyperlinks nxp

    - nxp/freescale

commit 34c5c9b15908ffea7f8467c709fd0a5379e950ae
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 13:52:18 2020 -0700

    hyperlinks for supported boards by manufacturer

    - up to atmel

commit 351718d5edbb7b736067cfcb74270992fcc55102
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sat Aug 15 20:57:38 2020 -0700

    add hyperlinks for supported platforms by cpu core
2020-08-24 10:29:55 -07:00
Matias N
d9be1dffab add basic support for multiple versions 2020-08-24 10:29:55 -07:00
Matias N
3f723a247d add basic documentation contributing guidelines 2020-08-24 10:29:55 -07:00
Matias N
76637cbf32 complete improving presentation of sections 2020-08-24 10:29:55 -07:00
Matias N
b3a269b957 fix link 2020-08-24 10:29:55 -07: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
2fb9910b01 backport SocketCAN documentation to new docs (PR #1533) 2020-08-24 10:29:55 -07:00
Matias N
6bcbbc3b28 backport watchdog API changes to new documentation (PRs: #1534 #1545 and #1565) 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00
Matias N
6d89ae8fc7 move last content from old docs to new docs; remove old docs 2020-08-24 10:29:55 -07:00
Matias N
71021575fc convert acronyms.txt to glossary.rst 2020-08-24 10:29:55 -07:00
Matias N
5e1dab36c6 sphinx doc 2020-08-24 10:29:55 -07:00
Xiang Xiao
acca9fcc3b sched/wdog: Remove MAX_WDOGPARMS and related stuff
since the variable arguments are error prone and seldom used.

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-08-14 08:19:50 -06:00
Xiang Xiao
a0ce81d659 sched/wdog: Don't dynamically allocate wdog_s
to save the preserved space(1KB) and also avoid the heap overhead

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: I694073f68e1bd63960cedeea1ddec441437be025
2020-08-11 12:28:55 -06:00
Xiang Xiao
4c706771c3 sched/wdog: Replace all callback argument from uint32_t to wdparm_t
and alwasy cast the argument of wd_start to wdparm_t

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-08-08 17:30:26 -03:00
Peter Van Der Perk
974787270c Added SocketCAN Device driver porting guide 2020-08-07 13:14:30 -06:00
Xiang Xiao
e1ecb3e27c libc: Don't define localtime[_r] to macro when CONFIG_LIBC_LOCALTIME not define
since libc++ declare these function in ctime by:
using ::localtime[_r];

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: Ic0bb68b44c0cab838ab7cc34baee2aaa3ca8a9b5
2020-07-19 19:35:21 -07:00
Xiang Xiao
d6827cab60 arch: up_assert shouldn't call exit directly
since exit will be only callable from userspace and change
the 1st argument from "const uint8_t *" to "const char *"

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: I86487d57210ab63109148232da71dbc4d60a563b
2020-07-19 01:21:36 +01:00
Xiang Xiao
49020acfdc boards: Remove the unused CONFIG_xxx_CXXINITIALIZE=y
since cxx initialization is controlled by CONFIG_HAVE_CXXINITIALIZE now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: I39438dc3006d0a0b810052ecef50cd3c92f09d83
2020-07-01 10:41:37 -06:00
Nathan Hartman
72a06a6cc7 Docs and README: Add STM32G474, B-G474E-DPOW1 board
Documentation/NuttX.html:
    Documentation/README.html:
    README.txt:
    boards/README.txt:

        Document initial support for the STM32G474 MCU and
        B-G474E-DPOW1 Discovery kit was added in NuttX-9.1.
2020-06-22 09:43:41 -06:00
Xiang Xiao
b4bd9427f7 arch: Rename _exit to up_exit to follow the naming convention
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: I2779a2a3ccb5426fe78714fdcc629b8dfbb7aaf6
2020-06-04 22:20:45 +01:00
Gregory Nutt
82debdc213 Make task_init() and task_activate() internal OS functions.
-Move task_init() and task_activate() prototypes from include/sched.h to include/nuttx/sched.h.  These are internal OS functions and should not be exposed to the user.
-Remove references to task_init() and task_activate() from the User Manual.
-Rename task_init() to nxtask_init() since since it is an OS internal function
-Rename task_activate() to nxtask_activate since it is an OS internal function
2020-05-25 23:54:45 +01:00
Gregory Nutt
611aa8b998 Documentation/NuttXCCodingStandard.html: Fix description of comments on the right.
Documentation/NuttXCCodingStandard.html:
  - Fix a typo:  "be aligned so that the comment begins in the same comment on each line." Of course that should have been column.
  - Update a coding standard requirement.  With regard to Comments to the Right of Statements, the document said:  "If such comments are used, they should ... fit on one line."  This is not true any more.  In common practice (include the checks in nxstyle), comments to the right of statements may be continued in the following line.  The standard way of continuing such comments was also documented.
    In this case the coding standard actually contradicted iteself since first it says the that the comments to the right must fit on one line, but later illustrates (without description) how to continue a long right hand comment on the following line.

Documents/style.css:  It appears that a variable width font was being used for <pre> and <code>, that was really screwing up the presentation, especially in the coding standared where there are many examples illustrating correct vertical alignment.  The font type "Bitstream Vera Sans Mono" was replaced with "courier" for <pre> and <code>
2020-05-20 11:19:24 +08:00
Xiang Xiao
7faf3c0254 build: replace ${TOPDIR} with $(TOPDIR) in Makefile
make the usage consistence

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-05-19 19:23:18 +01:00
Xiang Xiao
517974787f Rename clock_systime[r|spec] to clock_systime_[ticks|timespec]
follow up the new naming convention:
https://cwiki.apache.org/confluence/display/NUTTX/Naming+of+OS+Internal+Functions
2020-05-10 14:35:50 -06:00