docs: fixing typos

catkin · Apr 14, 2016 · accdf1a · accdf1a
1 parent 8547bbf
commit accdf1a
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 32 deletions.
diff --git a/docs/advanced/job_executor.rst b/docs/advanced/job_executor.rst
@@ -105,7 +105,7 @@ In either case, loggers used by stages support segmentation of ``stdout`` and ``
 Command Stages
 ~~~~~~~~~~~~~~~
 
-In addition to the basic arguments mentioned above, command stages are paramterized by the standard sub-process command arguments including the following: 
+In addition to the basic arguments mentioned above, command stages are parameterized by the standard sub-process command arguments including the following: 
 
   - The command, itself, and its arguments,
   - The working directory for the command,

diff --git a/docs/cheat_sheet.rst b/docs/cheat_sheet.rst
@@ -17,7 +17,7 @@ Initialize a workspace with a default layout (``src``/``build``/``devel``) in th
 ... with a default layout in a *different* directory:
   - ``catkin init --workspace /tmp/path/to/my_catkin_ws``
 
-... which explicity extends another workspace:
+... which explicitly extends another workspace:
   - ``catkin config --init --extend /opt/ros/hydro``
 
 Initialize a workspace with a **source space** called ``other_src``:
@@ -32,7 +32,7 @@ Configuring Workspaces
 View the current configuration:
   - ``catkin config``
 
-Setting and un-setting CMake options:
+Setting and unsetting CMake options:
   - ``catkin config --cmake-args -DENABLE_CORBA=ON -DCORBA_IMPLEMENTATION=OMNIORB``
   - ``catkin config --no-cmake-args``
 
@@ -63,7 +63,7 @@ Build the package containing the current working directory:
 ... but don't rebuild its dependencies:
   - ``catkin build --this --no-deps``
 
-Build packages with aditional CMake args:
+Build packages with additional CMake args:
   - ``catkin build --cmake-args -DCMAKE_BUILD_TYPE=Debug``
 
 ... and save them to be used for the next build:
@@ -133,8 +133,8 @@ Change from explicit to implicit chaining:
     catkin clean -a
     catkin config --no-extend
 
-Building With Other Jobservers
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Building With Other Job Servers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Build with ``distcc``:
   .. code-block:: bash

diff --git a/docs/development/adding_build_types.rst b/docs/development/adding_build_types.rst
@@ -7,7 +7,7 @@ The current release of ``catkin_tools`` supports building two types of packages:
   - **CMake** -- "Plain" CMake packages
 
 In order to fully support additional build types, numerous additions need to be made to the command-line interfaces so that the necessary parameters can be passed to the ``build`` verb.
-For partial support, however, all that's needded is to add a build type identifier and a function for generating build jobs.
+For partial support, however, all that's needed is to add a build type identifier and a function for generating build jobs.
 
 The supported build types are easily extendable using the ``setuptools`` ``entry_points`` interface without modifying the ``catkin_tools`` project, itself.
 Regardless of what package the ``entry_point`` is defined in, it will be defined in the ``setup.py`` of that package, and will take this form: 

diff --git a/docs/installing.rst b/docs/installing.rst
@@ -6,7 +6,7 @@ You can install the ``catkin_tools`` package as a binary through a package manag
 .. note::
 
     This project is still in beta and has not been released yet, please install from source.
-    In particular, interface and behaviour are still subject to incompatible changes.
+    In particular, interface and behavior are still subject to incompatible changes.
     If you rely on a stable environment, please use ``catkin_make`` instead of this tool.
 
 Installing on Ubuntu with apt-get

diff --git a/docs/mechanics.rst b/docs/mechanics.rst
@@ -2,8 +2,8 @@ Workspace Mechanics
 ===================
 
 This chapter defines the organization, composition, and use of Catkin workspaces.
-Catkin workspaces enable rapid simulatnous building and executing of numerous interdependent projects.
-These projects do not need to share the sme buildtool, but they do need to be able to either build or install to a FHS tree.
+Catkin workspaces enable rapid simultaneous building and executing of numerous interdependent projects.
+These projects do not need to share the same build tool, but they do need to be able to either build or install to a FHS tree.
 
 Unlike integrated development environments (IDEs) which normally only manage single projects, the purpose of Catkin is to enable the simultaneous compilation of numerous independently-authored projects.
 
@@ -161,8 +161,8 @@ devel space
 Build products like executables, libraries, pkg-config files, and CMake config files, are generated in the **devel space**.
 The **devel space** is organized as an `FHS <https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard>`_ tree.
 
-Some buildtools simply treat the **devel space** as an install prefix, but other buildtools like ``catkin``, itself, can build targets directly into the **devel space** in order to skip the additional install step.
-For such packages, executing programs from the develspace sometimes requires that the source space is still available.
+Some build tools simply treat the **devel space** as an install prefix, but other buildtools like ``catkin``, itself, can build targets directly into the **devel space** in order to skip the additional install step.
+For such packages, executing programs from the **devel space** sometimes requires that the source space is still available.
 
 At the root of the **devel space** is a set of environment setup files which can be "sourced" in order to properly execute the space's products.
 
@@ -187,7 +187,7 @@ It additionally contains a file which lists the name of the active configuration
 Environment Setup Files
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The FHS trees of the **devel space** and **install space** also contain several environemnt "setup" scripts.
+The FHS trees of the **devel space** and **install space** also contain several environment "setup" scripts.
 These setup scripts are intended to make it easier to use the resulting FHS tree for building other source code or for running programs built by the packages in the workspace.
 
 The setup script can be used like this in ``bash``: 

diff --git a/docs/migration.rst b/docs/migration.rst
@@ -5,7 +5,7 @@ Important Distinctions between ``catkin_make`` and ``catkin build``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Unlike ``catkin_make``, the ``catkin`` command-line tool is not just a thin wrapper around a ``CMake`` use pattern.
-The ``catkin build`` command builds each package in a workspace's source space *in isolation* in order to prevent buildtime cross-talk.
+The ``catkin build`` command builds each package in a workspace's source space *in isolation* in order to prevent build-time cross-talk.
 As such, in its simplest use, ``catkin build`` is like a parallelized version of ``catkin_make_isolated``.
 While there are many more features in ``catkin_tools`` described in the rest of the documentation, this chapter provides details on how to switch from using ``catkin_make`` or ``catkin_make_isolated``.
 
@@ -279,4 +279,4 @@ Note that some ``catkin_make`` options can only be achieved with the ``catkin co
        will continue to persist until changed.
 .. [2] These options, if passed to ``catkin build`` only affect that
        invocation. If passed to ``catkin config``, they will persist to
-       subseqent calls to ``catkin build``.
+       subsequent calls to ``catkin build``.
diff --git a/docs/quick_start.rst b/docs/quick_start.rst
@@ -67,7 +67,7 @@ The shell interaction below shows the creation of four empty packages: ``pkg_a``
    :language: bash
    :lines: 5-10
 
-After these operations, your workspace's local directory structure would look like the followng (to two levels deep):
+After these operations, your workspace's local directory structure would look like the following (to two levels deep):
 
 .. literalinclude:: examples/quickstart_ws/1_prebuild.bash
    :language: bash

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -1,23 +1,25 @@
-CMake
-whitelist
-whitelisted
-Whitelisting
-Quickstart
-workflow
-devel
-env
-metadata
+args
+autotools
+buildsystem
+buildtool
 buildtools
+CMake
 config
-devel
 deinitialize
+dependant
 dependants
-args
+devel
+devel
+env
 extendable
-preprocess
-autotools
-prebuild
 internet
-buildtool
 logfile
+metadata
+prebuild
+preprocess
+Quickstart
 unsetting
+whitelist
+whitelisted
+Whitelisting
+workflow
diff --git a/docs/verbs/catkin_build.rst b/docs/verbs/catkin_build.rst
@@ -307,7 +307,7 @@ To achieve this, use a command similar to this:
 
     $ catkin build -v --cmake-args -DCMAKE_C_FLAGS="-Wall -W -Wno-unused-parameter"
 
-This command passes the ``-DCMAKE_C_FLAGS=...`` arugment to all invocations of ``cmake``.
+This command passes the ``-DCMAKE_C_FLAGS=...`` argument to all invocations of ``cmake``.
 
 
 Configuring Build Jobs