sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: split some long lines

Browse Source
This commit is contained in:
raiden00pl 2023-10-28 10:40:46 +02:00 committed by Xiang Xiao
parent 82bcc3f7d4
commit ce97fccf9a
3 changed files with 47 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/contributing/index.rst
View File

@ -1,8 +1,9 @@
Contributing Contributing
============ ============
In the following sections you will find important information on how to contribute to NuttX codebase (from small bugfixes to large new features) In the following sections you will find important information on how to contribute
and documentation (the one you are reading now): to NuttX codebase (from small bugfixes to large new features) and documentation
(the one you are reading now):
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

60
Documentation/contributing/workflow.rst
View File

@ -3,40 +3,54 @@
Development Workflow Development Workflow
==================== ====================
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 NuttX development workflow is based around contributions submitted in the form
will be reviewed and checked using Continuous Integration (CI) practices. 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: 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`` - All contributions must adhere to the :doc:`Coding Standard <coding_style>`.
or complete patchsets using ``checkpatch`` script (both found in ``tools`` subdirectory of NuttX repository). This check will also run You can check your files using ``nxstyle`` or complete patchsets using
automatically during CI to ensure conformance. ``checkpatch`` script (both found in ``tools`` subdirectory of NuttX
prepository). 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, Note that not all existing files in the repository are already adapted to
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 responsible conform to the standard as this is an ongoing effort. Thus, if you're
for those standard violations. submitting a patch to an existing file you may have to make the file conform
to the standard, even if you are not responsible 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 It is also appreciated that you separate any styling fixes in a separate
easily readable during review. 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 - Before starting work on any given non trivial contribution, do subscribe to
wasted effort by going the wrong-route. 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 - If you are submitting an original contribution (you wrote the code yourself
the terms of the Apache 2.0 License using the corresponding :ref:`header <contributing/coding_style:Appendix>`. 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 Note that if you are working as an employee in a company, usually copyright
will have to authorize this and submit the appropriate license agreements. 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: - 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 - Code from actively developed projects is not accepted to be included in
changes required in third-party code for NuttX support are to be implemented in these projects. As an intermediate solution, NuttX (i.e.: creating a fork). It is expected that changes required in
it is acceptable to include a patch to be applied to this third-party code, which will be pulled during built. 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 - If this is from an inactive project, it may be considered for inclusion in
and it is deemed of sufficient value to be included, considering that this code will have to be maintained in NuttX afterwards. 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 undesirable to included non Apache 2.0 Licensed code inside the repository, even if the license itself allows it Note that it is undesirable to included non Apache 2.0 Licensed code inside
(for example BSD License). the repository, even if the license itself allows it (for example BSD License).

8
Documentation/index.rst
View File

@ -11,7 +11,13 @@
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 64-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()). NuttX is a real-time operating system (RTOS) with an emphasis on standards
compliance and small footprint. Scalable from 8-bit to 64-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()).
Last Updated: |today| Last Updated: |today|