michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix warnings shown when building the documentation.

Browse source 
Fixes broken labels and the following warnings:

/home/nashif/Viper/forto-collab/doc/about_zephyr.rst:1: WARNING:
malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:26:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:73:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/apps_code_dev.rst:90:
WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:24:
WARNING: Enumerated list ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/
apps_common_procedures.rst:12: ERROR: Unknown target name:
"set_environment_variables".
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:26:
WARNING: Block quote ends without a blank line; unexpected unindent.
/home/nashif/Viper/forto-collab/doc/application/apps_kernel_conf.rst:75:
WARNING: Malformed :option: u'CONF_FILE =', does not contain option
marker - or -- or /
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:109: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application
/apps_kernel_conf.rst:172: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_kernel_conf.rst:208: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:24: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:76: WARNING: malformed hyperlink target.
/home/nashif/Viper/forto-collab/doc/application/
apps_object_conf.rst:89: WARNING: Include file
u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/proj.mdef' not found or reading it failed
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
defines.rst:65: WARNING: Line spec '42-47': no lines pulled from include
file u'/home/nashif/Viper/forto-collab/samples/microkernel/apps/
philosophers/src/phil.h'
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/doxygen/
functions.rst:13: ERROR: Unknown interpreted text role "code:c".
/home/nashif/Viper/forto-collab/doc/collaboration/code/
gerrit_practices.rst:53: WARNING: Title underline too short.

Change-Id: I41cb0ee3edb401b0f8e9ecab1819278f0465343d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-10-23 11:42:56 -05:00 • committed by Anas Nashif
commit 0452ab7463
11 changed files with 36 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/about_zephyr.rst
View file

@ -1,4 +1,4 @@
.. _about_zephyr:: .. _about_zephyr:
Introduction to the Zephyr Project Introduction to the Zephyr Project
################################## ##################################

6
doc/application/apps_code_dev.rst
View file

@ -23,7 +23,7 @@ Microkernel Services
For a complete list of microkernel services, including a description For a complete list of microkernel services, including a description
of each with code examples, see :ref:`microkernel`. of each with code examples, see :ref:`microkernel`.
.. _note:: .. note::
There are more microkernel services than those defined in There are more microkernel services than those defined in
the MDEF. the MDEF.
@ -70,7 +70,7 @@ directory:
* A Makefile cannot directly reference source code; it can only * A Makefile cannot directly reference source code; it can only
reference object files (.o files) produced by source code. reference object files (.o files) produced by source code.
.. _note:: .. note::
The src directory Makefiles discussed here are distinct from The src directory Makefiles discussed here are distinct from
the top-level application Makefile. the top-level application Makefile.
@ -87,7 +87,7 @@ be used to reference each directory. During the build process, Kbuild
finds the source files to generate the object files by matching the finds the source files to generate the object files by matching the
file names identified in the Makefile. file names identified in the Makefile.
.. _note:: .. note::
Source code without an associated Makefile is not included Source code without an associated Makefile is not included
when the application is built. when the application is built.

2
doc/application/apps_common_procedures.rst
View file

@ -9,7 +9,7 @@ and referred to from the procedures that require them.
Procedures Procedures
********** **********
* `set_environment_variables`_ .. _set_environment_variables:
Setting Environment Variables Setting Environment Variables
============================= =============================

22
doc/application/apps_dev_process.rst
View file

@ -27,32 +27,30 @@ Workflow
b) :ref:`create_src_makefile` b) :ref:`create_src_makefile`
3. Define the application's default kernel configuration using 3. Define the application's default kernel configuration using
:ref:`Defining the Application's Default Kernel Configuration`. :ref:`define_default_kernel_conf`.
4. Define kernel configuration override options for the application 4. Define kernel configuration override options for the application
using :ref:`Overriding the Application's Default Kernel using :ref:`override_kernel_conf`.
Configuration`.
5. For a microkernel application, define objects as you develop code 5. For a microkernel application, define objects as you develop code
using :ref:`Creating and Configuring an MDEF File for a Microkernel using :ref:`create_mdef`.
Application`.
6. For all applications, define nanokernel objects as you need them in 6. For all applications, define nanokernel objects as you need them in
code. code.
7. Develop source code and add source code files to the src directory. 7. Develop source code and add source code files to the src directory.
* :ref:`Understanding Naming Conventions` * :ref:`naming_conventions`
* :ref:`Understanding src Directory Makefile Requirements` * :ref:`src_makefiles_reqs`
* :ref:`Adding Source Files and Makefiles to src Directories` * :ref:`src_files_directories`
8. Build an application image. 8. Build an application image.
* :ref:`Building an Application` * :ref:`apps_build`
* :ref:`Rebuilding an Application`
9. To test the application image's functionality on simulated hardware 9. To test the application image's functionality on simulated hardware
with QEMU, see :ref:`Running an Application`. with QEMU, see :ref:`apps_run`.
10. To load an application image on a target hardware, see using 10. To load an application image on a target hardware, see using
:ref:`Platform` documentation. :ref:`platform` documentation.

13
doc/application/apps_kernel_conf.rst
View file

@ -20,9 +20,8 @@ it is specified:
.. note:: .. note::
When the default platform configuration settings are sufficient When the default platform configuration settings are sufficient for your
for your application, a :file:`prj.conf` file is not needed. application, a :file:`prj.conf` file is not needed. Skip ahead to
Skip ahead to
:ref:`override_kernel_conf`. :ref:`override_kernel_conf`.
@ -73,7 +72,7 @@ Steps
The default name is :file:`prj.conf`. The filename must match The default name is :file:`prj.conf`. The filename must match
the :option:`CONF_FILE =` entry in the application :file:`Makefile`. the :option:`CONF_FILE` entry in the application :file:`Makefile`.
2. Edit the file and add the appropriate configuration entries. 2. Edit the file and add the appropriate configuration entries.
@ -106,7 +105,7 @@ Override the application's default kernel configuration to
temporarily alter the application’s configuration, perhaps temporarily alter the application’s configuration, perhaps
to test the effect of a change. to test the effect of a change.
.. _note:: .. note::
If you want to permanently alter the configuration you If you want to permanently alter the configuration you
should revise the :file:`.conf` file. should revise the :file:`.conf` file.
@ -169,7 +168,7 @@ Steps
* Press :kbd:`Tab` to navigate the command menu at the * Press :kbd:`Tab` to navigate the command menu at the
bottom of the display. bottom of the display.
.. _note:: .. note::
When a non-default entry is selected for options that When a non-default entry is selected for options that
are nonnumerical, an asterisk :kbd:`*` appears between the are nonnumerical, an asterisk :kbd:`*` appears between the
@ -205,7 +204,7 @@ Steps
directory. The outdir directory contains symbolic links directory. The outdir directory contains symbolic links
to files under $(ZEPHYR_BASE). to files under $(ZEPHYR_BASE).
.. _note:: .. note::
At present, only a :file:`.config` file can be built. If At present, only a :file:`.config` file can be built. If
you have saved files with different file names and want to build you have saved files with different file names and want to build

4
doc/application/apps_object_conf.rst
View file

@ -21,7 +21,7 @@ some cases, the necessary objects aren't obvious until you begin
writing code. However, all objects used in your code must be defined writing code. However, all objects used in your code must be defined
before your application will compile successfully. before your application will compile successfully.
.. _note:: .. note::
Nanokernel applications do not use an MDEF because microkernel Nanokernel applications do not use an MDEF because microkernel
objects cannot be used in applications of this type. objects cannot be used in applications of this type.
@ -73,7 +73,7 @@ Steps
POOL name min_block_size max_block_size numMax POOL name min_block_size max_block_size numMax
.. _note:: .. note::
Some microkernel objects, such as Task IRQs, are not Some microkernel objects, such as Task IRQs, are not
defined in an :file:`.mdef` file. defined in an :file:`.mdef` file.

2
doc/application/apps_structure.rst
View file

@ -33,7 +33,7 @@ Before You Begin
---------------- ----------------
* The environment variable must be set for each console terminal using * The environment variable must be set for each console terminal using
:ref:`Setting the Environment Variables`. :ref:`set_environment_variables`.
Steps Steps
----- -----

10
doc/collaboration/code/doxygen/defines.rst
View file

@ -57,14 +57,16 @@ Correct:
:emphasize-lines: 2, 3, 5 :emphasize-lines: 2, 3, 5
:linenos: :linenos:
Observe how each piece of information is clearly marked. Observe how each piece of information is clearly marked. The @def on line 2
The @def on line 2 ensures that the comment is appropriately linked to the code. ensures that the comment is appropriately linked to the code.
Incorrect: Incorrect:
.. literalinclude:: ../../../../samples/microkernel/apps/philosophers/src/phil.h .. literalinclude::
../../../../samples/microkernel/apps/philosophers/src/phil.h
:language: c :language: c
:lines: 42-47 :lines: 24-28
:emphasize-lines: 2, 5 :emphasize-lines: 2, 5
:linenos: :linenos:

4
doc/collaboration/code/doxygen/functions.rst
View file

@ -12,8 +12,8 @@ However, you may use the following syntax for everything else.
When linking functions within a ReST file, two possible markups are: When linking functions within a ReST file, two possible markups are:
``:cpp:`` or ``:c:``. Use ``:cpp:`` for functions defined using an ``:cpp:`` or ``:c:``. Use ``:cpp:`` for functions defined using an
:code:c:`extern`. Use ``:c:`` for functions defined using a :code:`extern`. Use ``:c:`` for functions defined using a
:code:c:`#define`. :code:`#define`.
Function Comment Templates Function Comment Templates
************************** **************************

2
doc/collaboration/code/gerrit_practices.rst
View file

@ -50,7 +50,7 @@ The command above needs to be entered only once.
Avoid Pushing Untested Work to a Gerrit Server Avoid Pushing Untested Work to a Gerrit Server
*************************************** **********************************************
To avoid pushing untested work to Gerrit, we recommend you follow these steps: To avoid pushing untested work to Gerrit, we recommend you follow these steps:

2
doc/kernel/nanokernel/nanokernel_fifos.rst
View file

@ -19,7 +19,7 @@ in the FIFO's linked list. Consequently, a data item that holds N bytes
of application data requires N+4 bytes of memory. of application data requires N+4 bytes of memory.
Any number of nanokernel FIFOs can be defined. Each FIFO is a distinct Any number of nanokernel FIFOs can be defined. Each FIFO is a distinct
variable of type :cpp:type:`struct nano_fifo`, and is referenced using a variable of type :c:type:`struct nano_fifo`, and is referenced using a
pointer to that variable. A FIFO must be initialized before it can be used to pointer to that variable. A FIFO must be initialized before it can be used to
send or receive data items. send or receive data items.