OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/application/apps_overview.rst

38 lines
1.6 KiB
ReStructuredText
Raw Normal View History

doc: Relocate and revise "Application Fundamentals" material Relocates material that outlines the structure of a Zephyr application so that it appears at the beginning of the "Application Development Primer". (i.e. The primer now tells the reader the file structure of an application, then explains how to create these files.) Revises the description of the MDEF file to make it a bulleted item (like the other file types are) and improve readability. Change-Id: I9f003b8317257c927bea752da55cc434f957592c Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-07-04 23:15:42 +08:00
.. _apps_overview:
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
doc: Relocate and revise "Application Fundamentals" material Relocates material that outlines the structure of a Zephyr application so that it appears at the beginning of the "Application Development Primer". (i.e. The primer now tells the reader the file structure of an application, then explains how to create these files.) Revises the description of the MDEF file to make it a bulleted item (like the other file types are) and improve readability. Change-Id: I9f003b8317257c927bea752da55cc434f957592c Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-07-04 23:15:42 +08:00
Application Overview
####################
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
doc: Relocate and revise "Application Fundamentals" material Relocates material that outlines the structure of a Zephyr application so that it appears at the beginning of the "Application Development Primer". (i.e. The primer now tells the reader the file structure of an application, then explains how to create these files.) Revises the description of the MDEF file to make it a bulleted item (like the other file types are) and improve readability. Change-Id: I9f003b8317257c927bea752da55cc434f957592c Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-07-04 23:15:42 +08:00
A Zephyr application is a collection of user-supplied files that can be built
into an application image that executes on a board.
Each application resides in a distinct directory created by the developer.
The directory has the following structure.
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
doc: Edits to the Overview and kernel primer Fixed typo in system_fundamentals. Acronyms FIFO and LIFO defined with capital letters in kernel_fundamentals. Added bold to paragraph lists to enhance readability in application_fundamentals Added lots of :dfn: syntax for better interlinking to API. Corrected whitespace for sub-bullet directive. Change-Id: If6c5bc78746686d1a4986974f1b56bf9b2caebca Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2015-10-22 03:08:58 +08:00
* **Application source code files**: An application typically provides one
or more application-specific files, written in C or assembly language. These
files are usually located in a sub-directory called :file:`src`.
unified/doc: Update Application Development Primer Removes references to nanokernel/microkernel. Corrects numerous errors in content. Improves consistency in presentation of information. Change-Id: I83895d2cb03181da377b23323afc104ae32865a2 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-29 04:06:44 +08:00
* **Kernel configuration files**: An application typically provides
a configuration file (:file:`.conf`) that specifies values for one or more
kernel configuration options. If omitted, the application's existing kernel
configuration option values are used; if no existing values are provided,
the kernel's default configuration values are used.
doc: Edits to the Overview and kernel primer Fixed typo in system_fundamentals. Acronyms FIFO and LIFO defined with capital letters in kernel_fundamentals. Added bold to paragraph lists to enhance readability in application_fundamentals Added lots of :dfn: syntax for better interlinking to API. Corrected whitespace for sub-bullet directive. Change-Id: If6c5bc78746686d1a4986974f1b56bf9b2caebca Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2015-10-22 03:08:58 +08:00
unified/doc: Update Application Development Primer Removes references to nanokernel/microkernel. Corrects numerous errors in content. Improves consistency in presentation of information. Change-Id: I83895d2cb03181da377b23323afc104ae32865a2 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-29 04:06:44 +08:00
* **Makefile**: This file typically contains a handful of lines that tell
the build system where to find the files mentioned above, as well as
the desired target board configuration.
doc: Overhaul of Zephyr Kernel Primer overview section A complete rewrite of the Overview section. The revised text provides a more logical and comprehensive introduction to the main concepts and capabilities of Zephyr, without providing an excessive level of detail. (Those details should be provided by the remaining sections of the Kernel Primer.) This rewrite has also resulted in some small changes to the About Zephyr and other Kernel Primer sections. Change-Id: Idd4d5e0f0aabaaee8cd43d12563018ba4d8f7417 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2015-08-13 03:46:55 +08:00
doc: Edits to the Overview and kernel primer Fixed typo in system_fundamentals. Acronyms FIFO and LIFO defined with capital letters in kernel_fundamentals. Added bold to paragraph lists to enhance readability in application_fundamentals Added lots of :dfn: syntax for better interlinking to API. Corrected whitespace for sub-bullet directive. Change-Id: If6c5bc78746686d1a4986974f1b56bf9b2caebca Signed-off-by: L.S. Cook <leonax.cook@intel.com>
2015-10-22 03:08:58 +08:00
Once the application has been defined, it can be built with a single command.
unified/doc: Update Application Development Primer Removes references to nanokernel/microkernel. Corrects numerous errors in content. Improves consistency in presentation of information. Change-Id: I83895d2cb03181da377b23323afc104ae32865a2 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-29 04:06:44 +08:00
The results of the build process are located in a sub-directory
called :file:`outdir/BOARD`. This directory contains the files generated
by the build process, the most notable of which are listed below.
* The :file:`.config` file that contains the configuration settings
used to build the application.
* The various object files (:file:`.o` files and :file:`.a` files) containing
custom-built kernel and application-specific code.
* The :file:`zephyr.elf` file that contains the final application image.