OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
56,050 Commits 18 Branches 185 Tags 383 MiB
Commit Graph

34 Commits

Author SHA1 Message Date
Ludovic Vanasse 40c5e793b6 Documentation: Clarifying the workflow of building the documentation 
Remove navigating to the Documentation folder in the section description
for building the documentation, and add it to the first building steps.
Also remove the command to `cd Documentation` in the second steps, which
is necessary to properly install the dependencies to build the
documentation.
 2024-09-30 08:34:34 +08:00
Alan Carvalho de Assis b998afdc04 doc: Fix Documentation build procedure 
User reported an issue caused by not clear documentation:
https://github.com/apache/nuttx/issues/13232
 2024-08-30 23:18:32 +08:00
Filipe Cavalcanti 9b253ee165 Created pre-commit config file 2024-08-19 21:40:56 +02:00
Alin Jerpelea f6400303df doc: improve commit log examples 
The releasenotes tools can use proper commit titles and
automate commit sorting

Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
 2024-07-24 21:54:09 +08:00
Alan Carvalho de Assis 42c9a829da doc: Include commit log examples 
The Documentation was missing the commit log message examples

Signed-off-by: Alan C. Assis <acassis@gmail.com>
 2024-07-24 09:52:40 +08:00
Michal Lenc 784aa526b1 documentation/contributing: remove copyright notice in file header 
Copyright notice and author contact/information should not be included
in file header anymore. Only standard Apache 2.0 licensing information
should be used.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
 2023-11-07 01:01:18 +08:00
raiden00pl b7f94fbf22 Documentation: various cosmetic changes 2023-10-30 20:29:54 +08:00
raiden00pl ce97fccf9a Documentation: split some long lines 2023-10-30 20:29:54 +08:00
chao an 664927c86e mm/alloc: remove all unnecessary cast for alloc 
Fix the minor style issue and remove unnecessary cast

Signed-off-by: chao an <anchao@xiaomi.com>
 2023-08-30 14:34:20 +08:00
Alan Carvalho de Assis 9eea82a61d Doc: Explain how to rebase and squash PR's commits 2022-12-19 10:31:12 +08:00
Nathan Hartman 03802dad13 NuttX graduated the Incubator; update repository links 2022-11-26 11:58:15 -08:00
Xiang Xiao 1d1bdd85a3 Remove the double blank line from source files 
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-02-20 20:10:14 +01:00
Cocoacrumbs 2d4906ab9b Small clarification in the making-changes.rst documentation. 2021-11-02 20:22:18 +01: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
Nathan Hartman c869bc5348 docs and comments: Update stale references to COPYING 
Since 7a046358d9 the top-level COPYING
file has been deleted and replaced by DISCLAIMER, LICENSE, and NOTICE
files. However, some references to the old COPYING file remained in
Kconfig help text and documentation.

Documentation/contributing/coding_style.rst:
Documentation/introduction/about.rst:
boards/arm/lpc17xx_40xx/olimex-lpc1766stk/README.txt:
boards/arm/sam34/arduino-due/README.txt:
boards/arm/sam34/sam4l-xplained/README.txt:
boards/arm/sama5/giant-board/README.md:
boards/arm/sama5/sama5d2-xult/README.txt:
boards/arm/sama5/sama5d4-ek/README.txt:
boards/arm/samd2l2/samd20-xplained/README.txt:
boards/arm/samd2l2/samd21-xplained/README.txt:
boards/arm/samd2l2/saml21-xplained/README.txt:
boards/arm/stm32/hymini-stm32v/README.txt:
boards/arm/stm32/stm3210e-eval/README.txt:
fs/fat/Kconfig:
libs/libc/string/Kconfig:

    * Updates stale references to the old top-level COPYING file to
      either LICENSE or NOTICE (or both), as appropriate in each
      instance.
 2021-04-01 21:10:56 -05:00
Matias N 33aafe8e7f doc: mention sphinx-autobuild in contributing section 2021-03-26 23:41:45 -05: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
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
Matias N 94e1a9247c documentation: work on quickstart, add tabs sphinx extension 2020-09-12 19:28:24 -07: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 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
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 f8207ded75 doc: remove todo 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 911cc3f0ea fix wrong "todo" placement 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 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