Skip to content

Commit 2728023

Browse files
committed
More feedback from review.
Signed-off-by: Chris Lalancette <clalancette@gmail.com>
1 parent c8f2392 commit 2728023

File tree

2 files changed

+24
-9
lines changed

2 files changed

+24
-9
lines changed

source/Installation/Alternatives/Windows-Development-Setup.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,23 @@ We'll use ``C:\dev`` for the rest of these instructions.
3737
3838
md C:\dev
3939
40+
Increase the Windows maximum path length
41+
----------------------------------------
42+
43+
By default, Windows is restricted to a maximum path length (MAX_PATH) of 260 characters.
44+
The ROS 2 build will use significantly longer path lengths, so we will increase that.
45+
Using the powershell session you started above, run the following:
46+
47+
.. code-block:: console
48+
49+
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
50+
51+
You can read more about this limitation at https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry.
52+
53+
4054
Install prerequisites
4155
---------------------
4256

43-
ROS 2 uses `conda-forge <https://conda-forge.org/>`__ as a backend for packages, with `pixi <https://pixi.sh/latest/>`__ as the frontend.
44-
4557
Install MSVC
4658
^^^^^^^^^^^^
4759

@@ -54,16 +66,23 @@ Continue using the previous powershell session, and run the following command to
5466
5567
irm https://aka.ms/vs/16/release/vs_buildtools.exe -OutFile vs_buildtools_2019.exe
5668
57-
Now install MSVC 2019 (this will take some time):
69+
Now install MSVC 2019:
5870

5971
.. code-block:: console
6072
6173
vs_buildtools_2019.exe --quiet --wait --norestart --add Microsoft.Component.MSBuild --add Microsoft.Net.Component.4.6.1.TargetingPack --add Microsoft.Net.Component.4.8.SDK --add Microsoft.VisualStudio.Component.CoreBuildTools --add Microsoft.VisualStudio.Component.Roslyn.Compiler --add Microsoft.VisualStudio.Component.TextTemplating --add Microsoft.VisualStudio.Component.VC.CLI.Support --add Microsoft.VisualStudio.Component.VC.CoreBuildTools --add Microsoft.VisualStudio.Component.VC.CoreIde --add Microsoft.VisualStudio.Component.VC.Redist.14.Latest --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows10SDK --add Microsoft.VisualStudio.Component.Windows10SDK.19041 --add Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core --add Microsoft.VisualStudio.Workload.MSBuildTools --add Microsoft.VisualStudio.Workload.VCTools
6274
75+
.. note::
76+
77+
The installation of MSVC can take a long time, and there is no feedback while it is progressing.
78+
6379
Install pixi
6480
^^^^^^^^^^^^
6581

66-
Continue using the previous powershell session, and use the instructions on https://pixi.sh/latest/ to install ``pixi``.
82+
ROS 2 uses `conda-forge <https://conda-forge.org/>`__ as a backend for packages, with `pixi <https://pixi.sh/latest/>`__ as the frontend.
83+
84+
Continue using the previous powershell session, and use the instructions from https://pixi.sh/latest/ to install ``pixi``.
85+
Once ``pixi`` has been installed, close the powershell session and start it again, which will ensure ``pixi`` is on the PATH.
6786

6887
Install dependencies
6988
^^^^^^^^^^^^^^^^^^^^
@@ -114,11 +133,6 @@ Now that we have the development tools we can get the ROS 2 source code.
114133

115134
Setup a development folder, for example ``C:\dev\{DISTRO}``:
116135

117-
.. note::
118-
119-
It is very important that the chosen path is short, due to the short default Windows path limits (260 characters).
120-
To allow longer paths, see https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry.
121-
122136
.. code-block:: bash
123137
124138
md C:\dev\{DISTRO}\src

source/Installation/Windows-Install-Binary.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Install pixi
4444
^^^^^^^^^^^^
4545

4646
Continue using the previous powershell session, and use the instructions on https://pixi.sh/latest/ to install ``pixi``.
47+
Once ``pixi`` has been installed, close the powershell session and start it again, which will ensure ``pixi`` is on the PATH.
4748

4849
Install dependencies
4950
^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)