Skip to content

Commit

Permalink
gh-1420: Add a note about long paths support to Windows buildbot setup (
Browse files Browse the repository at this point in the history
  • Loading branch information
itamaro authored Sep 28, 2024
1 parent 1f2722e commit 87d74ce
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions testing/new-buildbot-worker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,18 @@ can put the ``buildarea`` wherever you want to)::
(Note that on Windows, the ``buildbot-worker`` command will be in the
:file:`Scripts` directory of your Python installation.)

On Windows, `the maximum length for a path is limited
<https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation>`_.
This might cause some tests to fail, unless long paths support is enabled.

Use this PowerShell command to check whether long paths are enabled::

Get-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled"

If the value is not "1", you can enable long paths using this PowerShell command::

New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force

Once this initial worker setup completes, you should edit the files
``buildarea/info/admin`` and ``buildarea/info/host`` to provide your contact
info and information on the host configuration, respectively. This information
Expand Down

0 comments on commit 87d74ce

Please sign in to comment.