[rtems-docs commit] Shorten the name of the BSP and Device Driver Development Guide

Joel Sherrill joel at rtems.org
Thu Oct 12 23:53:50 UTC 2017


Module:    rtems-docs
Branch:    master
Commit:    c6f8e512b916147faae59687d13611291ef0f426
Changeset: http://git.rtems.org/rtems-docs/commit/?id=c6f8e512b916147faae59687d13611291ef0f426

Author:    Joel Sherrill <joel at rtems.org>
Date:      Thu Oct 12 18:50:59 2017 -0500

Shorten the name of the BSP and Device Driver Development Guide

Old name:

    RTEMS BSP and Device Driver Development Guide

This is long and causes problems in the PDF output. This patch
changes the name to:

    RTEMS BSP and Driver Guide

Closes #3141.

---

 bsp-howto/conf.py                  | 2 +-
 bsp-howto/index.rst                | 6 +++---
 cpu-supplement/lattice_micro32.rst | 8 +-------
 cpu-supplement/port.rst            | 8 ++++----
 develenv/directory.rst             | 4 ++--
 5 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/bsp-howto/conf.py b/bsp-howto/conf.py
index 721f63f..b245466 100644
--- a/bsp-howto/conf.py
+++ b/bsp-howto/conf.py
@@ -8,7 +8,7 @@ project = "RTEMS BSP and Device Driver Development Guide"
 latex_documents = [
     ('index',
      'bsp-howto.tex',
-     u'RTEMS BSP and Device Driver Development Guide',
+     u'RTEMS BSP and Driver Guide',
      u'RTEMS Documentation Project',
      'manual'),
 ]
diff --git a/bsp-howto/index.rst b/bsp-howto/index.rst
index e46773c..9d4e5ad 100644
--- a/bsp-howto/index.rst
+++ b/bsp-howto/index.rst
@@ -1,8 +1,8 @@
 .. comment SPDX-License-Identifier: CC-BY-SA-4.0
 
-==========================================================
-RTEMS BSP and Device Driver Development Guide (|version|).
-==========================================================
+=======================================
+RTEMS BSP and Driver Guide (|version|).
+=======================================
 
  | **COPYRIGHT (c) 1988 - 2015.**
  | **On-Line Applications Research Corporation (OAR).**
diff --git a/cpu-supplement/lattice_micro32.rst b/cpu-supplement/lattice_micro32.rst
index 07be31c..ba3ab9d 100644
--- a/cpu-supplement/lattice_micro32.rst
+++ b/cpu-supplement/lattice_micro32.rst
@@ -186,13 +186,7 @@ Thread-local storage is not implemented.
 Board Support Packages
 ======================
 
-An RTEMS Board Support Package (BSP) must be designed to support a particular
-processor model and target board combination.
-
-In each of the architecture specific chapters, this section will present a
-discussion of architecture specific BSP issues.  For more information on
-developing a BSP, refer to BSP and Device Driver Development Guide and the
-chapter titled Board Support Packages in the RTEMS Applications User's Guide.
+There are no Lattice Micro32 specific notes on BSPs.
 
 System Reset
 ------------
diff --git a/cpu-supplement/port.rst b/cpu-supplement/port.rst
index 68c1471..dec91a7 100644
--- a/cpu-supplement/port.rst
+++ b/cpu-supplement/port.rst
@@ -408,8 +408,8 @@ processor model and target board combination.
 
 In each of the architecture specific chapters, this section will present a
 discussion of architecture specific BSP issues.  For more information on
-developing a BSP, refer to BSP and Device Driver Development Guide and the
-chapter titled Board Support Packages in the RTEMS Applications User's Guide.
+developing a BSP, refer to *RTEMS BSP and Driver Guide* chapter titled
+``Board Support Packages`` in the *RTEMS Classic API Guide*.
 
 System Reset
 ------------
@@ -418,5 +418,5 @@ An RTEMS based application is initiated or re-initiated when the processor is
 reset or transfer is passed to it from a boot monitor or ROM monitor.
 
 In each of the architecture specific chapters, this subsection describes the
-actions that the BSP must tak assuming the application gets control when the
-microprocessor is reset.
+actions that the BSP must take assuming the application gets control
+when the microprocessor is reset.
diff --git a/develenv/directory.rst b/develenv/directory.rst
index b2d1ebd..08c58ad 100644
--- a/develenv/directory.rst
+++ b/develenv/directory.rst
@@ -91,7 +91,7 @@ the RTEMS source tree.  The top of the tree will be referenced as
     subdirectory.  Each ".cfg" file in this directory is associated with a
     specific BSP and describes the CPU model, compiler flags, and procedure to
     produce an executable for the target board.  These files are described in
-    detail in the*RTEMS BSP and Device Driver Development Guide* and will not
+    detail in the *RTEMS BSP and Driver Guide* and will not
     be discussed further in this document.
 
 ``${RTEMS_ROOT}/testsuites/``
@@ -159,7 +159,7 @@ the subdirectories in this directory and a description of each.
     specific source code for RTEMS.  The ``libbsp/`` is organized based upon
     the CPU family and boards BSPs.  The contents of ``libbsp/`` are discussed
     briefly in `c/src/lib/libbsp BSP Directory`_ and presented in detail in
-    the*RTEMS BSP and Device Driver Development Guide*.  The ``libcpu/``
+    the *RTEMS BSP and Driver Guide*.  The ``libcpu/``
     directory is also organized by CPU family with further divisions based upon
     CPU model and features that are shared across CPU models such as caching
     and DMA.




More information about the vc mailing list