michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: codename -> Zephyr Kernel

Browse source 
To make the documentation readable from the source I want to get rid of the
substitutions for the project name an code name. This does not add any values
and makes it unreadable when looking at the text files directly. It also causes
some issues when people use those without actually knowing what they represent,
resulting in some weird and redundant language.

Change-Id: I09e8cbbee7c1141a7a77d3ffff59cdae2b52050c
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-10-20 13:28:33 -04:00
commit ba751c80b0
17 changed files with 27 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/README.rst
View file

@ -1,5 +1,5 @@
Welcome to |codename|
#####################
Welcome to Zephyr Kernel
########################
.. This document is in Restructured Text Format.

4
doc/about_zephyr.rst
View file

@ -3,7 +3,7 @@
Introduction to the Zephyr Project
##################################
The |codename| is a small-footprint kernel designed for use on
The Zephyr Kernel is a small-footprint kernel designed for use on
resource-constrained systems: from simple embedded environmental
sensors and LED wearables to sophisticated smart watches and IoT
wireless gateways.
@ -21,7 +21,7 @@ to users and developers under the Apache License, version 2.0.
Distinguishing Features
***********************
The |codename| offers a number of features that distinguish it from other
The Zephyr Kernel offers a number of features that distinguish it from other
small-footprint OSes:
#. **Single address-space OS**. Combines application-specific code

3
doc/application/application.rst
View file

@ -10,8 +10,7 @@ Audience
--------
Although anybody may use this primer to learn how to build microkernel and
nanokernel applications on the |codename|, the primary audience for this guide
is:
nanokernel applications, the primary audience for this guide is:
* Application developers coding an application.

2
doc/application/apps_code_dev.rst
View file

@ -12,7 +12,7 @@ Application Code Development
Services
********
The |codename| services architecture has services that are
The Zephyr kernel services architecture has services that are
specific to the microkernel, services that are specific to the
nanokernel, and services that are common, or shared, between the
two.

2
doc/application/apps_common_procedures.rst
View file

@ -15,7 +15,7 @@ Setting Environment Variables
=============================
Set environment variables every time you open a terminal console to work on
|codename|'s applications.
applications.
Steps
-----

4
doc/application/apps_dev_process.rst
View file

@ -3,8 +3,8 @@
Application Development Workflow
################################
The application development workflow identifies the procedures needed to
create, build, and run a |codename|'s microkernel or nanokernel application.
The application development workflow identifies procedures needed to create, build, and
run a Zephyr microkernel or nanokernel application.
Before you build
----------------

2
doc/application/apps_structure.rst
View file

@ -10,7 +10,7 @@ workspace directory. The application developer also creates a
.. note::
The |codename| either supplies or generates all other application
The Zephyr Kernel either supplies or generates all other application
directories.
Procedures

2
doc/collaboration/code/doxygen/groups.rst
View file

@ -3,7 +3,7 @@
Doxygen Groups
##############
The |codename|'s in-code documentation implements Doxygen groups.
The Zephyr Kernel's in-code documentation implements Doxygen groups.
The comments regarding the various services are contained in their respective groups.
The services groups are then contained in one of two main groups: either microkernel or nanokernel.
Each group can contain other groups, functions, variables, enums, typedefs and defines.

4
doc/collaboration/code/licenses.rst
View file

@ -3,9 +3,9 @@
License Guidelines
##################
The |codename| is licensed under a BSD 3-clause license. This is a
The Zephyr Kernel is licensed under a BSD 3-clause license. This is a
permissive license that allows our customers to write kernel-level code
without having to open source their code. All code linked in a |codename|
without having to open source their code. All code linked in a Zephyr Kernel
binary image must be permissively licensed. The source tree includes some GPL
-licensed build tools, but those are not linked to the final binary image,
and thus the image itself is not GPL-tainted.

10
doc/collaboration/documentation/code_blocks.rst
View file

@ -3,14 +3,14 @@
Code Examples
*************
Collaborating to the |codename| is all about code. Therefore, your
Collaborating to the Zephyr Kernel is all about code. Therefore, your
documentation must include code examples. The code examples can be
written directly in the documentation or included from a source file.
Use these guidelines to insert code blocks to your documentation:
* Include code examples from a source file . Only write the code
example directly into the documentation if the example is less than 10
lines long or not part of the code base of |codename|.
lines long or not part of the code base of the Zephyr Kernel.
* Use the ``:lineos:`` option of the directives to add line numbers to
your example if it is larger than 12 lines.
@ -69,7 +69,7 @@ Renders as:
$ mkdir ${HOME}/cross-src
Finally, this is a code example that is not part of the |codename|'s
Finally, this is a code example that is not part of the Zephyr Kernel's
code base. It is not even valid code but it is used to illustrate a
concept.
@ -127,7 +127,7 @@ We have included templates for a basic ``.. code-block::`` directive
and for a ``.. literalinclude::`` directive.
Use ``code-block`` for console commands, brief examples and examples
outside the code base of the |codename|.
outside the code base of the Zephyr Kernel.
.. code-block:: rst
@ -150,4 +150,4 @@ specific lines.
.. caution::
The ``:emphasize-lines:`` option uses the line numbering provided
by ``:lineos:``. The emphasized line in the template will be the
third one of the example but the eighth one of the source file.
third one of the example but the eighth one of the source file.

2
doc/kernel/overview/system_fundamentals.rst
View file

@ -21,7 +21,7 @@ least one Makefile. The application's kernel configuration settings enable the b
system to create a kernel tailor-made to meet the needs of the application
and to make the best use of the system's resources.
The |codename| supports a variety of target systems, known as *platforms*;
The Zephyr Kernel supports a variety of target systems, known as *platforms*;
each :dfn:`platform` has its own set of hardware devices and capabilities. One or more
*platform configurations* are defined for a given platform; each
:dfn:`platform configuration` indicates how the devices that may be present on the

2
doc/platform/basic_minuteia.rst
View file

@ -6,7 +6,7 @@ Platform Configuration: basic_minuteia
Overview
********
The |codename| uses the basic_minuteia platform configuration
The Zephyr Kernel uses the basic_minuteia platform configuration
to emulate the galileo platform (or something similar) running on QEMU.
It provides support for an x86 Minute IA CPU and the following devices:

2
doc/platform/galileo.rst
View file

@ -7,7 +7,7 @@ Overview
********
Developers can use the galileo platform configuration
to build a |codename| that runs on a Galileo Development Board (Gen 1 or Gen 2).
to build a Zephyr Kernel that runs on a Galileo Development Board (Gen 1 or Gen 2).
This platform configuration enables kernel support for the board's Quark SoC,
along with the following devices:

2
doc/platform/platform.rst
View file

@ -3,7 +3,7 @@
Supported Platforms
###################
The |codename| supports the platform configurations listed in the
The Zephyr Kernel supports the platform configurations listed in the
table below. An application can use a platform configuration as is,
or it can customize a platform configuration by changing its default
kernel configuration settings.

4
doc/quick_start/quick_start.rst
View file

@ -4,10 +4,10 @@ Quick Start Guide
#################
Use this guide to install the Zephyr development environment on your
development system and to build the |codename| on the supported platforms.
development system and to build the Zephyr Kernel on the supported platforms.
Currently, the |project| supports Linux development systems only. This guide
was tested by compiling and running the |codename|'s sample applications on
was tested by compiling and running the Zephyr Kernel's sample applications on
the following Linux distributions:
* Ubuntu 14.04 LTS 64 bit

4
doc/reference/kbuild/kbuild.rst
View file

@ -3,11 +3,11 @@
Build System User Guide
#######################
The |codename|'s build system is based on the Kbuild system used in the
The Zephyr Kernel's build system is based on the Kbuild system used in the
Linux kernel. This way the kernel embraces the recursive model used in Linux
and the configuration model implemented using Kconfig.
The |codename|'s build process is driven by applications, unlike the Linux Kbuild
The build process is driven by applications, unlike the Linux Kbuild
system. Therefore, the build system requires an application to initiate building
the kernel source code. The build system compiles the kernel and the application
into a single image.

2
doc/reference/kbuild/kbuild_project.rst
View file

@ -10,7 +10,7 @@ Application development can be organized in three independent directories:
the kernel base directory, the project directory, and the project source code
directory.
The |codename|'s base directory hosts the kernel source code, the
The Zephyr Kernel's base directory hosts the kernel source code, the
configuration options, and the kernel build definitions.
The application directory is the directory that puts together the kernel with