Skip to content

Commit

Permalink
rename prefix script into local_setup (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
dirk-thomas committed May 4, 2018
1 parent 2dba10b commit 4761a96
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions developer/bootstrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ In the first build we will use the minimal features provided by ``colcon-core``
$ ./src/colcon-core/bin/colcon build --paths src/*
The build of the packages will run sequentially and for each package the output will be printed directly to the console.
The install directory will contain a ``prefix.sh`` (or ``.bat`` on Windows).
The install directory will contain a ``local_setup.sh`` (or ``.bat`` on Windows).

In order to generate scripts for additional shells the set of packages have to be built a second time but this time using all extension provided by the various cloned packages.

Expand All @@ -64,7 +64,7 @@ Build the sources - second time

.. code-block:: bash
$ . install/prefix.sh
$ . install/local_setup.sh
$ colcon build
.. note::
Expand All @@ -77,7 +77,7 @@ To use the full functionality you can source the generated script for your shell

.. code-block:: bash
$ . install/prefix.bash
$ . install/local_setup.bash
.. note::

Expand Down
8 changes: 4 additions & 4 deletions user/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following is an example workflow and sequence of commands using default sett
$ colcon build # Build all packages in the workspace
$ catkin test # Test all packages in the workspace
$ catkin test-result --all # Enumerate all test results
$ . install/prefix.bash # Setup the environment to use the built packages
$ . install/local_setup.bash # Setup the environment to use the built packages
$ <...> # Use the built packages
The most commonly used arguments for the ``build`` and ``test`` verbs are to only process a specific package or a specific package including all the recursive dependencies it needs.
Expand Down Expand Up @@ -47,7 +47,7 @@ Instead of invoking ``ament build`` you can invoke ``colcon``.
$ colcon build
In order to use the built packages you need to source the ``install/prefix.<ext>`` rather than the ``local_setup.<ext>`` script mentioned in the instructions.
In order to use the built packages you need to source the ``install/local_setup.<ext>`` script mentioned in the instructions.

For detailed information how command line arguments of ``ament_tools`` are mapped to ``colcon`` please see the :doc:`ament_tools migration guide <../migration/ament_tools>`.

Expand All @@ -68,7 +68,7 @@ Instead of invoking ``catkin_make_isolated --install`` you can invoke ``colcon``
``colcon`` does by design not support the concept of a "devel space" as it exists in ROS 1.
Instead it requires each package to be installed so each package must declare an install step in order to work with ``colcon``.

In order to use the built packages you need to source the ``install/prefix.<ext>`` rather than the ``setup.<ext>`` script mentioned in the instructions.
In order to use the built packages you need to source the ``install/local_setup.<ext>`` rather than the ``setup.<ext>`` script mentioned in the instructions.

For detailed information how command line arguments of ``catkin_make_isolated`` are mapped to ``colcon`` please see the :doc:`catkin_make_isolated migration guide <../migration/catkin_make_isolated>`.
For detailed information how command line arguments of ``catkin_tools`` are mapped to ``colcon`` please see the :doc:`catkin_tools migration guide <../migration/catkin_tools>`.
Expand Down Expand Up @@ -107,5 +107,5 @@ Using the additional metadata the source script will also automatically source t

.. code-block:: bash
$ . install/prefix.bash
$ . install/local_setup.bash
$ gazebo

0 comments on commit 4761a96

Please sign in to comment.