Skip to content

Update Windows colcon build instructions --symlink-install #5948

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

Open
wants to merge 3 commits into
base: rolling
Choose a base branch
from
Open

Update Windows colcon build instructions --symlink-install #5948

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3ad7a7
Update Windows colcon build instructions --symlink-install
felixf4xu Oct 15, 2025
34bab2e
Update source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
felixf4xu Oct 15, 2025
8b0d102
Update source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
felixf4xu Oct 16, 2025
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
4 changes: 3 additions & 1 deletion source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,11 @@ This allows the installed files to be changed by changing the files in the ``sou

.. code-block:: console

$ colcon build --symlink-install --merge-install
$ colcon build --merge-install

Windows doesn't allow long paths, so ``merge-install`` will combine all the paths into the ``install`` directory.
On Windows, you need special permissions to create symbolic links, so ``--symlink-install`` is not used by default.
To use it, you need to run the command as administrator or enable developer mode in system settings.

.. tip::

Expand Down