Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shorten the Windows build-from-source path. #3130

Merged
merged 2 commits into from
Oct 26, 2022
Merged

Shorten the Windows build-from-source path. #3130

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6daef7
Shorten the Windows build-from-source path.
clalancette Oct 25, 2022
fb82370
Fast RTPS -> Fast DDS.
clalancette Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions source/Installation/Alternatives/Windows-Development-Setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,17 @@ Get the ROS 2 code

Now that we have the development tools we can get the ROS 2 source code.

First setup a development folder, for example ``C:\dev\ros2_{DISTRO}``:
First setup a development folder, for example ``C:\{DISTRO}``:

.. note::

It is very important that the chosen path is short, due to the short default Windows path limits (260 characters).
To allow longer paths, see https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry.

.. code-block:: bash

md \dev\ros2_{DISTRO}\src
cd \dev\ros2_{DISTRO}
md \{DISTRO}\src
cd \{DISTRO}

Get the ``ros2.repos`` file which defines the repositories to clone from:

Expand All @@ -81,6 +86,8 @@ Get the ``ros2.repos`` file which defines the repositories to clone from:
Install additional DDS implementations (optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Fast DDS is bundled with the ROS 2 source and will always be built unless you put an ``COLCON_IGNORE`` file in the ``src\eProsima`` folder.

If you would like to use another DDS or RTPS vendor besides the default, you can find instructions :doc:`here <../DDS-Implementations>`.

Build the ROS 2 code
Expand All @@ -90,9 +97,7 @@ Build the ROS 2 code

To build ROS 2 you will need a Visual Studio Command Prompt ("x64 Native Tools Command Prompt for VS 2019") running as Administrator.

Fast RTPS is bundled with the ROS 2 source and will always be built unless you put an ``AMENT_IGNORE`` file in the ``src\eProsima`` folder.

To build the ``\dev\ros2_{DISTRO}`` folder tree:
To build the ``\{DISTRO}`` folder tree:

.. code-block:: bash

Expand All @@ -115,7 +120,7 @@ Start a command shell and source the ROS 2 setup file to set up the workspace:

.. code-block:: bash

call C:\dev\ros2_{DISTRO}\install\local_setup.bat
call C:\{DISTRO}\install\local_setup.bat

This will automatically set up the environment for any DDS vendors that support was built for.

Expand Down