diff --git a/doc/application/apps_code_dev.rst b/doc/application/apps_code_dev.rst index 30e83ab374b..8b706dc8e08 100644 --- a/doc/application/apps_code_dev.rst +++ b/doc/application/apps_code_dev.rst @@ -39,7 +39,7 @@ Common Services For a complete list of services common to both the nanokernel and microkernel, including a description of each with code examples, -see :ref:`common_kernel_services`. +see :ref:`common`. Procedures and Conventions @@ -104,7 +104,7 @@ Steps 1. Create a directory structure for your source code in :file:`src` and add your source code files to it. - For many useful code examples, see :ref:`common_kernel_services`, + For many useful code examples, see :ref:`common`, :ref:`microkernel`, and :ref:`nanokernel`. 2. Create a :file:`Makefile` for each :file:`src` directory. diff --git a/doc/application/apps_object_conf.rst b/doc/application/apps_object_conf.rst index 31a50e6dbe1..93bcce053df 100644 --- a/doc/application/apps_object_conf.rst +++ b/doc/application/apps_object_conf.rst @@ -3,7 +3,7 @@ Microkernel Object Configuration ################################ -Microkernel objects are explained fully in the :ref:`zephyr_primer`. +Microkernel objects are explained fully in the :ref:`kernel`. See :ref:`microkernel` for example MDEF entries. Procedure diff --git a/doc/collaboration/code/code.rst b/doc/collaboration/code/code.rst index 4d3a98549a3..5838167ee19 100644 --- a/doc/collaboration/code/code.rst +++ b/doc/collaboration/code/code.rst @@ -1,4 +1,4 @@ -.. _contributing_code: +.. _code: Contributing Code ################# diff --git a/doc/collaboration/code/doxygen/defines.rst b/doc/collaboration/code/doxygen/defines.rst index 75687bcf70a..42ec3727f02 100644 --- a/doc/collaboration/code/doxygen/defines.rst +++ b/doc/collaboration/code/doxygen/defines.rst @@ -1,4 +1,4 @@ -.. _define_documentation: +.. _defines: Define Documentation #################### diff --git a/doc/collaboration/code/doxygen/files.rst b/doc/collaboration/code/doxygen/files.rst index 4525c36fb2e..a43fcddaf4c 100644 --- a/doc/collaboration/code/doxygen/files.rst +++ b/doc/collaboration/code/doxygen/files.rst @@ -1,4 +1,4 @@ -.. _file_header_documentation: +.. _files: File Header Documentation ######################### diff --git a/doc/collaboration/code/doxygen/functions.rst b/doc/collaboration/code/doxygen/functions.rst index cba66c4f970..c803b513b58 100644 --- a/doc/collaboration/code/doxygen/functions.rst +++ b/doc/collaboration/code/doxygen/functions.rst @@ -1,4 +1,4 @@ -.. _function_documentation: +.. _functions: Function Documentation ###################### @@ -128,7 +128,7 @@ Lines 13 and 16 contain two comments that will not be included by Doxygen in the documentation. To include that information, use the brief description or the detailed description inside the comment block. Remember that variables must be documented separately. See -:ref:`variable_documentation` for more details. +:ref:`variables` for more details. .. literalinclude:: hello_commented.c :language: c diff --git a/doc/collaboration/code/doxygen/structs.rst b/doc/collaboration/code/doxygen/structs.rst index 0b65f9ff829..fe5613882d6 100644 --- a/doc/collaboration/code/doxygen/structs.rst +++ b/doc/collaboration/code/doxygen/structs.rst @@ -1,4 +1,4 @@ -.. _structure_documentation: +.. _structs: Structure Documentation ####################### diff --git a/doc/collaboration/code/doxygen/typedefs.rst b/doc/collaboration/code/doxygen/typedefs.rst index d7358058996..7228b8f1420 100644 --- a/doc/collaboration/code/doxygen/typedefs.rst +++ b/doc/collaboration/code/doxygen/typedefs.rst @@ -1,4 +1,4 @@ -.. _type_definition_documentation: +.. _typedefs: Type Definition Documentation ############################# diff --git a/doc/collaboration/code/doxygen/variables.rst b/doc/collaboration/code/doxygen/variables.rst index 69ad746606e..b70226788b1 100644 --- a/doc/collaboration/code/doxygen/variables.rst +++ b/doc/collaboration/code/doxygen/variables.rst @@ -1,4 +1,4 @@ -.. _variable_documentation: +.. _variables: Variable Documentation ###################### @@ -67,5 +67,5 @@ comment is only a sentence fragment. Notice that the variable comments also apply for more complex types like structs. The comments on lines 4 and 7 apply only to the specific variable and not to the whole struct. Complex types must be documented -wherever they are defined. See :ref:`structure_documentation` and -:ref:`type_definition_documentation` for further details. \ No newline at end of file +wherever they are defined. See :ref:`structs` and +:ref:`typedefs` for further details. \ No newline at end of file diff --git a/doc/collaboration/code/licenses.rst b/doc/collaboration/code/licenses.rst index 2e1dd32dd9f..e0abd548d0e 100644 --- a/doc/collaboration/code/licenses.rst +++ b/doc/collaboration/code/licenses.rst @@ -1,4 +1,4 @@ -.. _license_guidelines: +.. _licenses: License Guidelines ################## diff --git a/doc/collaboration/collaboration.rst b/doc/collaboration/collaboration.rst index 28229fceb16..95b8bcc2ca3 100644 --- a/doc/collaboration/collaboration.rst +++ b/doc/collaboration/collaboration.rst @@ -1,4 +1,4 @@ -.. _collaboration_guidelines: +.. _collaboration: Collaboration Guidelines ######################## diff --git a/doc/collaboration/documentation/about.rst b/doc/collaboration/documentation/about.rst index 8193f4c9d6b..988ad36d468 100644 --- a/doc/collaboration/documentation/about.rst +++ b/doc/collaboration/documentation/about.rst @@ -1,4 +1,4 @@ -.. _about_docs_style: +.. _about: About the Documentation Style Guide ################################### diff --git a/doc/collaboration/documentation/basic.rst b/doc/collaboration/documentation/basic.rst index d925b88bbe4..f4f58e0f371 100644 --- a/doc/collaboration/documentation/basic.rst +++ b/doc/collaboration/documentation/basic.rst @@ -1,5 +1,4 @@ -.. _basic_writing: - +.. _basic: Basic Writing Style Guidelines ############################## diff --git a/doc/collaboration/documentation/cross.rst b/doc/collaboration/documentation/cross.rst index 32c36bc5ae3..6934806709f 100644 --- a/doc/collaboration/documentation/cross.rst +++ b/doc/collaboration/documentation/cross.rst @@ -47,14 +47,14 @@ Do not use labels like these: .. _building: -This is an internal reference to the beginning of :ref:`restructured`. +This is an internal reference to the beginning of :ref:`rest`. Observe that the ``:ref:`` markup is replaced with the title's text. Similarly, it will be replaced with the figure's caption. If a different text is needed the ``:ref:`` markup can still be used. This is an internal reference to the beginning of -:ref:`this module `. +:ref:`this module `. Use the following templates to insert internal cross references properly. @@ -109,8 +109,9 @@ reference to a documented code element. :c:type:`type_name` .. caution:: + References to in-code documentation only work if the element has been - documented in the code following the :ref:`contributing_code`. + documented in the code following the :ref:`code`. External References =================== diff --git a/doc/collaboration/documentation/documentation.rst b/doc/collaboration/documentation/documentation.rst index 385142b8703..e7a6e6c5158 100644 --- a/doc/collaboration/documentation/documentation.rst +++ b/doc/collaboration/documentation/documentation.rst @@ -16,14 +16,14 @@ Scope This guide includes the following: -:ref:`basic_writing` +:ref:`basic` Covers expected writing styles for the project, both general writing guidelines and specific guidelines for step-by-step procedures. :ref:`detailed` -Offers specific examples of guidelines included in the :ref:`basic_writing`. +Offers specific examples of guidelines included in the :ref:`basic`. Additionally, it outlines the standards for module-based writing. :ref:`language` @@ -32,11 +32,11 @@ Discusses important usage rules to be aware of regarding grammar, mechanics, punctuation, capitalization, abbreviations and other rules to be aware of when authoring and contributing technical content. -:ref:`restructured` +:ref:`rest` Addresses specific writing standards and syntax pertaining to ReST. -:ref:`about_docs_style` +:ref:`about` Contains information regarding the guidelines above including references, intended audience, and the methodology employed. @@ -62,4 +62,4 @@ These related guidelines include information that may also prove useful to developers: * :ref:`gerrit` -* :ref:`contributing_code` \ No newline at end of file +* :ref:`code` \ No newline at end of file diff --git a/doc/collaboration/documentation/modular.rst b/doc/collaboration/documentation/modular.rst index 46b2fe88877..8d17090ab8d 100644 --- a/doc/collaboration/documentation/modular.rst +++ b/doc/collaboration/documentation/modular.rst @@ -38,7 +38,7 @@ modularization is still a work in progress and new content must be structured following this guidelines. .. note:: - The guidelines presented in :ref:`basic_writing` still apply to + The guidelines presented in :ref:`basic` still apply to modular writing, except where specifically noted to the contrary. Module Types diff --git a/doc/collaboration/documentation/rest.rst b/doc/collaboration/documentation/rest.rst index e3d5a2987a9..4890b75d972 100644 --- a/doc/collaboration/documentation/rest.rst +++ b/doc/collaboration/documentation/rest.rst @@ -1,4 +1,4 @@ -.. _restructured: +.. _rest: Restructured Text Guidelines ############################ diff --git a/doc/collaboration/documentation/simple.rst b/doc/collaboration/documentation/simple.rst index 8a022d68baa..87339cc3997 100644 --- a/doc/collaboration/documentation/simple.rst +++ b/doc/collaboration/documentation/simple.rst @@ -1,4 +1,4 @@ -.. _simple_english: +.. _simple: Simple English ############## diff --git a/doc/crypto/tinycrypt.rst b/doc/crypto/tinycrypt.rst index 49e3ae997fa..8aa366e1f1b 100644 --- a/doc/crypto/tinycrypt.rst +++ b/doc/crypto/tinycrypt.rst @@ -1,4 +1,4 @@ -.. _crypto: +.. _tinycrypt: TinyCrypt Cryptographic Library v1.0 #################################### diff --git a/doc/getting_started/developing.rst b/doc/getting_started/developing.rst index d187733388c..fc681e9ec00 100644 --- a/doc/getting_started/developing.rst +++ b/doc/getting_started/developing.rst @@ -10,11 +10,11 @@ you with multiple resources: The :ref:`application` section collects all the information you need to develop, run and build your Zephyr applications. -The :ref:`contributing_code` section collects all the project's guidelines +The :ref:`code` section collects all the project's guidelines regarding code collaboration, code style and Gerrit use. Be sure to test your development before submitting it to Gerrit. -The :ref:`zephyr_primer` section contains detailed information regarding +The :ref:`kernel` section contains detailed information regarding micro- and nanokernel services and their functionality. The :ref:`api` section contains the detailed information of all the available diff --git a/doc/kernel/common/common.rst b/doc/kernel/common/common.rst index ff821196f2f..eca435ae564 100644 --- a/doc/kernel/common/common.rst +++ b/doc/kernel/common/common.rst @@ -1,4 +1,4 @@ -.. _common_kernel_services: +.. _common: Common Kernel Services ###################### diff --git a/doc/kernel/common/common_atomic.rst b/doc/kernel/common/common_atomic.rst index 0bceaa337a9..a884070a3f6 100644 --- a/doc/kernel/common/common_atomic.rst +++ b/doc/kernel/common/common_atomic.rst @@ -1,4 +1,4 @@ -.. _atomic_services: +.. _common_atomic: Atomic Services ############### diff --git a/doc/kernel/common/common_contexts.rst b/doc/kernel/common/common_contexts.rst index d1cc44f8f9b..0ab01b463bc 100644 --- a/doc/kernel/common/common_contexts.rst +++ b/doc/kernel/common/common_contexts.rst @@ -1,4 +1,4 @@ -.. _context_services: +.. _common_contexts: Execution Context Services ########################## diff --git a/doc/kernel/common/common_float.rst b/doc/kernel/common/common_float.rst index a098b0776d0..705a6e53a66 100644 --- a/doc/kernel/common/common_float.rst +++ b/doc/kernel/common/common_float.rst @@ -1,4 +1,4 @@ -.. _float_services: +.. _common_float: Floating Point Services ####################### diff --git a/doc/kernel/common/common_kernel_clocks.rst b/doc/kernel/common/common_kernel_clocks.rst index 616bb20a633..69c6679b1f1 100644 --- a/doc/kernel/common/common_kernel_clocks.rst +++ b/doc/kernel/common/common_kernel_clocks.rst @@ -1,4 +1,4 @@ -.. _kernel_clocks: +.. _common_kernel_clocks: Kernel Clocks ############# diff --git a/doc/kernel/kernel.rst b/doc/kernel/kernel.rst index 2ea59aebaa8..642bcc7074a 100644 --- a/doc/kernel/kernel.rst +++ b/doc/kernel/kernel.rst @@ -1,4 +1,4 @@ -.. _zephyr_primer: +.. _kernel: Zephyr Kernel Primer #################### diff --git a/doc/kernel/microkernel/microkernel_memory_maps.rst b/doc/kernel/microkernel/microkernel_memory_maps.rst index 910d25d3b3e..66c60504b98 100644 --- a/doc/kernel/microkernel/microkernel_memory_maps.rst +++ b/doc/kernel/microkernel/microkernel_memory_maps.rst @@ -1,4 +1,4 @@ -.. _memory_maps: +.. _microkernel_memory_maps: Memory Maps ########### diff --git a/doc/kernel/microkernel/microkernel_memory_pools.rst b/doc/kernel/microkernel/microkernel_memory_pools.rst index b1481e1c538..b9cfaab78f4 100644 --- a/doc/kernel/microkernel/microkernel_memory_pools.rst +++ b/doc/kernel/microkernel/microkernel_memory_pools.rst @@ -1,4 +1,4 @@ -.. _memory_pools: +.. _microkernel_memory_pools: Memory Pools ############ diff --git a/doc/kernel/overview/kernel_fundamentals.rst b/doc/kernel/overview/kernel_fundamentals.rst index d73af635e88..82be902e615 100644 --- a/doc/kernel/overview/kernel_fundamentals.rst +++ b/doc/kernel/overview/kernel_fundamentals.rst @@ -33,7 +33,7 @@ IoT wireless gateways. Related sections: -* :ref:`common_kernel_services` +* :ref:`common` * :ref:`nanokernel` * :ref:`microkernel` @@ -121,7 +121,7 @@ not provided by nanokernel timers, such as a periodic expiration mode. Related sections: -* :ref:`kernel_clocks` +* :ref:`common_kernel_clocks` * :ref:`Nanokernel Timer Services ` * :ref:`Microkernel Timers Services ` @@ -231,8 +231,8 @@ The nanokernel does not provide any support for dynamic memory allocation. For additional information see: -* :ref:`Microkernel Memory Maps ` -* :ref:`Microkernel Pools ` +* :ref:`Microkernel Memory Maps ` +* :ref:`Microkernel Pools ` Public and Private Microkernel Objects **************************************