Added warning text to quick-start.rst

docs/tutorials/quick-start.rst

@@ -3,8 +3,10 @@ Quick start with RosTeamWorkspace
 ==================================
 .. _tutorial-quick-start:
 
-This tutorial shows use of RosTeamWorkspace for very common use-cases that can be done without permanent changes to your environment.
-First you have to clone and source the workspace and then continue with the use-case you are interested in:
+This tutorial shows use of RosTeamWorkspace for very common use-cases that can
+be done without permanent changes to your environment. First you have to clone
+and source the workspace and then continue with the use-case you are
+interested in:
 
 .. toctree::
    :maxdepth: 1
@@ -36,9 +38,13 @@ For more details check :ref:`use-case description <uc-new-package>`.
 
 Create robot description package
 -------------------------------------------------
-For more details check :ref:`use-case description <uc-setup-robot-description>`.
+For more details check
+:ref:`use-case description <uc-setup-robot-description>`.
 
-requirement: have a <my_cool_robot_description_package_name> package to hold the robot description
+.. warning::
+
+   You must have a <my_cool_robot_description_package_name> package of
+   build type **ament_cmake** to hold the robot description.
 
 .. code-block:: bash
 
@@ -52,7 +58,9 @@ Create robot bringup package
 -----------------------------------------------
 For more details check :ref:`use-case description <uc-setup-robot-bringup>`.
 
-requirement: have a <my_cool_robot_bringup_package_name> package to hold the robot bringup
+.. warning::
+   You must have a <my_cool_robot_bringup_package_name> package of
+   build type **ament_cmake** to hold the robot bringup.
 
 .. code-block:: bash
 
@@ -64,9 +72,13 @@ requirement: have a <my_cool_robot_bringup_package_name> package to hold the rob
 
 Setup  ros2_control control hardware
 -------------------------------------------------
-For more details check :ref:`use-case description <uc-setup-ros2-control-hardware>`.
+For more details check
+:ref:`use-case description <uc-setup-ros2-control-hardware>`.
 
-requirement: have a <my_cool_robot_control_package_name> package to hold the robot's ros2_control hardware interface
+.. warning::
+   You must have a <my_cool_robot_control_package_name> package of
+   build type **ament_cmake** to hold the robot's ros2_control
+   hardware interface.
 
 .. code-block:: bash
 
@@ -80,7 +92,9 @@ Setup  ros2_control controller
 -----------------------------------------------
 For more details check :ref:`use-case description <uc-setup-ros2-controller>`.
 
-requirement: have a <my_cool_robot_controller_package_name> package to hold the robot's ros2_control controller
+.. warning::
+   You must have a <my_cool_robot_controller_package_name> package of
+   build type **ament_cmake** to hold the robot's ros2_control controller.
 
 .. code-block:: bash
 

docs/use-cases/ros2_control/setup_controller.rst

@@ -3,13 +3,18 @@ ros2_control: Setup controller package
 =======================================================
 .. _uc-setup-ros2-controller:
 
-This use-case describes how to set up a controller for the ros2_control framework using scripts from ROS Team Workspace (RosTeamWS) framework.
-The scripts uses template files from ``templates/ros2_control/controller`` folder.
-The script creates a full skeleton of a controller with plugin description and tests for loading controller and checking its basic functionality.
+This use-case describes how to set up a controller for the ros2_control
+framework using scripts from ROS Team Workspace (RosTeamWS) framework.
+The scripts uses template files from
+``templates/ros2_control/controller`` folder.
+The script creates a full skeleton of a controller with plugin description
+and tests for loading controller and checking its basic functionality.
 
-  .. note:: it is recommended to setup your package using :ref:`setup-new-package <uc-new-package>` script.
+  .. note:: it is recommended to setup your package using
+    :ref:`setup-new-package <uc-new-package>` script.
 
-  .. warning:: The script **has to be executed** from the folder where the package should be generated.
+  .. warning:: The script **has to be executed** in the root folder of the
+    **ament_cmake** package where the controller files are to be generated.
 
 Usage
 ------
@@ -34,4 +39,5 @@ The script will ask for some additional input.
 
 The package name is obtained from the 'package.xml' file.
 
-After all files are copied and placeholders set, changes are automatically staged in git.
+After all files are copied and placeholders set, changes are automatically
+staged in git.

docs/use-cases/ros2_control/setup_robot_hardware_interface.rst

@@ -3,20 +3,29 @@ ros2_control: Setup robot's hardware package
 =======================================================
 .. _uc-setup-ros2-control-hardware:
 
-This use-case describes how to set up a robot's hardware interface for the ros2_control framework using scripts from ROS Team Workspace (RosTeamWS) framework.
+This use-case describes how to set up a robot's hardware interface for the
+ros2_control framework using scripts from ROS Team Workspace (RosTeamWS)
+framework.
 
-``ros2_control_setup-hardware-interface-package`` script accepts the file name of the robot's hardware interfacea and, optionally, class name.
+``ros2_control_setup-hardware-interface-package`` script accepts the file name
+of the robot's hardware interfacea and, optionally, class name.
 The file name should use standard ROS format <my_cool_robot_hardware>.
 A ``.cpp`` and ``.hpp`` files will added using this name.
 If the class name is not set, it is guessed by camel-casing the file name.
 The package name is obtained from the 'package.xml' file.
 
-  .. note:: it is recommended to setup your package using :ref:`setup-new-package <uc-new-package>` script.
+  .. note:: it is recommended to setup your package using
+    :ref:`setup-new-package <uc-new-package>` script.
 
-  .. warning:: The script **has to be executed** from the folder where the package should be generated.
+  .. warning:: The script **has to be executed** in the root folder of the
+    **ament_cmake** package where the robot's hardware interface files are
+    to be generated.
 
-The scripts copies template files from the ``templates/ros2_control/hardware`` folder, renames the files, and replaces the placeholders.
-The scripts adds also a plugin description and simple test checking if the plugin can be loaded.
+
+The scripts copies template files from the
+``templates/ros2_control/hardware`` folder, renames the files, and replaces
+the placeholders. The scripts adds also a plugin description and simple test
+checking if the plugin can be loaded.
 
 .. code-block:: bash
    :caption: Usage of script for setting up the robot bringup.
@@ -25,4 +34,5 @@ The scripts adds also a plugin description and simple test checking if the plugi
    ros2_control_setup-hardware-interface-package FILE_NAME [CLASS_NAME]
 
 
-After all files are copied and placeholders set, changes are automatically staged in git.
+After all files are copied and placeholders set, changes are automatically
+staged in git.

docs/use-cases/ros_packages/setup_robot_bringup_package.rst

@@ -3,21 +3,27 @@ Setup robot bringup
 ==========================================
 .. _uc-setup-robot-bringup:
 
-This use-case describes how to set up a robot bringup package using scripts from ROS Team Workspace (RosTeamWS) framework.
-The package follows as far as possible best practices for `robot support packages <http://wiki.ros.org/Industrial/Tutorials/WorkingWithRosIndustrialRobotSupportPackages>`_ from ROS-Industrial consortia. (**This has to be verified!**)
+This use-case describes how to set up a robot bringup package using scripts
+from ROS Team Workspace (RosTeamWS) framework.
+The package follows as far as possible best practices for
+`robot support packages <http://wiki.ros.org/Industrial/Tutorials/WorkingWithRosIndustrialRobotSupportPackages>`_
+from ROS-Industrial consortia. (**This has to be verified!**)
 
 
 Script for Setting up a Bringup Package
 ============================================
 
-``setup-robot-bringup`` script accepts the robot name and the robot description package name.
-The package name is obtained from the 'package.xml' file.
+``setup-robot-bringup`` script accepts the robot name and the robot description
+package name. The package name is obtained from the 'package.xml' file.
 
-  .. note:: it is recommended to setup your package using :ref:`setup-new-package <uc-new-package>` script.
+  .. note:: It is recommended to setup your package using
+    :ref:`setup-new-package <uc-new-package>` script.
 
-  .. warning:: The script **has to be executed** from the folder where the package should be generated.
+  .. warning:: The script **has to be executed** in the root folder of the
+    **ament_cmake** package where the robot bringup files are to be generated.
 
-The scripts copies template files from the ``templates/robot_bringup`` folder, renames the files, and replaces the placeholders.
+The scripts copies template files from the ``templates/robot_bringup`` folder,
+renames the files, and replaces the placeholders.
 
 .. code-block:: bash
    :caption: Usage of script for setting up the robot bringup.
@@ -26,4 +32,5 @@ The scripts copies template files from the ``templates/robot_bringup`` folder, r
    setup-robot-bringup ROBOT_NAME DESCRIPTION_PKG_NAME
 
 
-After all files are copied and placeholders set, changes are automatically staged in git.
+After all files are copied and placeholders set, changes are automatically
+staged in git.

docs/use-cases/ros_packages/setup_robot_description_package.rst

@@ -3,8 +3,11 @@ Setup robot description
 ==========================================
 .. _uc-setup-robot-description:
 
-This use-case describes how to set up a robot description package using scripts from ROS Team Workspace (RosTeamWS) framework.
-The package follows as far as possible best practices for `robot support packages <http://wiki.ros.org/Industrial/Tutorials/WorkingWithRosIndustrialRobotSupportPackages>`_ from ROS-Industrial consortia. (**This has to be verified!**)
+This use-case describes how to set up a robot description package using
+scripts from ROS Team Workspace (RosTeamWS) framework.
+The package follows as far as possible best practices for
+`robot support packages <http://wiki.ros.org/Industrial/Tutorials/WorkingWithRosIndustrialRobotSupportPackages>`_
+from ROS-Industrial consortia. (**This has to be verified!**)
 
 
 Script for Setting up Description Package
@@ -13,11 +16,15 @@ Script for Setting up Description Package
 ``setup-robot-description`` script accepts the robot name.
 The package name is obtained from the 'package.xml' file.
 
-  .. note:: it is recommended to setup your package using :ref:`create-new-package <uc-new-package>` script.
+  .. note:: it is recommended to setup your package using
+   :ref:`create-new-package <uc-new-package>` script.
 
-  .. warning:: The script **has to be executed** from the folder where the package should be generated.
+  .. warning:: The script **has to be executed** in the root folder of the
+    **ament_cmake** package where the robot description files are to be
+    generated.
 
-The scripts copies template files from the ``templates/robot_description`` folder, renames the files, and replaces the placeholders.
+The scripts copies template files from the ``templates/robot_description``
+folder, renames the files, and replaces the placeholders.
 
 .. code-block:: bash
    :caption: Usage of script for setting up the robot description.
@@ -26,7 +33,8 @@ The scripts copies template files from the ``templates/robot_description`` folde
    setup-robot-description ROBOT_NAME
 
 
-After all files are copied and placeholders set, changes are automatically staged in git.
+After all files are copied and placeholders set, changes are automatically
+staged in git.
 
 To test the generated files compile and source your workspace and execute:
 

scripts/_RosTeamWs_Defines.bash

@@ -129,6 +129,7 @@ function RosTeamWS_setup_aliases {
   alias rosds="cd \$ROS_WS/src"
   alias rosdb="cd \$ROS_WS/build"
   alias rosdi="cd \$ROS_WS/install"
+  alias rosdepi="rosdep install -y -i --from-paths \$ROS_WS/src"
 }
 
 function RosTeamWS_setup_ros1_exports {