doc: Fixed consistency issues

Fixed file's reference label.
Fixed cross-reference labels.

Change-Id: Id397aa9a142c692f4e2e552c9bebff626e4692a0
Signed-off-by: Gerardo Aceves <gerardo.aceves@intel.com>
This commit is contained in:
Gerardo Aceves 2016-02-02 11:59:34 -06:00 committed by Anas Nashif
commit 7c9e4990a2
29 changed files with 44 additions and 44 deletions

View file

@ -39,7 +39,7 @@ Common Services
For a complete list of services common to both the nanokernel and For a complete list of services common to both the nanokernel and
microkernel, including a description of each with code examples, microkernel, including a description of each with code examples,
see :ref:`common_kernel_services`. see :ref:`common`.
Procedures and Conventions Procedures and Conventions
@ -104,7 +104,7 @@ Steps
1. Create a directory structure for your source code in :file:`src` 1. Create a directory structure for your source code in :file:`src`
and add your source code files to it. 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`. :ref:`microkernel`, and :ref:`nanokernel`.
2. Create a :file:`Makefile` for each :file:`src` directory. 2. Create a :file:`Makefile` for each :file:`src` directory.

View file

@ -3,7 +3,7 @@
Microkernel Object Configuration 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. See :ref:`microkernel` for example MDEF entries.
Procedure Procedure

View file

@ -1,4 +1,4 @@
.. _contributing_code: .. _code:
Contributing Code Contributing Code
################# #################

View file

@ -1,4 +1,4 @@
.. _define_documentation: .. _defines:
Define Documentation Define Documentation
#################### ####################

View file

@ -1,4 +1,4 @@
.. _file_header_documentation: .. _files:
File Header Documentation File Header Documentation
######################### #########################

View file

@ -1,4 +1,4 @@
.. _function_documentation: .. _functions:
Function Documentation 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 in the documentation. To include that information, use the brief description or the detailed
description inside the comment block. description inside the comment block.
Remember that variables must be documented separately. See Remember that variables must be documented separately. See
:ref:`variable_documentation` for more details. :ref:`variables` for more details.
.. literalinclude:: hello_commented.c .. literalinclude:: hello_commented.c
:language: c :language: c

View file

@ -1,4 +1,4 @@
.. _structure_documentation: .. _structs:
Structure Documentation Structure Documentation
####################### #######################

View file

@ -1,4 +1,4 @@
.. _type_definition_documentation: .. _typedefs:
Type Definition Documentation Type Definition Documentation
############################# #############################

View file

@ -1,4 +1,4 @@
.. _variable_documentation: .. _variables:
Variable Documentation Variable Documentation
###################### ######################
@ -67,5 +67,5 @@ comment is only a sentence fragment.
Notice that the variable comments also apply for more complex types like 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 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 variable and not to the whole struct. Complex types must be documented
wherever they are defined. See :ref:`structure_documentation` and wherever they are defined. See :ref:`structs` and
:ref:`type_definition_documentation` for further details. :ref:`typedefs` for further details.

View file

@ -1,4 +1,4 @@
.. _license_guidelines: .. _licenses:
License Guidelines License Guidelines
################## ##################

View file

@ -1,4 +1,4 @@
.. _collaboration_guidelines: .. _collaboration:
Collaboration Guidelines Collaboration Guidelines
######################## ########################

View file

@ -1,4 +1,4 @@
.. _about_docs_style: .. _about:
About the Documentation Style Guide About the Documentation Style Guide
################################### ###################################

View file

@ -1,5 +1,4 @@
.. _basic_writing: .. _basic:
Basic Writing Style Guidelines Basic Writing Style Guidelines
############################## ##############################

View file

@ -47,14 +47,14 @@ Do not use labels like these:
.. _building: .. _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. 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 Similarly, it will be replaced with the figure's caption. If a different
text is needed the ``:ref:`` markup can still be used. text is needed the ``:ref:`` markup can still be used.
This is an internal reference to the beginning of This is an internal reference to the beginning of
:ref:`this module <restructured>`. :ref:`this module <rest>`.
Use the following templates to insert internal cross references properly. Use the following templates to insert internal cross references properly.
@ -109,8 +109,9 @@ reference to a documented code element.
:c:type:`type_name` :c:type:`type_name`
.. caution:: .. caution::
References to in-code documentation only work if the element has been 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 External References
=================== ===================

View file

@ -16,14 +16,14 @@ Scope
This guide includes the following: This guide includes the following:
:ref:`basic_writing` :ref:`basic`
Covers expected writing styles for the project, both general writing Covers expected writing styles for the project, both general writing
guidelines and specific guidelines for step-by-step procedures. guidelines and specific guidelines for step-by-step procedures.
:ref:`detailed` :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. Additionally, it outlines the standards for module-based writing.
:ref:`language` :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 punctuation, capitalization, abbreviations and other rules to be aware of
when authoring and contributing technical content. when authoring and contributing technical content.
:ref:`restructured` :ref:`rest`
Addresses specific writing standards and syntax pertaining to ReST. Addresses specific writing standards and syntax pertaining to ReST.
:ref:`about_docs_style` :ref:`about`
Contains information regarding the guidelines above including references, Contains information regarding the guidelines above including references,
intended audience, and the methodology employed. intended audience, and the methodology employed.
@ -62,4 +62,4 @@ These related guidelines include information that may also prove useful to
developers: developers:
* :ref:`gerrit` * :ref:`gerrit`
* :ref:`contributing_code` * :ref:`code`

View file

@ -38,7 +38,7 @@ modularization is still a work in progress and new content must be
structured following this guidelines. structured following this guidelines.
.. note:: .. 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. modular writing, except where specifically noted to the contrary.
Module Types Module Types

View file

@ -1,4 +1,4 @@
.. _restructured: .. _rest:
Restructured Text Guidelines Restructured Text Guidelines
############################ ############################

View file

@ -1,4 +1,4 @@
.. _simple_english: .. _simple:
Simple English Simple English
############## ##############

View file

@ -1,4 +1,4 @@
.. _crypto: .. _tinycrypt:
TinyCrypt Cryptographic Library v1.0 TinyCrypt Cryptographic Library v1.0
#################################### ####################################

View file

@ -10,11 +10,11 @@ you with multiple resources:
The :ref:`application` section collects all the information you need to The :ref:`application` section collects all the information you need to
develop, run and build your Zephyr applications. 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 regarding code collaboration, code style and Gerrit use. Be sure to test your
development before submitting it to Gerrit. 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. micro- and nanokernel services and their functionality.
The :ref:`api` section contains the detailed information of all the available The :ref:`api` section contains the detailed information of all the available

View file

@ -1,4 +1,4 @@
.. _common_kernel_services: .. _common:
Common Kernel Services Common Kernel Services
###################### ######################

View file

@ -1,4 +1,4 @@
.. _atomic_services: .. _common_atomic:
Atomic Services Atomic Services
############### ###############

View file

@ -1,4 +1,4 @@
.. _context_services: .. _common_contexts:
Execution Context Services Execution Context Services
########################## ##########################

View file

@ -1,4 +1,4 @@
.. _float_services: .. _common_float:
Floating Point Services Floating Point Services
####################### #######################

View file

@ -1,4 +1,4 @@
.. _kernel_clocks: .. _common_kernel_clocks:
Kernel Clocks Kernel Clocks
############# #############

View file

@ -1,4 +1,4 @@
.. _zephyr_primer: .. _kernel:
Zephyr Kernel Primer Zephyr Kernel Primer
#################### ####################

View file

@ -1,4 +1,4 @@
.. _memory_maps: .. _microkernel_memory_maps:
Memory Maps Memory Maps
########### ###########

View file

@ -1,4 +1,4 @@
.. _memory_pools: .. _microkernel_memory_pools:
Memory Pools Memory Pools
############ ############

View file

@ -33,7 +33,7 @@ IoT wireless gateways.
Related sections: Related sections:
* :ref:`common_kernel_services` * :ref:`common`
* :ref:`nanokernel` * :ref:`nanokernel`
* :ref:`microkernel` * :ref:`microkernel`
@ -121,7 +121,7 @@ not provided by nanokernel timers, such as a periodic expiration mode.
Related sections: Related sections:
* :ref:`kernel_clocks` * :ref:`common_kernel_clocks`
* :ref:`Nanokernel Timer Services <nanokernel_timers>` * :ref:`Nanokernel Timer Services <nanokernel_timers>`
* :ref:`Microkernel Timers Services <microkernel_timers>` * :ref:`Microkernel Timers Services <microkernel_timers>`
@ -231,8 +231,8 @@ The nanokernel does not provide any support for dynamic memory allocation.
For additional information see: For additional information see:
* :ref:`Microkernel Memory Maps <memory_maps>` * :ref:`Microkernel Memory Maps <microkernel_memory_maps>`
* :ref:`Microkernel Pools <memory_pools>` * :ref:`Microkernel Pools <microkernel_memory_pools>`
Public and Private Microkernel Objects Public and Private Microkernel Objects
************************************** **************************************