When running the configuration step
cmake -B build --preset vs2022-static
from a directory with spaces in its path, CMake issues the following warning:
Warning: Paths with embedded space may be handled incorrectly by configure
The build subsequently fails with error code 77.
While the underlying issue should ideally be resolved, this hint may help users avoid related build failures in the meantime.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32397.
See the guideline for information on the review process. A summary of reviews will appear here.
That’s too bad, we’d finally solved all the build-with-spaces issues with the old build system.
But yes i suppose it doesn’t hurt too add a warning in the meantime…
from a directory with spaces in its path, CMake issues the following warning:
0Warning: Paths with embedded space may be handled incorrectly by configure
This is a vcpkg upstream issue. Another one has already been documented: https://github.com/bitcoin/bitcoin/blob/5b8046a6e893b7fad5a93631e6d1e70db31878af/doc/build-windows-msvc.md?plain=1#L61-L71
This is not specific to CMake in general, nor to the Bitcoin Core build system.
When running the configuration step
cmake -B build --preset vs2022-static
from a directory with spaces in its path, vcpkg issues the following warning:
Warning: Paths with embedded space may be handled incorrectly by configure
The build subsequently fails with error code 77.
While the underlying issue should ideally be resolved, this hint may help users avoid related build failures in the meantime.This is not specific to CMake in general, nor to the Bitcoin Core build system.
Happy about that. i know it was something we explicitly considered and tested when going to CMake so hence my surprise.
In general, Windows users are the most likely to have spaces in any path they’re allowed to write to. For example, from that iconv vcpkg issue:
That would require me to reinstall my entire operating system (Windows 11 setup asks you for your name and then sets the user folder name to that, including spaces). Not sure if that is something that should be accounted for within vcpkg or within Windows itself
So hope this will get resolved upstream sooner than this documentation change would make it into a release.
It’s not clear what is failing to build? If it is libiconv, how is that related to our build; is this something we can just avoid?
libiconv is listed as a direct dependency of the qt package (see the output of vcpkg depend-info qt).
${CMAKE_BINARY_DIR}\vcpkg_installed) can be overridden by setting the VCPKG_INSTALLED_DIR variable to a path that contains no spaces. This resolves the issue.
It would be useful to document, but not in the way it is here. It’s not a problem when cloning the repository. The current warning is confusing, it should be more specific (also to make it more clear when the problem is solved and the warning can be removed again).
I believe it would be helpful to mention a workaround in the build documentation. Here’s a suggestion you could consider including.
+1