Changeset 47aad7a in rtems-docs


Ignore:
Timestamp:
Oct 30, 2016, 9:18:29 PM (4 years ago)
Author:
Joel Sherrill <joel@…>
Branches:
4.11, 5, am, master
Children:
dd43d0b
Parents:
cddb06c
Message:

RSB: Make the bullet style more consistent.

Location:
rsb
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • rsb/conf.py

    rcddb06c r47aad7a  
    77release = '4.11.0'
    88
    9 project = "RTEMS C User Manual"
     9project = "RTEMS Source Builder Manual"
    1010
    1111latex_documents = [
    12         ('index', 'c_user.tex', u'RTEMS C User Documentation', u'RTEMS Documentation Project', 'manual'),
     12        ('index', 'c_user.tex', u'RTEMS C Source Builder', u'RTEMS Documentation Project', 'manual'),
    1313]
  • rsb/source-builder.rst

    rcddb06c r47aad7a  
    6868problem please ask on the RTEMS Users mailing list.
    6969
     70.. comment: TBD: The section "Installing and Tar Files" does not exist.
     71
    7072This documentation caters for a range of users from new to experienced RTEMS
    7173developers. New users can follow the Quick Start section up to the "Installing
     
    108110.. note:: Host Setup
    109111    IMPORTANT: Before proceeding to the next section please refer to the
    110     <<_host_setups,host specific setup>> for your host and install any extra
     112    :ref:`Host Setups` for your host and install any extra
    111113    packages. The RSB assumes the needed packages are installed and work.
    112114
     
    195197standard tool. It maybe ok or it could be buggy, only you can determine this.
    196198
    197 The <<_host_setups,Host Setups>> section lists packages you should install for
    198 common host operating systems. It maybe worth checking if you have those
    199 installed.
     199The :ref:`Host Setups` section lists packages you should install for
     200common host operating systems. It maybe worth checking if you have
     201those installed.
    200202
    201203Build Sets
     
    550552    rtems-4.11-sparc-rtems4.11-1.tar.bz2
    551553
    552 * *<1>* The option to supressing installing the packages.
    553 
    554 * *<2>* Create the build set tar.
     554- *<1>* The option to supressing installing the packages.
     555
     556- *<2>* Create the build set tar.
    555557
    556558A package tar file can be created by adding the ``--pkg-tar-files`` to the
     
    695697If for some reason there is no report please send please report the following:
    696698
    697 * Command line,
    698 
    699 * The git hash,
    700 
    701 * Host details with the output of the ``uname -a`` command,
    702 
    703 * If you have made any modifications.
     699- Command line,
     700
     701- The git hash,
     702
     703- Host details with the output of the ``uname -a`` command,
     704
     705- If you have made any modifications.
    704706
    705707If there is a Python crash please cut and paste the Python backtrace
     
    10261028tools needed by the RSB are:
    10271029
    1028 * Build host C and C++ compiler
    1029 * Host C and C++ cross compiler
     1030- Build host C and C++ compiler
     1031
     1032- Host C and C++ cross compiler
    10301033
    10311034The RTEMS Source Builder requires you provide the build host C and C++
     
    11441147A package requires 3 files to be created:
    11451148
    1146 * The first file is the RTEMS build set file and it resides in the
     1149- The first file is the RTEMS build set file and it resides in the
    11471150  ``$$rtems/config/%{rtems_version}$$`` path in a directory tree based on the
    11481151  FreeBSD ports collection. For the NTP package and RTEMS 4.11 this is
     
    11531156  requires changing the build set to the new configuration file.
    11541157
    1155 * The second file is an RTEMS version specific configuration file
     1158- The second file is an RTEMS version specific configuration file
    11561159  and it includes the RSB RTEMS BSP support. These configuration
    11571160  files reside in the ``rtems/config`` tree again under the FreeBSD
     
    11641167  common configuration file tree.
    11651168
    1166 * The build configuration. This is a common script that builds the package. It
     1169- The build configuration. This is a common script that builds the package. It
    11671170  resides in the ``source-builder/config`` directory and typically has the
    11681171  packages's name with the major version number. If the build script does not
     
    13951398The RTEMS Source Builder has two types of configuration data:
    13961399
    1397 * Build Sets
    1398 
    1399 * Package Build Configurations
     1400- Build Sets
     1401
     1402- Package Build Configurations
    14001403
    14011404By default these files can be located in two separate directories and
     
    15181521the options with ``=``. The options are:
    15191522
    1520 ``protocol``:: Use a specific protocol. The supported values are *ssh*, *git*,
    1521 *http*, *https*, *ftp*, *ftps*, *rsync*, and *none*.
    1522 ``branch``:: Checkout the specified branch.
    1523 ``pull``:: Perform a pull to update the repository.
    1524 ``fetch``:: Perform a fetch to get any remote updates.
    1525 ``reset``:: Reset the repository. Useful to remove any local changes. You can
    1526 pass the ``hard`` argument to force a hard reset.
     1523- ``protocol``:: Use a specific protocol. The supported values are *ssh*,
     1524  *git*, *http*, *https*, *ftp*, *ftps*, *rsync*, and *none*.
     1525
     1526- ``branch``:: Checkout the specified branch.
     1527
     1528- ``pull``:: Perform a pull to update the repository.
     1529
     1530- ``fetch``:: Perform a fetch to get any remote updates.
     1531
     1532- ``reset``:: Reset the repository. Useful to remove any local
     1533  changes. You can pass the ``hard`` argument to force a hard reset.
    15271534
    15281535.. code-block: shell
     
    17021709monitoring. Mailing requires a number of parameters to function. These are:
    17031710
    1704 * To mail address
    1705 
    1706 * From mail address
    1707 
    1708 * SMTP host
     1711- To mail address
     1712
     1713- From mail address
     1714
     1715- SMTP host
    17091716
    17101717.To Mail Address
     
    17181725The ``from`` mail address is taken from:
    17191726
    1720 * GIT configuration
    1721 
    1722 * User ``.mailrc`` file
    1723 
    1724 * Command line
     1727- GIT configuration
     1728
     1729- User ``.mailrc`` file
     1730
     1731- Command line
    17251732
    17261733If you have configured an email and name in git it will be used used. If you do
     
    21652172
    21662173The process uses snapshot macro files loaded via the command line option
    2167 ``--macros``. These files provide macros that override the standard build set and
    2168 configuration file macros.
     2174``--macros``. These files provide macros that override the standard
     2175build set and configuration file macros.
    21692176
    21702177Lets consider testing a GCC 4.7 snapshot for RTEMS 4.11. Lets assume the
     
    31763183    --list-configs         : List available configurations
    31773184
     3185.. _Host Setups:
     3186
    31783187Host Setups
    31793188###########
Note: See TracChangeset for help on using the changeset viewer.