Changeset c41810b in rtems-docs


Ignore:
Timestamp:
Jun 13, 2017, 6:17:48 PM (2 years ago)
Author:
Cillian O'Donnell <cpodonnell8@…>
Branches:
master
Children:
c475eef
Parents:
44c9e33
git-author:
Cillian O'Donnell <cpodonnell8@…> (06/13/17 18:17:48)
git-committer:
Chris Johns <chrisj@…> (06/14/17 00:15:37)
Message:

docs/rsb/configuration.rst: Fix typos, grammar.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • rsb/configuration.rst

    r44c9e33 rc41810b  
    116116  XY
    117117
    118 The output of the decompression tool is feed to the standard ``tar`` utility if
     118The output of the decompression tool is fed to the standard ``tar`` utility if
    119119not a ZIP file and unpacked into the build directory. ZIP files are unpacked by
    120120the decompression tool and all other files must be in the tar file format.
     
    122122The ``%source`` directive typically supports a single source file tar or zip
    123123file. The ``set`` command is used to set the URL for a specific source
    124 group. The first set command encoutner is registered and any further set
     124group. The first set command encountered is registered and any further set
    125125commands are ignored. This allows you to define a base standard source location
    126126and override it in build and architecture specific files. You can also add
    127127extra source files to a group. This is typically done when a collection of
    128128source is broken down in a number of smaller files and you require the full
    129 package. The source's ``setup`` command must reide in the ``%prep:`` section
     129package. The source's ``setup`` command must reside in the ``%prep:`` section
    130130and it unpacks the source code ready to be built.
    131131
     
    585585The next section defines the source and any patches. In this case there is a
    586586single source package and it can be downloaded using the HTTP protocol. The RSB
    587 knows this is GZip'ped tar file. If more than one package package is needed add
     587knows this is GZip'ped tar file. If more than one package is needed, add
    588588them increasing the index. The ``gcc-4.8-1.cfg`` configuration contains
    589589examples of more than one source package as well as conditionally including
     
    643643running ``make``. Note the use of the RSB macros for commands. In the case of
    644644``%{__make}`` it maps to the correct make for your host. In the case of BSD
    645 systems we need to use the GNU make and not the GNU make.
     645systems we need to use the BSD make and not the GNU make.
    646646
    647647If your package requires a configuration stage you need to run this before the
     
    750750packages. In this example I cannot let the source builder perform the install
    751751because I never run the RSB with root priviledges so a build set or bset tar
    752 file is created. This can then be installed using root privildges.
     752file is created. This can then be installed using root priviledges.
    753753
    754754The command also supplies the ``--trace`` option. The output in the log file
    755 will contian all the macros.
     755will contain all the macros.
    756756
    757757Debugging
     
    769769technique such as ``set +x`` to output the commands or ``echo``
    770770statements. Debugging package related issues may require you start a build with
    771 teh RSB and supply ``--no-clean`` option and then locate the build directories
     771the RSB and supply ``--no-clean`` option and then locate the build directories
    772772and change directory into them and manually run commands until to figure what
    773773the package requires.
     
    824824
    825825``%patch``:
    826   Define a patch. This macro has a is number appended.
     826  Define a patch. This macro has a number appended.
    827827
    828828``%hash``:
     
    10191019the build will succeed.
    10201020
    1021 The following is an example take from the GutHub STLink project. The STLink is
     1021The following is an example take from the GitHub STLink project. The STLink is
    10221022a JTAG debugging device for the ST ARM family of processors::
    10231023
     
    10791079The ``%install`` macro starts a block that continues until the next block
    10801080macro. The install block is a series of shell commands that execute to install
    1081 the package. You can assume the package has build correctly when this block
     1081the package. You can assume the package has built correctly when this block
    10821082starts executing.
    10831083
     
    11031103  1. Setup the PATH environment variable. This is not always needed.
    11041104
    1105   2. Clean any installed files. This make sure the install is just what the
     1105  2. Clean any installed files. This makes sure the install is just what the
    11061106     package installs and not any left over files from a broken build or
    11071107     install.
     
    11611161~~~~~~~~
    11621162
    1163 The ``%release`` is packaging number that allows revisions of a package to
    1164 happen where none package versions change. This value typically increases when
     1163The ``%release`` is a packaging number that allows revisions of a package to
     1164happen where no package versions change. This value typically increases when
    11651165the configuration building the package changes::
    11661166
     
    11971197requires one or more dependent packages. These are typically the packages
    11981198source code plus dependent libraries or modules. You can create any number of
    1199 these source groups and set each of them up with a separe source group for each
    1200 needed library or module. Each source group normally has a single tar, zip or
    1201 repository and the ``set`` defines this. Some projects split the source code
     1199these source groups and set each of them up with a separate source group for
     1200each needed library or module. Each source group normally has a single tar, zip
     1201or repository and the ``set`` defines this. Some projects split the source code
    12021202into separate tar or zip files and you install them by using the ``add``
    12031203command.
    12041204
    12051205The first instance of a ``set`` command creates the source group and sets the
    1206 source files to be set up. Subsequence ``set`` commands for the same source
     1206source files to be set up. Subsequent ``set`` commands for the same source
    12071207group are ignored. this lets you define the standard source files and override
    12081208them for specific releases or snapshots. To set a source file group:
     
    12591259
    12601260The ``%patch`` macro has the same 3 command as the ``%source`` command however
    1261 the ``set`` commands is not really that useful with the with command. You add
    1262 patches with the ``add`` command and ``setup`` applies the patches. Patch
     1261the ``set`` commands is not really that useful with the ``%patch`` command. You
     1262add patches with the ``add`` command and ``setup`` applies the patches. Patch
    12631263options can be added to each patch by placing them before the patch URL. If no
    12641264patch option is provided the default options passed to the ``setup`` command
     
    12691269control applying a group of patches to a specific source tree.
    12701270
    1271 The ``__patchdir`` path is search.
     1271The ``__patchdir`` path is searched.
    12721272
    12731273To add a patch::
     
    12961296The ``%hash`` macro requires 3 arguments and defines a checksum for a specific
    12971297file. The checksum is not applied until the file is checked before downloading
    1298 and once downloaded. A patch or source file that does not has a hash defined
     1298and once downloaded. A patch or source file that does not have a hash defined
    12991299generates a warning.
    13001300
    1301 A file to be checksum must be unqiue in the any of the source and patch
    1302 directories. The basename of the file is used as the key for the hash.
     1301A file to be checksummed must be unique in the source and patch directories.
     1302The basename of the file is used as the key for the hash.
    13031303
    13041304The hash algorthim can be ``md5``, ``sha1``, ``sha224``, ``sha256``,
     
    13211321create confusion. This does mean files with hashes must be unique.
    13221322
    1323 Downloading of repositories such as git and cvs cannot be checksumed. It is
     1323Downloading off repositories such as git and cvs cannot be checksummed. It is
    13241324assumed those protocols and tools manage the state of the files.
    13251325
     
    13471347The ``%select`` macro selects the map specified. If there is no map no error or
    13481348warning is generated. Macro maps provide a simple way for a user to override
    1349 the settings is a configuration file without having to edit it. The changes are
    1350 recorded in the build report so can be traced.
    1351 
    1352 Configuration use different maps so macro overrides can target a specific
     1349the settings in a configuration file without having to edit it. The changes are
     1350recorded in the build report so they can be traced.
     1351
     1352Configurations use different maps so macro overrides can target a specific
    13531353package.
    13541354
Note: See TracChangeset for help on using the changeset viewer.