doc: add missing doc top labels
All docs should have a label at the top that would permit cross-document linking via :ref:`labelname`. Update "testing" label that would have conflicted and fix the only reference to the old "testing" label in development process documentation. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
f90acbf2ba
commit
9d04f03bab
16 changed files with 38 additions and 13 deletions
|
@ -1,5 +1,7 @@
|
|||
:orphan:
|
||||
|
||||
.. _page-not-found:
|
||||
|
||||
Sorry, Page Not Found
|
||||
#####################
|
||||
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
:orphan:
|
||||
|
||||
.. _doc-copyrights:
|
||||
|
||||
Documentation Copyrights
|
||||
########################
|
||||
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
.. _code-flow-and-branches:
|
||||
|
||||
Code Flow and Branches
|
||||
######################
|
||||
|
|
|
@ -1,14 +1,16 @@
|
|||
|
||||
.. _communication-and-collaboration:
|
||||
|
||||
Communication and Collaboration
|
||||
################################
|
||||
|
||||
The `Zephyr project mailing lists <https://lists.zephyrproject.org/g/main/subgroups>`_ are used as the primary
|
||||
communication tool by project members, contributors, and the community. The
|
||||
mailing list is open for topics related to the project and should be used for
|
||||
collaboration among team members working on the same feature or subsystem or for
|
||||
discussing project direction and daily development of the code base. In general,
|
||||
bug reports and issues should be entered and tracked in the bug tracking system
|
||||
(`GitHub Issues <https://github.com/zephyrproject-rtos/zephyr/issues>`_) and not broadcasted to the mailing list, the same applies to
|
||||
code reviews. Code should be submitted to GitHub using the appropriate tools.
|
||||
|
||||
The `Zephyr project mailing lists
|
||||
<https://lists.zephyrproject.org/g/main/subgroups>`_ are used as the
|
||||
primary communication tool by project members, contributors, and the
|
||||
community. The mailing list is open for topics related to the project
|
||||
and should be used for collaboration among team members working on the
|
||||
same feature or subsystem or for discussing project direction and daily
|
||||
development of the code base. In general, bug reports and issues should
|
||||
be entered and tracked in the bug tracking system (`GitHub Issues
|
||||
<https://github.com/zephyrproject-rtos/zephyr/issues>`_) and not
|
||||
broadcasted to the mailing list, the same applies to code reviews. Code
|
||||
should be submitted to GitHub using the appropriate tools.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
|
||||
.. _dev-environment-and-tools:
|
||||
|
||||
Development Environment and Tools
|
||||
#################################
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
.. _code-documentation:
|
||||
|
||||
Code Documentation
|
||||
###################
|
||||
|
@ -40,7 +41,7 @@ Test Code
|
|||
**********
|
||||
|
||||
The Zephyr project uses several test methodologies, the most common being the
|
||||
:ref:`Ztest framework <testing>`. The documentation of tests should only be done
|
||||
:ref:`Ztest framework <test-framework>`. Test documentation should only be done
|
||||
on the entry test functions (usually prefixed with test\_) and those that are
|
||||
called directly by the Ztest framework. Those tests are going to appear in test
|
||||
reports and using their name and identifier is the best way to identify them and
|
||||
|
|
|
@ -1,3 +1,4 @@
|
|||
.. _feature-tracking:
|
||||
|
||||
Feature Tracking
|
||||
#################
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _gap-pics:
|
||||
|
||||
GAP PICS
|
||||
********
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _gatt-pics:
|
||||
|
||||
GATT PICS
|
||||
=========
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _l2cap-pics:
|
||||
|
||||
L2CAP PICS
|
||||
==========
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _rfcomm-pics:
|
||||
|
||||
RFCOMM PICS
|
||||
***********
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _sm-pics:
|
||||
|
||||
SM PICS
|
||||
*******
|
||||
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _testing:
|
||||
|
||||
Testing
|
||||
#######
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
.. _testing:
|
||||
.. _test-framework:
|
||||
|
||||
Test Framework
|
||||
###############
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
.. _west-planned-features:
|
||||
|
||||
Planned Features
|
||||
================
|
||||
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
..
|
||||
Zephyr Project documentation master file
|
||||
|
||||
.. _zephyr-home:
|
||||
|
||||
Zephyr Project Documentation
|
||||
############################
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue