nuttx/nuttx-mirror
1
2
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2025-01-13 02:48:37 +08:00
Code Issues Projects Releases Packages Wiki Activity Actions

convert TODOs to actual TODO banner and improve general presentation of different sections

Browse source
This commit is contained in:
Matias N 2020-08-15 18:10:25 -03:00 committed by Brennan Ashton
parent 2fb9910b01
commit 4a38a15332
18 changed files with 248 additions and 182 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Documentation/applications/index.rst
View file

@ -1,6 +1,10 @@
.. todo::
Applications included in ``apps`` repo should be documented here. This should also include information
on how to create a given application.
Applications
============
.. note:: This is to be used to describe how applications work in NuttX as well as to ducment
existing ones.
NuttX ships a large number of applications covering a wide spectrum of functionality. These can be found in the `apps <https://github.com/apache/incubator-nuttx-apps>`_ repository. At the moment, these are documented in their individual README files so you can find more information at the repository.

14
Documentation/boards/index.rst
View file

@ -1,8 +1,14 @@
Supported Boards
================
.. note::
.. todo::
Include a full list of supported boards, organized by architecture / family / vendor.
Each board should have its own entry, a photo, brief hardware specifications, features
supported (currently working in NuttX), how to flash, special toolchains required, etc.
This will involve migrating most of the content existing currently in board README files
to RST documents here.
Supported Boards
================
NuttX supports a large number of boards (see :doc:`here </introduction/supported_platforms>`).
At the moment, the documentation available is in the form of README files inside each subdirectory
of ``boards`` directory of main NuttX repository.

3
Documentation/components/index.rst
View file

@ -1,8 +1,7 @@
OS Components
=============
.. note::
TODO: add brief intro
NuttX is very feature-rich RTOS and is thus composed of various different subsystems. The following sections explain how each of these main RTOS components work and can be used. For detailed documentation on the specific API used in this case, you can head to the :doc:`reference <../reference/index>`.
.. toctree::
:maxdepth: 2

7
Documentation/components/nsh/index.rst
View file

@ -2,12 +2,13 @@
NuttShell (NSH)
===============
.. warning::
This document is being migrated from previous documentation format,
it is a work in progress.
The NuttShell is a very complete shell system to be used in NuttX, similar to bash and other similar options. It supports a rich set of included commands, scripting and the ability to run your own applications as "builtin" (part of the same NuttX binary). NSH is implemented as an application where most of the functionality is part of the library called `nshlib`.
As such, NSH is completely optional and can be disabled so that NuttX directly starts a given task instead of the main ``nsh`` application.
.. toctree::
:maxdepth: 2
:caption: Contents
nsh.rst
commands.rst

8
Documentation/components/socketcan.rst
View file

@ -2,18 +2,18 @@
SocketCAN Device Drivers
========================
- **``include/nuttx/net/netdev.h``**. All structures and APIs
- ``include/nuttx/net/netdev.h``. All structures and APIs
needed to work with drivers are provided in this header file.
The structure struct net_driver_s defines the interface and is
passed to the network via netdev_register().
- **``include/nuttx/can.h``**. CAN & CAN FD frame data
- ``include/nuttx/can.h``. CAN & CAN FD frame data
structures.
- **``int netdev_register(FAR struct net_driver_s *dev, enum net_lltype_e lltype)'``**.
- ``int netdev_register(FAR struct net_driver_s *dev, enum net_lltype_e lltype)'``.
Each driver registers itself by calling netdev_register().
- **``Include/nuttx/net/can.h``**. contains lookup tables for CAN
- ``Include/nuttx/net/can.h``. contains lookup tables for CAN
dlc to CAN FD len sizes named
.. code-block:: c

5
Documentation/conf.py
View file

@ -31,9 +31,12 @@ version = release = 'latest'
extensions = [
"sphinx_rtd_theme",
"recommonmark",
'sphinx.ext.autosectionlabel'
'sphinx.ext.autosectionlabel',
'sphinx.ext.todo'
]
todo_include_todos = True
autosectionlabel_prefix_document = True
# do not set Python as primary domain for code blocks

43
Documentation/contributing/workflow.rst
View file

@ -1,7 +1,42 @@
.. todo:: update when workflow is settled
Development Workflow
====================
.. note::
This document should describe how a proper contribution should be made, and what is the
NuttX development workflow (PR based, CI checks). Could be divided into sections oriented
towards new users as well as others intending to participate in NuttX as commiter/PMC.
NuttX development workflow is based around contributions submitted in the form of GitHub Pull Requests (PR). This is true both for external contributors and NuttX maintainers, as direct pushes to the repository are not allowed as a general rule. Once submitted, your PR
will be reviewed and checked using Continuous Integration (CI) practices.
You should be aware of the following:
- All contributions must adhere to the :doc:`Coding Standard <coding_style>`. You can check your files using ``nxstyle``
or complete patchsets using ``checkpath`` script (both found in ``tools`` subdirectory of NuttX repository). This check will also run
automatically during CI to ensure conformance.
Note that not all existing files in the repository are already adapted to conform to the standard as this is an ongoing effort. Thus,
if you're submitting a patch to an existing file you may have to make the file conform to the standard, even if you are not reponsible
for those standard violations.
It is also appreciated that you separate any styling fixes in a separate commit from the functional changes so that these are more
easily readable during review.
- Before starting work on any given non trivial contribution, do subscribe to the mailing list and ask about your idea to avoid
wasted effort by going the wrong-route.
- If you are submitting an original contribution (you wrote the code yourself from scratch) it will have to be submitted under
the terms of the Apache 2.0 License using the corresponding :ref:`header <contributing/coding_style:Appendix>`.
Note that if you are working as an employee in a company, usually copyright belongs to the company and thus this means the company
will have to authorize this and submit the appropriate license agreements.
- If you are submitting third-party code:
- Code from actively developed projects is not accepted to be included in NuttX (i.e.: creating a fork). It is expected that
changes required in third-party code for NuttX support are to be implemented in these projects. As an intermediate solution,
it is acceptable to include a patch to be applied to this third-party code, which will be pulled during built.
- If this is from an inactive project, it may be considered for inclusion in NuttX, provided that licensing terms allow to do so
and it is deemed of sufficient value to be included, considering that this code will have to be maintained in NuttX afterwards.
Note that it is undesireable to included non Apache 2.0 Licensed code inside the repository, even if the license itself allows it
(for example BSD License).

5
Documentation/guides/index.rst
View file

@ -1,8 +1,9 @@
.. todo::
Create "tutorial" type documentation for specific subjects not to be covered in more general terms.
Guides
======
.. note:: This would contain "tutorial" type documentation for specific subjects not to be covered in more general terms.
.. toctree::
nfs.rst
usbtrace.rst

19
Documentation/index.rst
View file

@ -1,28 +1,31 @@
.. note::
The present documentation is a recent addition to NuttX and was migrated from previous
documentation content. For this reason, it is possible you may find broken links or
formatting errors. You can help contribute fixes or improvements to this documentation
by following these :doc:`instructions <contributing/documentation>`.
.. tip::
You can find the old documentation `here <https://cwiki.apache.org/confluence/display/NUTTX/Documentation>`_.
===================
NuttX Documentation
===================
NuttX is a real-time operating system (RTOS) with an emphasis on standards compliance and small footprint. Scalable from 8-bit to 32-bit microcontroller environments, the primary governing standards in NuttX are Posix and ANSI standards. Additional standard APIs from Unix and other common RTOS’s (such as VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()).
.. warning::
These pages are meant to be an experiment in replacing the `Apache NuttX Documentation <https://cwiki.apache.org/confluence/display/NUTTX/Nuttx>`_
with something easier to navigate, extend, and modify.
This is a work in progress, some formatting issues may still be present and are being worked on. Also, some links may be broken. Please
refer to :doc:`contributing documentation<contributing/documentation>` to propose fixes/improvements.
Last Updated: |today|
.. toctree::
:caption: Contents:
:caption: Table of Contents
:maxdepth: 2
Home <self>
introduction/index.rst
quickstart/index.rst
reference/index.rst
components/index.rst
applications/index.rst
boards/index.rst
reference/index.rst
guides/index.rst
releases/index.rst
contributing/index.rst

14
Documentation/introduction/about.rst
View file

@ -2,7 +2,10 @@
About NuttX
===========
**Goals**. NuttX is a real time embedded operating system (RTOS). Its goals are:
Goals
=====
NuttX is a real time embedded operating system (RTOS). Its goals are:
* **Small Footprint**
Usable in all but the tightest micro-controller environments, the focus is on the
@ -41,8 +44,10 @@ About NuttX
Compatible GNU toolchains based on `buildroot <http://buildroot.uclibc.org/>`__ available for `download <https://bitbucket.org/nuttx/buildroot/downloads/>`__
to provide a complete development environment for many architectures.
Feature Set
===========
**Feature Set**. Key features of NuttX include:
Key features of NuttX include:
* **Standards Compliant Core Task Management**
@ -222,7 +227,10 @@ About NuttX
* **BAS 2.4**
Seamless integration of Michael Haardt's BAS 2.4: "Bas is an interpreter for the classic dialect of the programming language BASIC. It is pretty compatible to typical BASIC interpreters of the 1980s, unlike some other UNIX BASIC interpreters, that implement a different syntax, breaking compatibility to existing programs. Bas offers many ANSI BASIC statements for structured programming, such as procedures, local variables and various loop types. Further there are matrix operations, automatic LIST indentation and many statements and functions found in specific classic dialects. Line numbers are not required."
**Look at all those files and features... How can it be a tiny OS?**. The NuttX feature list (above) is fairly long and if you
Look at all those files and features... How can it be a tiny OS?
================================================================
The NuttX feature list (above) is fairly long and if you
look at the NuttX source tree, you will see that there are hundreds of source files comprising NuttX. How can NuttX be a tiny
OS with all of that?

9
Documentation/introduction/detailed_support.rst
View file

@ -1,12 +1,11 @@
.. todo::
Migration is not yet completed from previous documentation. You can find the original list here:
`here <https://cwiki.apache.org/confluence/display/NUTTX/About>`__
=========================
Detailed Platform Support
=========================
.. note:: This is a work in progress, the details of each board is not completely migrated as it is possible that this information will be moved to the "supported boards" section and improved.
.. warning:: The following list is not yet completely migrated, in the meantime
you can see this `here <https://cwiki.apache.org/confluence/display/NUTTX/About>`__
**Details**. The details, caveats and fine print follow. For even more
information see the *README* files that can be found
`here <README.html>`__.

2
Documentation/introduction/development_environments.rst
View file

@ -1,3 +1,5 @@
.. todo:: revise and update links
========================
Development Environments
========================

2
Documentation/introduction/index.rst
View file

@ -1,7 +1,7 @@
Introduction
============
.. note:: This section should probably not remain empty. Some content of the "about" document could be placed here (a brief description). Also, it would be good to have a graphic showing the layers of NuttX (I would use this as a base: https://nuttx_projects.gitlab.io/nuttx_book/nuttx-architecture.html)
In the following sections you will find basic information introducing main NuttX features.
.. toctree::
:maxdepth: 1

8
Documentation/introduction/licensing.rst
View file

@ -2,8 +2,10 @@
Licensing
=========
.. warning:: update to Apache!
NuttX is available under the Apache 2.0 License. You can find more information about the terms `here <https://www.apache.org/foundation/license-faq.html>`_.
NuttX is available under the highly permissive BSD license. Other than some fine print that
you agree to respect the copyright you should feel absolutely free to use NuttX in any environment and without any concern for jeopardizing any proprietary software that you may link with it.
License terms
=============
.. include:: ../../LICENSE
:literal:

262
Documentation/introduction/supported_platforms.rst
View file

@ -130,7 +130,7 @@ MCU. Follow the links for the details:
- `PIC32MX2xx Family <#pic32mx2xx>`__ (MIPS32 M4K)
- `PIC32MX4xx Family <#pic32mx4xx>`__ (MIPS32 M4K)
- `PIC32MX7xx Family <#pic32mx7xx>`__ (MIPS32 M4K)
- `PIC32MZEC Family <#pic32mzec>`__ (MIPS32 |br|
- `PIC32MZEC Family <#pic32mzec>`__ (MIPS32
microAptiv)
- `PIC32MZEF Family <#pic32mzef>`__ (MIPS32 M5150)
@ -139,7 +139,7 @@ MCU. Follow the links for the details:
- `AVR ATMega128 <#avratmega128>`__ (8-bit AVR)
- `AVR ATMega1284p <#avratmega1284p>`__ (8-bit AVR)
- `AVR ATMega2560 <#avratmega2560>`__ (8-bit AVR)
- `AVR AT90USB64x and AT90USB6128x <#avrat90usbxxx>`__ |br|
- `AVR AT90USB64x and AT90USB6128x <#avrat90usbxxx>`__
(8-bit AVR)
- `AVR32 AT32UC3BXXX <#at32uc3bxxx>`__ (32-bit AVR32)
- `Atmel SAMD20 <#at91samd20>`__ (ARM Cortex-M0+)
@ -173,52 +173,52 @@ MCU. Follow the links for the details:
- NXP/Freescale
- `M68HCS12 <#m68hcs12>`__
- `NXP/Freescale i.MX1 <#freescaleimx1>`__ |br|
- `NXP/Freescale i.MX1 <#freescaleimx1>`__
(ARM920-T)
- `NXP/Freescale i.MX6 <#freescaleimx6>`__ |br|
- `NXP/Freescale i.MX6 <#freescaleimx6>`__
(ARM Cortex-A9)
- `NXP/Freescale i.MX RT <#freescaleimxrt>`__ |br|
- `NXP/Freescale i.MX RT <#freescaleimxrt>`__
(ARM Cortex-M7)
- `NXP/FreeScale KL25Z <#freescalekl25z>`__ |br|
- `NXP/FreeScale KL25Z <#freescalekl25z>`__
(ARM Cortex-M0+)
- `NXP/FreeScale KL26Z <#freescalekl26z>`__ |br|
- `NXP/FreeScale KL26Z <#freescalekl26z>`__
(ARM Cortex-M0+)
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
-
- NXP/Freescale (Continued)
- `NXP/FreeScale Kinetis K20 <#kinetisk20>`__ (ARM |br|
- `NXP/FreeScale Kinetis K20 <#kinetisk20>`__ (ARM
Cortex-M4)
- `NXP/FreeScale Kinetis K28 <#kinetisk28>`__ (ARM |br|
- `NXP/FreeScale Kinetis K28 <#kinetisk28>`__ (ARM
Cortex-M4)
- `NXP/FreeScale Kinetis K40 <#kinetisk40>`__ (ARM |br|
- `NXP/FreeScale Kinetis K40 <#kinetisk40>`__ (ARM
Cortex-M4)
- `NXP/FreeScale Kinetis K60 <#kinetisk60>`__ (ARM |br|
- `NXP/FreeScale Kinetis K60 <#kinetisk60>`__ (ARM
Cortex-M4)
- `NXP/FreeScale Kinetis K64 <#kinetisk64>`__ (ARM |br|
- `NXP/FreeScale Kinetis K64 <#kinetisk64>`__ (ARM
Cortex-M4)
- `NXP/FreeScale Kinetis K66 <#kinetisk66>`__ (ARM |br|
- `NXP/FreeScale Kinetis K66 <#kinetisk66>`__ (ARM
Cortex-M4)
- `NXP LPC11xx <#nxplpc11xx>`__ (Cortex-M0)
@ -257,167 +257,167 @@ MCU. Follow the links for the details:
- STMicroelectronics
- `STMicro STR71x <#str71x>`__ (ARM7TDMI)
- `STMicro STM32F0xx <#stm32f0xx>`__ (STM32 F0, |br|
- `STMicro STM32F0xx <#stm32f0xx>`__ (STM32 F0,
ARM Cortex-M0)
- `STMicro STM32L0xx <#stm32l0xx>`__ (STM32 L0, |br|
- `STMicro STM32L0xx <#stm32l0xx>`__ (STM32 L0,
ARM Cortex-M0)
- `STMicro STM32G0xx <#stm32g0xx>`__ (STM32 G0 |br|
- `STMicro STM32G0xx <#stm32g0xx>`__ (STM32 G0
ARM Cortex-M0+)
- `STMicro STM32L152 <#stm32l152>`__ (STM32 L1 |br|
- `STMicro STM32L152 <#stm32l152>`__ (STM32 L1
"EnergyLite" Line, ARM Cortex-M3)
- `STMicro STM32L162 <#stm32l162>`__ (STM32 L1 |br|
"EnergyLite" Medium+ Density, |br|
- `STMicro STM32L162 <#stm32l162>`__ (STM32 L1
"EnergyLite" Medium+ Density,
ARM Cortex-M3)
- `STMicro STM32F100x <#stm32f100x>`__ (STM32 F1 |br|
- `STMicro STM32F100x <#stm32f100x>`__ (STM32 F1
"Value Line" Family, ARM Cortex-M3)
- `STMicro STM32F102x <#stm32f102x>`__ (STM32 F1 |br|
- `STMicro STM32F102x <#stm32f102x>`__ (STM32 F1
family, ARM Cortex-M3)
- `STMicro STM32F103C4/C8 <#stm32f103cx>`__ (STM32 F1 |br|
"Low- and Medium-Density Line" |br|
- `STMicro STM32F103C4/C8 <#stm32f103cx>`__ (STM32 F1
"Low- and Medium-Density Line"
Family, ARM Cortex-M3)
- `STMicro STM32F103x <#stm32f103x>`__ (STM32 F1 |br|
- `STMicro STM32F103x <#stm32f103x>`__ (STM32 F1
family, ARM Cortex-M3)
- `STMicro STM32F105x <#stm32f105x>`__ (ARM Cortex-M3)
- `STMicro STM32F107x <#stm32f107x>`__ (STM32 F1 |br|
family, "Connectivity Line" |br|
- `STMicro STM32F107x <#stm32f107x>`__ (STM32 F1
family, "Connectivity Line"
ARM Cortex-M3)
- `STMicro STM32F205x <#stm32f205x>`__ (STM32 F2 |br|
- `STMicro STM32F205x <#stm32f205x>`__ (STM32 F2
family, ARM Cortex-M3)
- `STMicro STM32F207x <#stm32f207x>`__ (STM32 F2 |br|
- `STMicro STM32F207x <#stm32f207x>`__ (STM32 F2
family, ARM Cortex-M3)
- `STMicro STM32F302x <#stm32f302x>`__ (STM32 F3 |br|
- `STMicro STM32F302x <#stm32f302x>`__ (STM32 F3
family, ARM Cortex-M4)
- `STMicro STM32F303x <#stm32f303x>`__ (STM32 F3 |br|
- `STMicro STM32F303x <#stm32f303x>`__ (STM32 F3
family, ARM Cortex-M4)
- `STMicro STM32F334 <#stm32f334x>`__ (STM32 F3 |br|
- `STMicro STM32F334 <#stm32f334x>`__ (STM32 F3
family, ARM Cortex-M4)
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
|br|
-
- STMicroelectronics (Continued)
- `STMicro STM32 F372/F373 <#stm32f372x>`__ |br|
- `STMicro STM32 F372/F373 <#stm32f372x>`__
(ARM Cortex-M4)
- `STMicro STM32F4x1 <#stm32f4x1>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32F4x1 <#stm32f4x1>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32F410 <#stm32f410>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32F410 <#stm32f410>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32F405x/407x <#stm32f407x>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32F405x/407x <#stm32f407x>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32 F427/F437 <#stm32f427x>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32 F427/F437 <#stm32f427x>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32 F429 <#stm32f429x>`__ |br|
(STM32 FB family, ARM |br|
- `STMicro STM32 F429 <#stm32f429x>`__
(STM32 FB family, ARM
Cortex-M4)
- `STMicro STM32 F433 <#stm32f433x>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32 F433 <#stm32f433x>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32 F446 <#stm32f446x>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32 F446 <#stm32f446x>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32 F46xx <#stm32f46xxx>`__ |br|
(STM32 F4 family, ARM |br|
- `STMicro STM32 F46xx <#stm32f46xxx>`__
(STM32 F4 family, ARM
Cortex-M4)
- `STMicro STM32 G474x <#stm32g474x>`__ |br|
(STM32 G4 family, ARM |br|
- `STMicro STM32 G474x <#stm32g474x>`__
(STM32 G4 family, ARM
Cortex-M4)
- `STMicro STM32 L4x2 <#stm32l4x2>`__ |br|
(STM32 L4 family, ARM |br|
- `STMicro STM32 L4x2 <#stm32l4x2>`__
(STM32 L4 family, ARM
Cortex-M4)
- `STMicro STM32 L475 <#stm32l475>`__ |br|
(STM32 L4 family, ARM |br|
- `STMicro STM32 L475 <#stm32l475>`__
(STM32 L4 family, ARM
Cortex-M4)
- `STMicro STM32 L476 <#stm32l476>`__ |br|
(STM32 L4 family, ARM |br|
- `STMicro STM32 L476 <#stm32l476>`__
(STM32 L4 family, ARM
Cortex-M4)
- `STMicro STM32 L496 <#stm32l496>`__ |br|
(STM32 L4 family, ARM |br|
- `STMicro STM32 L496 <#stm32l496>`__
(STM32 L4 family, ARM
Cortex-M4)
- `STMicro STM32 L4Rx <#stm32l4rx>`__ |br|
(STM32 LB family, ARM |br|
- `STMicro STM32 L4Rx <#stm32l4rx>`__
(STM32 LB family, ARM
Cortex-M4)
- `STMicro STM32 F72x/F73x <#stm32f72x3x>`__ |br|
(STM32 F7 family, ARM |br|
- `STMicro STM32 F72x/F73x <#stm32f72x3x>`__
(STM32 F7 family, ARM
Cortex-M7)
- `STMicro STM32 F745/F746 <#stm32f74x>`__ |br|
(STM32 F7 family, ARM |br|
- `STMicro STM32 F745/F746 <#stm32f74x>`__
(STM32 F7 family, ARM
Cortex-M7)
- `STMicro STM32 F756 <#stm32f75x>`__ |br|
(STM32 F7 family, ARM |br|
- `STMicro STM32 F756 <#stm32f75x>`__
(STM32 F7 family, ARM
Cortex-M7)
- `STMicro STM32 F76xx/F77xx <#stm32f76xx77xx>`__ |br|
(STM32 F7 family, ARM |br|
- `STMicro STM32 F76xx/F77xx <#stm32f76xx77xx>`__
(STM32 F7 family, ARM
Cortex-M7)
- `STMicro STM32 H7x3 <#stm32h7x3>`__ |br|
(STM32 H7 family, ARM |br|
- `STMicro STM32 H7x3 <#stm32h7x3>`__
(STM32 H7 family, ARM
Cortex-M7)
- Texas Instruments
- (some formerly Luminary)
- `TI TMS320-C5471 <#tms320c5471>`__ |br|
- `TI TMS320-C5471 <#tms320c5471>`__
(ARM7TDMI)
- `TI TMS320-DM320 <#titms320dm320>`__ |br|
- `TI TMS320-DM320 <#titms320dm320>`__
(ARM9E6JS)
- `TI/Stellaris LM3S6432 <#tilms6432>`__ |br|
- `TI/Stellaris LM3S6432 <#tilms6432>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S6432S2E <#tilm3s6432s2e>`__ |br|
- `TI/Stellaris LM3S6432S2E <#tilm3s6432s2e>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S6918 <#tilms6918>`__ |br|
- `TI/Stellaris LM3S6918 <#tilms6918>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S6965 <#tilms6965>`__ |br|
- `TI/Stellaris LM3S6965 <#tilms6965>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S8962 <#tilms8962>`__ |br|
- `TI/Stellaris LM3S8962 <#tilms8962>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S9B92 <#tilms9b92>`__ |br|
- `TI/Stellaris LM3S9B92 <#tilms9b92>`__
(ARM Cortex-M3)
- `TI/Stellaris LM3S9B96 <#tilms9b96>`__ |br|
- `TI/Stellaris LM3S9B96 <#tilms9b96>`__
(ARM Cortex-M3)
- `TI/SimpleLink CC13x0 <#tilcc13x0>`__ |br|
- `TI/SimpleLink CC13x0 <#tilcc13x0>`__
(ARM Cortex-M3)
- `TI/Stellaris LM4F120x <#tilm4f120x>`__ |br|
- `TI/Stellaris LM4F120x <#tilm4f120x>`__
(ARM Cortex-M4)
- `TI/Tiva TM4C123G <#titm4c123g>`__ |br|
- `TI/Tiva TM4C123G <#titm4c123g>`__
(ARM Cortex-M4)
- `TI/Tiva TM4C1294 <#titm4c1294>`__ |br|
- `TI/Tiva TM4C1294 <#titm4c1294>`__
(ARM Cortex-M4)
- `TI/Tiva TM4C129X <#titm4c129x>`__ |br|
- `TI/Tiva TM4C129X <#titm4c129x>`__
(ARM Cortex-M4)
- `TI/SimpleLink CC13x2 <#tilcc13x2>`__ |br|
- `TI/SimpleLink CC13x2 <#tilcc13x2>`__
(ARM Cortex-M4)
- `TI/Hercules TMS570LS04xx <#tms570ls04x>`__ |br|
- `TI/Hercules TMS570LS04xx <#tms570ls04x>`__
(ARM Cortex-R4)
- `TI/Hercules TMS570LS31xx <#tms570ls31x>`__ |br|
- `TI/Hercules TMS570LS31xx <#tms570ls31x>`__
(ARM Cortex-R4)
- `TI/Sitara AM335x <#tiam355x>`__ |br|
- `TI/Sitara AM335x <#tiam355x>`__
(Cortex-A8)
- ZiLOG

2
Documentation/introduction/trademarks.rst
View file

@ -1,3 +1,5 @@
.. todo:: Revise status of NuttX trademark
==========
Trademarks
==========

11
Documentation/quickstart/index.rst
View file

@ -1,12 +1,13 @@
.. todo::
This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
For now, the content that is here presented is what remains of the old Porting Guide which is not already in another section of this documentation.
==========
Quickstart
==========
.. note::
This should be a brief introduction to how NuttX works and how to get it running. A widely used board could be targeted to create a brief demonstration on how to clone, configure, build, flash and run NuttX.
For now, I've included the parts of the old porting guide which seemed more relevant for this section, but should be revised and made
(new) user friendly.
The present Quickstart guide is a work in progress and only contains some basic information. In the meantime you can look at NuttX main `README <https://github.com/apache/incubator-nuttx/blob/master/README.md>`_ file which contains some information that will help you get started.
.. toctree::
:maxdepth: 1

8
Documentation/reference/index.rst
View file

@ -1,11 +1,11 @@
.. todo::
Add brief intro, distinguishing the arch and user facing APIs. Otherwise there could simply be
a top-level document for each API
=============
API Reference
=============
.. note::
TODO: add brief intro, distinguishing the arch and user facing APIs. Otherwise there could simply be
a top-level document for each API
.. toctree::
:caption: Contents:
:maxdepth: 1