Commit Graph

35 Commits

Author SHA1 Message Date
Brennan Ashton
14d311ca0a docs: Add copy button for code blocks 2023-05-20 12:58:32 +08:00
Hiroki Noda
cc2b0e2594 Documentation/quickstart: update link for USBIP in WSL2 2023-03-20 08:58:14 +01:00
Alan Carvalho de Assis
b216f74a4b doc: Add xxd to get romfs working, reported by Simon Filgis 2023-02-24 21:53:48 +08:00
simbit18
7cfeccee92 Doc organization.rst
update tip incorrect permalink
2023-02-22 01:05:30 +08:00
chao an
73214965b8 Documentation/kconfiglib: update document to support kconfiglib
Signed-off-by: chao an <anchao@xiaomi.com>
2023-02-20 14:35:06 +08:00
Xiang Xiao
a64c61f530 Remove incubat.* from the code base
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2022-12-13 21:21:27 +02:00
Nathan Hartman
03802dad13 NuttX graduated the Incubator; update repository links 2022-11-26 11:58:15 -08:00
Meco Man
6ad06b0c2b [docs] eliminate potential misunderstandings 2022-03-17 02:04:05 +08:00
simbit18
1e7e1cad0b Update install.rst
updade tip
2022-03-07 23:51:48 +08:00
Alan C. Assis
b248dd0d3a Documentation: Fix openocd command instruction
A user reported me an issue while following our documentation
then looking his command line error I noticed the openocd stlink
interface was wrong: st-link-v2.cfg -> stlink-v2.cfg
2021-11-04 15:09:34 +01:00
Alan C. Assis
eaf50cd06b Doc: Update download version to 10.1 and fix tar command 2021-09-17 07:53:57 -07:00
Gustavo Henrique Nihei
bf1d587063 Documentation: Update kconfig-frontends install instructions
It still assumed kconfig-frontends as part of the core NuttX
repository.
2021-06-10 18:27:41 -04:00
Nathan Hartman
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
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
Alan C. Assis
30468a34dd Fix Ubuntu name and use Windows in upper case 2021-02-07 22:10:48 -08: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
Matias N
1e7c13dba3 Documentation: merge quickstart with the rest of "getting started" 2020-12-05 21:43:35 -06:00
Matias N
c91939b5c0 Documentation: improve debugging section 2020-11-24 22:02:49 +01:00
Matias N
3aacc506dc Documentation: various improvements to quickstart section 2020-11-21 18:09:19 -08: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
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
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
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
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
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
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
Adam Feuer
b88038a1e1 add quickstart docs from NuttX Companion
- with suggested edits from PR feedback
2020-09-04 20:03:49 -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