summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Gielda <mgielda@antmicro.com>2014-04-08 23:39:37 +0200
committerMichael Gielda <mgielda@antmicro.com>2014-04-08 23:39:37 +0200
commitbb9fcbd298554eb078809daf8760c9137b603cd9 (patch)
tree5a13fbcad2c068f0f003a8c9609363d876fa80f9
parent3abc80df11f1725e9aaf1ea0c1e4cd0aaf12b326 (diff)
Reduced use of :abbr:
-rw-r--r--doc/source/appendix-a.rst10
-rw-r--r--doc/source/appendix-b.rst6
-rw-r--r--doc/source/building.rst12
-rw-r--r--doc/source/introduction.rst2
4 files changed, 15 insertions, 15 deletions
diff --git a/doc/source/appendix-a.rst b/doc/source/appendix-a.rst
index 3d456c2..b38018c 100644
--- a/doc/source/appendix-a.rst
+++ b/doc/source/appendix-a.rst
@@ -3,7 +3,7 @@ Appendix A: custom eCos configuration
ECos is called a *configurable* system for a reason: it contains a powerful infrastructure for choosing what system components and abstractions are included and how they are configured.
-This Appendix will describe briefly how to deal with :abbr:`.ecc` files for the Colibri VF61.
+This Appendix will describe briefly how to deal with ``.ecc`` files for the Colibri VF61.
Background
----------
@@ -30,7 +30,7 @@ Templates
:program:`configtool` allows the user to build the system however they want using a graphical user interface, provided constraints in :file:`.cdl` files describing the system structure are maintained.
-While creating a new :abbr:`.ecc` file it is easier to also use a predefined template representing common use scenarios, such as **posix** which represents a system which has all the necessary packages to run typical POSIX programs or **redboot** which understandably is used to build a binary of RedBoot, the eCos bootloader.
+While creating a new ``.ecc`` file it is easier to also use a predefined template representing common use scenarios, such as **posix** which represents a system which has all the necessary packages to run typical POSIX programs or **redboot** which understandably is used to build a binary of RedBoot, the eCos bootloader.
In order to select a template to base upon, use :menuselection:`build --> templates`.
@@ -38,7 +38,7 @@ In order to select a template to base upon, use :menuselection:`build --> templa
Remember that the templates are just general scenarios, which may contain settings incompatible with the desired ones (baudrates, console mangling, debug console choice, presence of RedBoot ROM monitor). It is necessary to tweak them according to your needs.
-Preparing an :abbr:`.ecc` file using :program:`configtool`
+Preparing an ``.ecc`` file using :program:`configtool`
----------------------------------------------------------
Launch :program:`configtool`.
@@ -47,7 +47,7 @@ Select :menuselection:`build --> repository` specify the path to eCos repository
Select the :menuselection:`build --> template` option and choose the :guilabel:`Toradex Colibri VF61` as your hardware platform with default set of packages.
Click :guilabel:`continue` to proceed.
-When the default set of packages is used for the platform, the associated :abbr:`.ecc` file can already be prepared.
+When the default set of packages is used for the platform, the associated ``.ecc`` file can already be prepared.
Save it in a directory accessible by your build script and **remember to point to it in** :ref:`the kernel build script <build-kernel>`.
Other packages can be added from :menuselection:`build --> packages`, bear in mind that you may need to alter the chosen packages and options to satisfy some ``.cdl`` constraints.
@@ -58,7 +58,7 @@ Startup memory choice
---------------------
There are three memories from which eCos software may be launched in Colibri VF61.
-This is determined in the :abbr:`.ecc` file the eCos kernel was based on.
+This is determined in the ``.ecc`` file the eCos kernel was based on.
By default the software is prepared to be launched from OnChip RAM (OCRAM).
Alternatively DRAM memory may be used for booting.
diff --git a/doc/source/appendix-b.rst b/doc/source/appendix-b.rst
index 49da58e..4e34b7b 100644
--- a/doc/source/appendix-b.rst
+++ b/doc/source/appendix-b.rst
@@ -12,10 +12,10 @@ POSIX
-----
:abbr:`POSIX (Portable Operating System Interface)`, is a well-known family of OS standards.
-:abbr:`POSIX` defines the primitives, nomenclature and API which makes it easier to provide software compliance between operating systems.
+POSIX defines the primitives, nomenclature and API which makes it easier to provide software compliance between operating systems.
This is especially useful with regard to programming heterogeneous devices like the Colibri VF61,
-where (especially with the :abbr:`POSIX` compatibility layer enabled),
+where (especially with the POSIX compatibility layer enabled),
the programming style for eCos applications dedicated for the Cortex-M4 core can vastly resemble that of Linux programs running on the Cortex-A5 core,
lowering the entry barrier for programmers.
@@ -41,6 +41,6 @@ To activate this package, use either :program:`ecosconfig` (``ecosconfig add CYG
#. Choose :menuselection:`Build --> Packages`
#. Select :guilabel:`uITRON compatibility` and click :guilabel:`Add >>`, then :guilabel:`OK`
-#. A new package, ``uITRON compatibility layer`` should appear in the package list - save your :abbr:`.ecc` file and exit.
+#. A new package, ``uITRON compatibility layer`` should appear in the package list - save your ``.ecc`` file and exit.
A sample application, verified to work as expected using the port can be found inside the port code, in the subdirectory :file:`compat/uitron/current/tests/test3.c`
diff --git a/doc/source/building.rst b/doc/source/building.rst
index 8a8d801..6aed707 100644
--- a/doc/source/building.rst
+++ b/doc/source/building.rst
@@ -60,7 +60,7 @@ Now you can download and use :program:`ecosconfig`. You also need to make :progr
.. note::
- A `handbook on ecosconfig <http://ecos.sourceware.org/docs-3.0/user-guide/using-ecosconfig-on-linux.html>`_ exists to help in the manual creation of :abbr:`.ecc` files.
+ A `handbook on ecosconfig <http://ecos.sourceware.org/docs-3.0/user-guide/using-ecosconfig-on-linux.html>`_ exists to help in the manual creation of ``.ecc`` files.
Also, if you want to create custom eCos configuration files, see :doc:`appendix-a`.
Source code
@@ -74,11 +74,11 @@ The source of the port can be downloaded by using the following command:
git clone https://github.com/mgielda/ecos-colibri-vf61.git
-Preparing an :abbr:`.ecc` file
-------------------------------
+Preparing an ``.ecc`` file
+--------------------------
The actual configuration of the eCos system is maintained and modified through :program:`ecosconfig`.
-The following commands will prepare a sample :abbr:`.ecc` file for a kernel with default settings.
+The following commands will prepare a sample ``.ecc`` file for a kernel with default settings.
.. topic:: Generating the kernel ecc file from scratch
@@ -89,7 +89,7 @@ The following commands will prepare a sample :abbr:`.ecc` file for a kernel with
ecosconfig new col_vf61 default
You now have a ``ecos.ecc`` file that holds the default eCos configuration for Colibri VF61.
-The file can be further edited manually with a text editor and/or :program:`ecosconfig` or graphically using :program:`configtool` (see :ref:`custom-config`), but at this moment it is already enough to compile a sample eCos kernel.
+The file can be further edited manually with a text editor and/or :program:`ecosconfig` or graphically using :program:`configtool` (see :doc:`appendix-a`), but at this moment it is already enough to compile a sample eCos kernel.
.. _build-kernel:
@@ -99,7 +99,7 @@ Building the kernel
The eCos kernel is built in two stages:
* first, a so-called *build tree* is generated from the eCos sources by :program:`ecosconfig`.
- The build tree is customized for your build as configured in the :abbr:`.ecc` file used.
+ The build tree is customized for your build as configured in the ``.ecc`` file used.
It is best to generate the build tree in a separate directory (here ``build-tree``).
* then, the source files are compiled
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 965c35e..b00dabb 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -9,7 +9,7 @@ The eCos port is targeted for the Cortex-M core of the heterogeneous Vybrid CPU,
ECos
----
-ECos is a configurable real-time operating system intended for use in embedded applications.
+ECos is a configurable RTOS intended for use in embedded applications.
The documentation for eCos 3.0, which is the most recent version of the system as well as the one ported to Colibri VF61, can be found at http://ecos.sourceware.org/docs-3.0/.
A comprehensive PDF `eCos Reference Guide`_ is also available from the eCos website.