This is an automated email from the ASF dual-hosted git repository. acassis pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 5e79a954603bd36614025016dd36d78be7a60835 Author: Vinicius May <[email protected]> AuthorDate: Mon Oct 12 19:22:00 2026 +0200 Documentation: remove statements about work that is not merged yet. Two paragraphs of the front page and one sentence of os/index, added in f6ecf80ebb, describe the larger version of that change, before its scope was reduced during review. The front page and os/index say each subsystem is described once, but reference/os/{smp,shm,paging} are still there, so those topics have two pages. The front page also says board pages and tags are checked against the source tree and the build fails when they disagree; that check is not in master. Remove them, and change "Four ideas" to "Two ideas" on the front page to match what is left. They can come back with the changes that make them true. Assisted-by: Claude Code:claude-opus-5-5 Signed-off-by: Vinicius May <[email protected]> --- Documentation/index.rst | 15 +-------------- Documentation/os/index.rst | 3 +-- 2 files changed, 2 insertions(+), 16 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index fb9abebc393..e1d8383ea09 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -82,7 +82,7 @@ Working on NuttX How this documentation is organised =================================== -Four ideas decide where anything goes. They are written down here because +Two ideas decide where anything goes. They are written down here because knowing them turns "where do I look?" into a question with an answer -- and, for anyone writing documentation, "where do I put this?" as well. @@ -113,19 +113,6 @@ search: - *What may I call?* - What ``sched_setscheduler()`` takes and returns -**OS Design follows the source tree.** Each top level directory of NuttX -- -``sched/``, ``fs/``, ``net/``, ``mm/``, ``drivers/`` -- is a section, and -each subsystem is described once, going from what it is, to how it works, to -the interfaces it offers. That is why there is one page about SMP rather -than three, and why a contributor knows which page to add to. - -**What can be derived is derived, and checked.** Board pages, the -architecture and chip each one is filed under, and the tags that let you -search for them all come from the source tree rather than being typed by -hand, and the build fails when the two disagree. A page describing a board -that no longer exists, or a board with no page, does not survive the next -pull request. - .. note:: Something wrong on a page, or missing? The documentation lives in the same repository as the code, and every page has an *Edit on GitHub* link diff --git a/Documentation/os/index.rst b/Documentation/os/index.rst index 2a8a39cde21..c485cdb5105 100644 --- a/Documentation/os/index.rst +++ b/Documentation/os/index.rst @@ -5,8 +5,7 @@ OS Design How NuttX is put together, subsystem by subsystem. The sections follow the source tree: what lives under ``sched/`` is described in :doc:`scheduling/index`, what lives under ``fs/`` in :doc:`filesystem/index`, under ``drivers/`` in -:doc:`drivers/index`, and so on. Each subsystem is described once, going -from what it is, to how it works, to the interfaces it offers. +:doc:`drivers/index`, and so on. For the POSIX interface an application sees, go to :doc:`/reference/user/index` instead. That is a different question -- what
