zephyr/doc/application/apps_common_procedures.rst

39 lines
866 B
ReStructuredText
Raw Normal View History

.. _apps_common_procedures:
Common Procedures
#################
Instructions that are common to many procedures are provided here
and referred to from the procedures that require them.
Procedures
**********
doc: Fix warnings shown when building the documentation. 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>
2015-10-24 00:42:56 +08:00
.. _set_environment_variables:
Setting Environment Variables
=============================
Set environment variables every time you open a terminal console to work on
applications.
Steps
-----
1. In a shell terminal console, enter an :command:`export` command that is
doc: Fix warnings shown when building the documentation. 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>
2015-10-24 00:42:56 +08:00
consistent with your toolchain.
For the Zephyr SDK:
.. code-block:: console
$ export ZEPHYR_GCC_VARIANT=zephyr
$ export ZEPHYR_SDK_INSTALL_DIR=<yocto-installation-path>
2. To set the environment variable :envvar:`$(ZEPHYR_BASE)`, navigate to the
kernel's installation directory and enter:
.. code-block:: console
$ source zephyr-env.sh