OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: modules: rework content describing submitting changes to modules 

We rework the titles and headers of the section where we
describe the process for submitting new module and changes
to existing modules. Move the 'requirements' section at the
top of the page.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
This commit is contained in:
Ioannis Glaropoulos 2020-07-28 22:44:26 +02:00 committed by Carles Cufí
parent 07d61350e9
commit 4932925fde
1 changed files with 5 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/guides/modules.rst
View File

@ -644,7 +644,7 @@ Zephyr needs a reference to the changes to be able to verify the changes. In the
main tree this is done using revisions. For code that is already merged and part
of the tree we use the commit hash, a tag, or a branch name. For pull requests
however, we require specifying the pull request number in the revision field to
allow building the Zephyr main tree with the changes submitted to the
allow building the zephyr main tree with the changes submitted to the
module.
To avoid merging changes to master with pull request information, the pull
@ -659,16 +659,8 @@ using exactly the same process. In this case you will change multiple entries of
all modules that have a pull request against them.
Submitting a new module
========================
Requirements
-------------
Modules to be included in the default manifest of the Zephyr project need to
provide functionality or features endorsed and approved by the project technical
steering committee and should follow the project licensing and
:ref:`contribute_guidelines`.
Process for submitting a new module
===================================
A request for a new module should be initialized using an RFC issue in the
Zephyr project issue tracking system with details about the module and how it
@ -681,9 +673,6 @@ If a module is maintained as a fork of another project on Github, the Zephyr mod
related files and changes in relation to upstream need to be maintained in a
special branch named ``zephyr``.
Process
-------
Follow the following steps to request a new module:
#. Use `GitHub issues`_ to open an issue with details about the module to be
@ -719,8 +708,8 @@ revision needs to be changed to the commit hash from the module repository.
.. _changes_to_existing_module:
Changes to existing modules
===========================
Process for submitting changes to existing modules
==================================================
#. Submit the changes using a pull request to an existing repository following
the :ref:`contribution guidelines <contribute_guidelines>`.