[PATCH] Fix typos in rtems-docs-4.11/rsb

Tue Mar 31 16:09:57 UTC 2020

Hi Mritunjay,

Are these all fixed already in master branch? these docs moved to user/rsb/*

On Tue, Mar 31, 2020 at 4:22 AM Mritunjay <mritunjaysharma394 at gmail.com> wrote:
>
> ---
>
> This patch fixes typos encountered while going through the documentation
> of rtems-docs-4.11/rsb.
>
>  rsb/configuration.rst        | 24 ++++++++++++------------
>  rsb/cross-canadian-cross.rst |  2 +-
>  rsb/hosts.rst                |  4 ++--
>  rsb/project-sets.rst         |  4 ++--
>  rsb/quick-start.rst          |  6 +++---
>  rsb/third-party-packages.rst |  4 ++--
>  6 files changed, 22 insertions(+), 22 deletions(-)
>
> diff --git a/rsb/configuration.rst b/rsb/configuration.rst
> index 62fc073..bf3dfaa 100644
> --- a/rsb/configuration.rst
> +++ b/rsb/configuration.rst
> @@ -121,12 +121,12 @@ the decompression tool and all other files must be in the tar file format.
>
>  The ``%source`` directive typically supports a single source file tar or zip
>  file. The ``set`` command is used to set the URL for a specific source
> -group. The first set command encoutner is registered and any further set
> +group. The first set command encounter is registered and any further set
>  commands are ignored. This allows you to define a base standard source location
>  and override it in build and architecture specific files. You can also add
>  extra source files to a group. This is typically done when a collection of
>  source is broken down in a number of smaller files and you require the full
> -package. The source's ``setup`` command must reide in the ``%prep:`` section
> +package. The source's ``setup`` command must reside in the ``%prep:`` section
>  and it unpacks the source code ready to be built.
>
>  If the source URL references the GitHub API server https://api.github.com/ a
> @@ -180,7 +180,7 @@ errors that can arise.
>
>  The protocol option lets you set a specific protocol. The ``git://`` prefix
>  used by the RSB to select a git repository can be removed using *none* or
> -replaced with one of the standard git protcols.
> +replaced with one of the standard git protocols.
>
>  CVS
>  ~~~
> @@ -304,7 +304,7 @@ Maps are declared anywhere in the map using the map directive::
>
>    1. The map is set to ``my-special-map``.
>
> -Any macro defintions following a map declaration are placed in that map and the
> +Any macro definitions following a map declaration are placed in that map and the
>  default map is ``global`` when loading a file. Maps are selected in
>  configuration files by using the ``%select`` directive::
>
> @@ -315,7 +315,7 @@ if present return that value else the ``global`` map is used. Any new macros or
>  changes update only the ``global`` map. This may change in future releases so
>  please make sure you use the ``override`` attribute.
>
> -The macro files specificed on the command line are looked for in the
> +The macro files specified on the command line are looked for in the
>  ``_configdir`` paths. See <<X1,``_configdir``>> variable for details. Included
>  files need to add the ``%{_configdir}`` macro to the start of the file.
>
> @@ -494,7 +494,7 @@ To create a private configuration change to a suitable directory::
>
>  and create a ``config`` directory. Here you can add a new configuration or
>  build set file. The section 'Adding New Configurations' details how to add a
> -new confguration.
> +new configuration.
>
>  New Configurations
>  ------------------
> @@ -597,8 +597,8 @@ source packages based on the outer configuration options::
>  The remainder of the script is broken in to the various phases of a build. They
>  are:
>
> -. Preperation
> -. Bulding
> +. Preparation
> +. Building
>  . Installing, and
>  . Cleaning
>
> @@ -748,11 +748,11 @@ To build this you can use something similar to::
>
>  The build is for a FreeBSD host and the prefix is for user installed
>  packages. In this example I cannot let the source builder perform the install
> -because I never run the RSB with root priviledges so a build set or bset tar
> -file is created. This can then be installed using root privildges.
> +because I never run the RSB with root privileges so a build set or bset tar
> +file is created. This can then be installed using root privileges.
>
>  The command also supplies the ``--trace`` option. The output in the log file
> -will contian all the macros.
> +will contain all the macros.
>
>  Debugging
>  ~~~~~~~~~
> @@ -1320,7 +1320,7 @@ Do not include a path with the file name. Only the basename is required. Files
>  can be searched for from a number of places and having a path conponent would
>  create confusion. This does mean files with hashes must be unique.
>
> -Downloading of repositories such as git and cvs cannot be checksumed. It is
> +Downloading of repositories such as git and cvs cannot be checksummed. It is
>  assumed those protocols and tools manage the state of the files.
>
>  %echo
> diff --git a/rsb/cross-canadian-cross.rst b/rsb/cross-canadian-cross.rst
> index d4fce9e..039c7a7 100644
> --- a/rsb/cross-canadian-cross.rst
> +++ b/rsb/cross-canadian-cross.rst
> @@ -36,7 +36,7 @@ To build the NTP package for RTEMS you enter the RSB command::
>
>    2. The ``--host`` command is the RTEMS architecture and version.
>
> -  3. The BSP is built and installed in the prefix. The arhcitecture must match
> +  3. The BSP is built and installed in the prefix. The architecture must match
>       the ``--host`` architecture.
>
>  .. note: Installing Into Different Directories
> diff --git a/rsb/hosts.rst b/rsb/hosts.rst
> index a4226f3..ebcca23 100644
> --- a/rsb/hosts.rst
> +++ b/rsb/hosts.rst
> @@ -14,7 +14,7 @@ new version of a host is known to work and it not listed please lets us know.
>  Linux
>  -----
>
> -A number of different Linux distrubutions are known to work. The following have
> +A number of different Linux distributions are known to work. The following have
>  been tested and report as working.
>
>  .. _ArchLinux:
> @@ -122,7 +122,7 @@ ports::
>      # portinstall --batch devel/mingw32-binutils devel/mingw32-gcc
>      # portinstall --batch devel/mingw32-zlib devel/mingw32-pthreads
>
> -The +zlip+ and +pthreads+ ports for MinGW32 are used for builiding a Windows
> +The +zlip+ and +pthreads+ ports for MinGW32 are used for building a Windows
>  QEMU.
>
>  If you are on FreeBSD 10.0 and you have pkgng installed you can use 'pkg
> diff --git a/rsb/project-sets.rst b/rsb/project-sets.rst
> index 8abd080..6ca27e7 100644
> --- a/rsb/project-sets.rst
> +++ b/rsb/project-sets.rst
> @@ -159,7 +159,7 @@ tools within that release. If the package is not specific to any release the
>  patch can be added closer to the top under the package's name. Patches to fix
>  specific tool related issues for a specific architecture should be grouped
>  under the specific architecture and only applied when building that
> -architecture avoiding a patch breaking an uneffected architecture.
> +architecture avoiding a patch breaking an unaffected architecture.
>
>  Patches in the RTEMS Tools repository need to be submitted to the upstream
>  project. It should not be a clearing house for patches that will not be
> @@ -169,7 +169,7 @@ Patches are added to a component's name and in the ``%prep:`` section the
>  patches can be set up, meaning they are applied to source. The patches
>  are applied in the order they are added. If there is a dependency make
>  sure you order the patches correctly when you add them. You can add any
> -number of patches and the RSB will handle them efficently.
> +number of patches and the RSB will handle them efficiently.
>
>  Patches can have options. These are added before the patch URL. If no options
>  are provided the patch's setup default options are used.
> diff --git a/rsb/quick-start.rst b/rsb/quick-start.rst
> index f39c0a6..e39a914 100644
> --- a/rsb/quick-start.rst
> +++ b/rsb/quick-start.rst
> @@ -429,7 +429,7 @@ A build set tar file is created by adding ``--bset-tar-file`` option to the
>    3. Creating the build set tar file.
>
>  You can also suppress installing the files using the ``--no-install``
> -option. This is useful if your prefix is not accessiable, for example when
> +option. This is useful if your prefix is not accessible, for example when
>  building Canadian cross compiled tool sets::
>
>      $ ../source-builder/sb-set-builder --log=l-sparc.txt \
> @@ -462,7 +462,7 @@ building Canadian cross compiled tool sets::
>
>  .. topic:: Items
>
> -  1. The option to supressing installing the packages.
> +  1. The option to suppressing installing the packages.
>
>    2. Create the build set tar.
>
> @@ -517,7 +517,7 @@ because they are implemented with the configuration scripts. The best way to
>  find what is available is to grep the configuration files. for ``with`` and
>  ``without``.
>
> -Following are currentlt available:
> +Following are currently available:
>
>  ``--without-rtems``
>    Do not build RTEMS when building an RTEMS build set.
> diff --git a/rsb/third-party-packages.rst b/rsb/third-party-packages.rst
> index a43abeb..1ef7c68 100644
> --- a/rsb/third-party-packages.rst
> +++ b/rsb/third-party-packages.rst
> @@ -66,7 +66,7 @@ this may require you asking questions on the package's user or development
>  support lists as well as RTEMS's developers list. Your porting effort may end
>  up with a patch. RTEMS requires a patch be submitted upstream to the project's
>  community as well as RTEMS so it can be added to the RTEMS Tools git
> -repository. A patch in the RTEMS Tools git reposiitory can then be referenced
> +repository. A patch in the RTEMS Tools git repository can then be referenced
>  by an RSB configuration file.
>
>  A package may create executables, for example NTP normally creates executables
> @@ -75,7 +75,7 @@ when testing the package however they are of limited use by RTEMS users because
>  they cannot be directly linked into a user application. Users need to link to
>  the functions in these executables or even the executable as a function placed
>  in libraries. If the package does not export the code in a suitable manner
> -please contact the project's commuinity and see if you can work them to provide
> +please contact the project's community and see if you can work them to provide
>  a way for the code to be exported. This may be difficult because exporting
>  internal headers and functions opens the project up to API compatibility issues
>  they did not have before. In the simplest case attempting to get the code into
> --
> 2.17.1
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel