Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-10-08 06:45:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
63695 commits 24 branches 208 tags 552 MiB
Commit graph

37 commits

Author SHA1 Message Date
Vinicius May
f6ecf80ebb Documentation: brand new layout for NuttX documentation. 
The documentation grew one page at a time, so the tree follows the
history of who wrote what and not the shape of NuttX. Scheduling is
spread over three places, a driver page can sit above the subsystem
that owns it, and the front page lists everything at the same level.
That is a lot to face when all you want to know is where the scheduler
lives.

This change files every page under the code it describes. It is a move,
not a rewrite: outside the ten pages named below, every page keeps the
text that is already in master, and no page's text is deleted.

What it does:

* Groups the table of contents into nine chapters.
* Moves the OS subsystems under os/: scheduling, memory, drivers,
  filesystem, networking, IPC, interrupts, libs, time.
* Renames the platform pages to the names the source tree uses, and
  derives their tags from the tree instead of by hand.
* Splits guides/ by subject.
* Adds Documentation/redirects.py, with a rule for every page that left
  its old path, so old URLs keep working. The redirect page also carries
  a link's #anchor across to the new page.

Ten pages have text that is new or rewritten. Nine of them are the
landing page of a chapter, which has to exist for the new structure:

    index                  the front page
    os/index               OS Design
    os/scheduling/index    Scheduling
    os/interrupts/index    Interrupts
    os/ipc/index           IPC
    os/time/index          Time and timers
    about/index            About
    developing/index       Developing NuttX
    ReleaseNotes/index     Release notes

The tenth is os/libs/libbuiltin, the only page here with technical
content: libs/libbuiltin/ had no page at all. Five SVG diagrams come
with these pages, hand-written XML with no editor metadata.

Nothing outside Documentation/ is touched.

How it was checked:

* Sphinx builds with -W: no warnings, and no document left outside a
  toctree.
* A script, offered in the PR, proves the narrow claim this rests on.
  For every page outside the ten named above it erases what a move
  touches -- link target, path, tag line, toctree block, table border --
  from the whole old text and the whole new text, and requires the two
  to be byte for byte identical. It also requires every sentence of a
  deleted page to turn up somewhere, and every page that left its old
  path to have a redirect, from a URL that existed, to where its content
  went. It exits non-zero and names the page if any of that is not true,
  and it tests added pages too, so forgetting to declare one cannot make
  it pass.
* An independent audit checked 133 factual claims on these ten pages
  against the tree, one shell command per claim: 130 confirmed, 1
  refuted and fixed here, 2 not checkable.
* tools/checkpatch.sh is clean over the range.

The diff is large because moving a page changes every link that points
to it. Most of it is pure renames, and board pages that gained one tag
line.

Assisted-by: Claude:claude-opus-5
 2026-10-08 01:40:54 +08:00
raiden00pl
2d12ae442a boards/arm/stm32h5: add initial STM32H573I-DK support 
add initial STM32H573I-DK support

Assisted-by: Codex:GPT-6
Signed-off-by: raiden00pl <raiden00@railab.me>
 2026-10-06 16:36:40 -03:00
dependabot[bot]
5beb781f9b build(deps): bump anyio from 4.14.0 to 4.14.2 in /Documentation 
Bumps [anyio](https://github.com/agronholm/anyio) from 4.14.0 to 4.14.2.
- [Release notes](https://github.com/agronholm/anyio/releases)
- [Commits](https://github.com/agronholm/anyio/compare/4.14.0...4.14.2)

---
updated-dependencies:
- dependency-name: anyio
  dependency-version: 4.14.2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-09-20 18:04:41 -03:00
dependabot[bot]
57eed4d904 build(deps): bump starlette from 1.0.1 to 1.3.1 in /Documentation 
Bumps [starlette](https://github.com/Kludex/starlette) from 1.0.1 to 1.3.1.
- [Release notes](https://github.com/Kludex/starlette/releases)
- [Changelog](https://github.com/Kludex/starlette/blob/main/docs/release-notes.md)
- [Commits](https://github.com/Kludex/starlette/compare/1.0.1...1.3.1)

---
updated-dependencies:
- dependency-name: starlette
  dependency-version: 1.3.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-06-18 12:49:49 -04:00
dependabot[bot]
f8aa477b7a build(deps): bump starlette from 0.52.1 to 1.0.1 in /Documentation 
Bumps [starlette](https://github.com/Kludex/starlette) from 0.52.1 to 1.0.1.
- [Release notes](https://github.com/Kludex/starlette/releases)
- [Changelog](https://github.com/Kludex/starlette/blob/main/docs/release-notes.md)
- [Commits](https://github.com/Kludex/starlette/compare/0.52.1...1.0.1)

---
updated-dependencies:
- dependency-name: starlette
  dependency-version: 1.0.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-06-04 17:01:57 -04:00
dependabot[bot]
f657ea6031 build(deps): bump idna from 3.11 to 3.15 in /Documentation 
Bumps [idna](https://github.com/kjd/idna) from 3.11 to 3.15.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.md)
- [Commits](https://github.com/kjd/idna/compare/v3.11...v3.15)

---
updated-dependencies:
- dependency-name: idna
  dependency-version: '3.15'
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-05-20 13:13:59 -04:00
dependabot[bot]
f5689656c6 build(deps): bump urllib3 from 2.6.3 to 2.7.0 in /Documentation 
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.6.3 to 2.7.0.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](https://github.com/urllib3/urllib3/compare/2.6.3...2.7.0)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.7.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-05-12 02:45:27 -04:00
dependabot[bot]
4bfa4fa2e3 build(deps): bump pygments from 2.19.2 to 2.20.0 in /Documentation 
Bumps [pygments](https://github.com/pygments/pygments) from 2.19.2 to 2.20.0.
- [Release notes](https://github.com/pygments/pygments/releases)
- [Changelog](https://github.com/pygments/pygments/blob/master/CHANGES)
- [Commits](https://github.com/pygments/pygments/compare/2.19.2...2.20.0)

---
updated-dependencies:
- dependency-name: pygments
  dependency-version: 2.20.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-03-31 08:38:01 -03:00
dependabot[bot]
e7dc7f3f5e build(deps): bump requests from 2.32.5 to 2.33.0 in /Documentation 
Bumps [requests](https://github.com/psf/requests) from 2.32.5 to 2.33.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](https://github.com/psf/requests/compare/v2.32.5...v2.33.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-version: 2.33.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-03-27 09:45:36 +08:00
Matteo Golin
16aca58275 docs/plantuml: Add PlantUML support to Documentation build 
This commit adds support for PlantUML to the Documentation build
process. UML diagrams can be written in PlantUML syntax and then
rendered during the build process. Version control no longer needs to
track these UML diagrams as images, and we can modify them easily.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
 2026-02-15 08:47:23 +01:00
dependabot[bot]
69d4e4101f build(deps): bump urllib3 from 2.6.0 to 2.6.3 in /Documentation 
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.6.0 to 2.6.3.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](https://github.com/urllib3/urllib3/compare/2.6.0...2.6.3)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-version: 2.6.3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2026-01-08 09:05:02 +01:00
simbit18
5dfc4559a5 Documentation/Pipfile.lock: bump urllib3 from 2.2.3 to 2.6.0 
- bump urllib3 from 2.2.3 to 2.6.0

Signed-off-by: simbit18 <simbit18@gmail.com>
 2025-12-10 19:23:50 +08:00
dependabot[bot]
85f8304227 build(deps): bump tornado from 6.4.2 to 6.5.1 in /Documentation 
Bumps [tornado](https://github.com/tornadoweb/tornado) from 6.4.2 to 6.5.1.
- [Changelog](https://github.com/tornadoweb/tornado/blob/master/docs/releases.rst)
- [Commits](https://github.com/tornadoweb/tornado/compare/v6.4.2...v6.5.1)

Updates by cederom:
* keep python 3.8 for tornado as used by gh ci, dependabot updated to 3.9.

---
updated-dependencies:
- dependency-name: tornado
  dependency-version: 6.5.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2025-06-12 19:09:47 +08:00
Niccolò Maggioni
2d2defb8a0 docs: Fix pipenv lockfile for older Python versions 
CI uses Python 3.8

Signed-off-by: Niccolò Maggioni <nicco.maggioni+nuttx@gmail.com>
 2025-06-11 23:11:08 +08:00
Niccolò Maggioni
2399702a28 docs: Update the ELF guides 
Rewrite parts of the two ELF guides to use scripts included in the
export archive and modernize some deprecated tools and Bash idioms.

Also add the new sphinx_collapse extension to the docs build config.

Signed-off-by: Niccolò Maggioni <nicco.maggioni+nuttx@gmail.com>
 2025-06-11 23:11:08 +08:00
dependabot[bot]
52ac99126d Documentation: Bump docutils from 0.18.1 to 0.19 
This PR bumps the version of docutils from 0.18.1 to 0.19, as requested by dependabot:
- https://github.com/apache/nuttx/pull/14910
 2024-11-24 17:52:30 +08:00
dependabot[bot]
db24702fc5 build(deps): bump zipp from 3.16.2 to 3.19.1 in /Documentation 
Bumps [zipp](https://github.com/jaraco/zipp) from 3.16.2 to 3.19.1.
- [Release notes](https://github.com/jaraco/zipp/releases)
- [Changelog](https://github.com/jaraco/zipp/blob/main/NEWS.rst)
- [Commits](https://github.com/jaraco/zipp/compare/v3.16.2...v3.19.1)

---
updated-dependencies:
- dependency-name: zipp
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-07-10 03:36:22 +08:00
dependabot[bot]
d29875926e build(deps): bump certifi from 2024.2.2 to 2024.7.4 in /Documentation 
Bumps [certifi](https://github.com/certifi/python-certifi) from 2024.2.2 to 2024.7.4.
- [Commits](https://github.com/certifi/python-certifi/compare/2024.02.02...2024.07.04)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-07-06 11:31:19 +08:00
dependabot[bot]
eb860566bb build(deps): bump urllib3 from 2.2.1 to 2.2.2 in /Documentation 
Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.2.1 to 2.2.2.
- [Release notes](https://github.com/urllib3/urllib3/releases)
- [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst)
- [Commits](https://github.com/urllib3/urllib3/compare/2.2.1...2.2.2)

---
updated-dependencies:
- dependency-name: urllib3
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-06-18 09:36:06 +08:00
dependabot[bot]
c885ba7080 build(deps): bump tornado from 6.3.2 to 6.4.1 in /Documentation 
Bumps [tornado](https://github.com/tornadoweb/tornado) from 6.3.2 to 6.4.1.
- [Changelog](https://github.com/tornadoweb/tornado/blob/master/docs/releases.rst)
- [Commits](https://github.com/tornadoweb/tornado/compare/v6.3.2...v6.4.1)

---
updated-dependencies:
- dependency-name: tornado
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-06-07 10:12:04 +08:00
dependabot[bot]
29ace4e971 --- 
updated-dependencies:
- dependency-name: requests
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-05-21 19:39:07 +08:00
dependabot[bot]
4ffad2656e build(deps): bump jinja2 from 3.1.3 to 3.1.4 in /Documentation 
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.3 to 3.1.4.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.3...3.1.4)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-05-07 15:49:59 +08:00
dependabot[bot]
b5f4e1a1ae build(deps): bump idna from 3.4 to 3.7 in /Documentation 
Bumps [idna](https://github.com/kjd/idna) from 3.4 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](https://github.com/kjd/idna/compare/v3.4...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-04-12 10:05:14 +08:00
dependabot[bot]
86638b6a0e build(deps): bump jinja2 from 3.1.2 to 3.1.3 in /Documentation 
Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.2 to 3.1.3.
- [Release notes](https://github.com/pallets/jinja/releases)
- [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst)
- [Commits](https://github.com/pallets/jinja/compare/3.1.2...3.1.3)

---
updated-dependencies:
- dependency-name: jinja2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2024-01-11 21:38:34 -03:00
dependabot[bot]
f295ac6fb3 build(deps): bump certifi from 2023.5.7 to 2023.7.22 in /Documentation 
Bumps [certifi](https://github.com/certifi/python-certifi) from 2023.5.7 to 2023.7.22.
- [Commits](https://github.com/certifi/python-certifi/compare/2023.05.07...2023.07.22)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2023-07-25 18:06:14 -07:00
dependabot[bot]
d9ea87443e build(deps): bump requests from 2.30.0 to 2.31.0 in /Documentation 
Bumps [requests](https://github.com/psf/requests) from 2.30.0 to 2.31.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](https://github.com/psf/requests/compare/v2.30.0...v2.31.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2023-05-23 17:02:55 +08:00
Brennan Ashton
14d311ca0a docs: Add copy button for code blocks 2023-05-20 12:58:32 +08:00
Brennan Ashton
a4ca15aa3e CI/Documentation: livereload hash missmatch due to new wheel package upload. 2023-01-02 14:56:51 +08:00
dependabot[bot]
512be93c36 build(deps): bump certifi from 2022.9.24 to 2022.12.7 in /Documentation 
Bumps [certifi](https://github.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7.
- [Release notes](https://github.com/certifi/python-certifi/releases)
- [Commits](https://github.com/certifi/python-certifi/compare/2022.09.24...2022.12.07)

---
updated-dependencies:
- dependency-name: certifi
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
 2022-12-09 14:23:54 +08:00
Brennan Ashton
c9636f0b3e docs: Update dependencies and fix lint errors 2022-10-10 09:29:53 +08:00
Matias N
d3fe676d0a Documentation: update pipenv to include sphinx-autobuild 2021-04-07 22:34:33 +01: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
Matias N
94e1a9247c documentation: work on quickstart, add tabs sphinx extension 2020-09-12 19:28: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
Adam Feuer
d655f47d13 convert INVIOLABLES.txt to markdown, add to docs 2020-08-25 16:03:42 -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
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00
Renamed from doc/Pipfile.lock (Browse further)