Skip to content

Commit ecc5a15

Browse files
mergify[bot]felixf4xuCopilotfujitatomoya
authored
Update Windows colcon build instructions --symlink-install (#5948) (#6077)
* Update Windows colcon build instructions --symlink-install Clarify Windows build command and permissions for symbolic links. * Update source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst * Update source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst --------- (cherry picked from commit b7312c8) Signed-off-by: Felix F Xu <[email protected]> Co-authored-by: Felix F Xu <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
1 parent a082c20 commit ecc5a15

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,11 @@ This allows the installed files to be changed by changing the files in the ``sou
184184

185185
.. code-block:: console
186186
187-
$ colcon build --symlink-install --merge-install
187+
$ colcon build --merge-install
188188
189189
Windows doesn't allow long paths, so ``merge-install`` will combine all the paths into the ``install`` directory.
190+
On Windows, you need special permissions to create symbolic links, so ``--symlink-install`` is not used by default.
191+
To use it, you need to run the command as administrator or enable developer mode in system settings.
190192

191193
.. tip::
192194

0 commit comments

Comments
 (0)