Skip to content

Commit 87d74ce

Browse files
authored
gh-1420: Add a note about long paths support to Windows buildbot setup (#1421)
1 parent 1f2722e commit 87d74ce

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

testing/new-buildbot-worker.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,18 @@ can put the ``buildarea`` wherever you want to)::
102102
(Note that on Windows, the ``buildbot-worker`` command will be in the
103103
:file:`Scripts` directory of your Python installation.)
104104

105+
On Windows, `the maximum length for a path is limited
106+
<https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation>`_.
107+
This might cause some tests to fail, unless long paths support is enabled.
108+
109+
Use this PowerShell command to check whether long paths are enabled::
110+
111+
Get-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled"
112+
113+
If the value is not "1", you can enable long paths using this PowerShell command::
114+
115+
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
116+
105117
Once this initial worker setup completes, you should edit the files
106118
``buildarea/info/admin`` and ``buildarea/info/host`` to provide your contact
107119
info and information on the host configuration, respectively. This information

0 commit comments

Comments
 (0)