[doc] build: warn against spaces in working directory #15441

1. 
   Sjors commented at 1:27 pm on February 19, 2019: member

   Fixes #12528 and fixes #12529.
2. 
   laanwj commented at 2:07 pm on February 19, 2019: member

   I think we should fix this instead of warn against it
3. 
   Sjors commented at 2:30 pm on February 19, 2019: member

   From my understanding that would involve fixing protobuf and libtool. We could of course leave those tickets open even after this warning.
4. 
   laanwj commented at 2:38 pm on February 19, 2019: member

   fixing protobuf and libtool

   So is this only an issue when building depends? I agree that is out of scope, and should probably be documented with depends then, but I think our own project should probably be spaces-safe.

5. 
   MarcoFalke commented at 3:08 pm on February 19, 2019: member

   Are there upstream issues about the packages in depends that won’t build with spaces in paths?
6. 
   practicalswift commented at 3:36 pm on February 19, 2019: contributor

   Could test for this when running the configure script and warn if the unfortunate conditions are met?
7. 
   Sjors commented at 4:20 pm on February 19, 2019: member

   I don’t think it’s just depends. The first issue I found was make install failing on macOS, I don’t think that involved depends. The second issue is depends.
8. 
   MarcoFalke commented at 7:47 pm on February 19, 2019: member

   With a space in the working directory I can not even start to compile depends (it would fail in the download step)

   Is it worth to fix that?

9. fanquake added the label Docs on Feb 19, 2019
10. 
    DrahtBot commented at 8:53 pm on May 6, 2019: member

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Conflicts

    No conflicts as of last run.

11. DrahtBot added the label Needs rebase on Jun 29, 2019
12. Sjors force-pushed on Jul 5, 2019
13. DrahtBot removed the label Needs rebase on Jul 7, 2019
14. 
    BlockMechanic commented at 11:04 pm on July 8, 2019: contributor

    is there at least a temporay work around , beyond exporting a path with no spaces? I ask beacuse to view code i use the combination of github for linux and sublime text, of which github adds a variable with a sapce to the path.
15. DrahtBot added the label Needs rebase on Feb 5, 2020
16. Sjors force-pushed on Feb 10, 2020
17. Sjors force-pushed on Feb 10, 2020
18. [doc] build: warn against spaces in working directory

    In particular libtool and protobuf can't handle this, and
    make install on at least macOS will fail.

    e005b2c389
19. Sjors force-pushed on Feb 10, 2020
20. 
    Sjors commented at 1:00 pm on February 10, 2020: member

    Rebased. As much I prefer the underlying problem to be solved, it’s still there… E.g. on macOS when calling make in depends:

    0Fetching biplist-1.0.3.tar.gz from https://bitcoincore.org/depends-sources
    1  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    2                                 Dload  Upload   Total   Spent    Left  Speed
    3  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0Warning: Failed to create the file /Volumes/SSD/dev/bitcoin 
    4Warning: space/depends/work/download/native_biplist-1.0.3/biplist-1.0.3.tar.gz.
    5Warning: temp: No such file or directory
    6 75 21258   75 16055    0     0  29085      0 --:--:-- --:--:-- --:--:-- 29085
    7curl: (23) Failed writing body (0 != 16055)
    8make: *** [space/depends/sources/download-stamps/.stamp_fetched-native_biplist-biplist-1.0.3.tar.gz.hash] Error 23
    

21. DrahtBot removed the label Needs rebase on Feb 10, 2020
22. 
    fanquake commented at 0:46 am on February 28, 2020: member

    I’m not convinced this is something we need to have in our documentation, and the fact that it hasn’t come up apart from the issues you’ve opened might also point to that.

    We could use our docs to warn everyone about every issue they might run into when compiling an autotools based C++ project, as well provide troubleshooting for their package manager (i.e #18070), but I think our READMEs should only contain instructions that are actually related to building Bitcoin Core, and we should work on the assumption that anyone reading them has a working development environment.

23. 
    Sjors commented at 8:31 am on February 28, 2020: member

    It’s uncommon for people to have spaces in their development environment path; it happened to me because I moved everything to an external SSD drive that had a bad default name. But I wouldn’t consider that a broken environment.
24. Sjors closed this on Apr 23, 2020

    ---

25. DrahtBot locked this on Feb 15, 2022

Contributors
Sjors laanwj MarcoFalke practicalswift DrahtBot BlockMechanic fanquake

Labels
Docs