doc: improve depends prefix documentation #16691

1. 
   fanquake commented at 3:37 am on August 23, 2019: member

   There seems to be some confusion about exactly how to use depends, when to pass a prefix to ./configure etc (see #16367, #16654).

   I’ve cherry-picked two of russ’s commits out of #16367, as they are clear stand-alone improvements and we don’t have to wait for #16367 to improve the depends documentation.

2. fanquake added the label Docs on Aug 23, 2019
3. fanquake requested review from ryanofsky on Aug 23, 2019
4. ryanofsky approved
5. 
   ryanofsky commented at 3:46 am on August 23, 2019: member

   ACK 0b1c2b0418ac39d6935bf3eb207915d33c9d983a. Maybe discount this review because I wrote these commits, but I agree they make sense in this standalone PR.
6. 
   ryanofsky commented at 4:09 am on August 23, 2019: member

   Also, I think it would be a good idea that if a depends/${host}/share/config.site file exists, bitcoin configure script would just use depends/$(host) as the default --prefix value instead of /usr/local.

   This way using depends would just require running ‘make -C depends; ./configure; make` without needing to figure out the host triple or look at depends output.

7. 
   fanquake commented at 4:20 am on August 23, 2019: member

   @ryanofsky Thanks. Probably out of scope to make those changes here, but I’ve opened #16692 to track.
8. 
   practicalswift commented at 4:46 am on August 23, 2019: contributor

   Should it be clarified that --prefix is used not in its usual meaning of “when you run ./configure --prefix=/foo/bar, you are indicating that the software should be installed under the /foo/bar directory”?

   That seems to be a recurring source of confusion.

   Has it been discussed if we could use something else than --prefix for the “where to find dependencies”-meaning we’re talking about here?

9. in depends/README.md:26 in 0b1c2b0418 outdated

   22 
   23     ./configure --prefix=`pwd`/depends/x86_64-w64-mingw32
   24 
   25 Common `host-platform-triplets` for cross compilation are:
   26 
   27+- `x86_64-pc-linux-gnu` for x86 Linux
   

   ---

   ---

   

   hebasto commented at 5:23 am on August 23, 2019:

   Could the i686-pc-linux-gnu triplet be added?
10. 
    hebasto commented at 5:23 am on August 23, 2019: member

    Concept ACK
11. Clarify need to specify --prefix with depends

    If not cross compiling, it might actually be nice for it to be picked up
    automatically. But for now clarify the readme to try to minimize confusion.
    
    https://github.com/chaincodelabs/libmultiprocess/issues/4#issuecomment-515619707
    https://github.com/chaincodelabs/libmultiprocess/issues/5#issuecomment-518826298

    be27161ee4
12. packages.md: document depends build targets 2483266c59
13. fanquake force-pushed on Aug 23, 2019
14. hebasto approved
15. 
    hebasto commented at 6:36 am on August 23, 2019: member

    ACK 2483266c591f7b2e62df68ee2d13740a706415ec, I have reviewed the code and it looks OK, I agree it can be merged.
16. 
    DrahtBot commented at 8:03 am on August 23, 2019: member

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

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #16367 (Multiprocess build support by ryanofsky)
    • #10102 ([experimental] Multiprocess bitcoin by ryanofsky)

    If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

17. 
    Sjors commented at 10:35 am on August 23, 2019: member

    utACK 2483266
18. jonasschnelli approved
19. 
    jonasschnelli commented at 10:36 am on August 23, 2019: contributor

    ACK 2483266c591f7b2e62df68ee2d13740a706415ec
20. in depends/packages.md:187 in 2483266c59

    180@@ -181,3 +181,18 @@ For us, it's much easier to just link a static `libsecondary` into a shared
    181 static or dynamic `libseconday`, that's not our concern. With a static
    182 `libseconday`, when we need to link `libprimary` into our executable, there's no
    183 dependency chain to worry about as `libprimary` has all the symbols.
    184+
    185+## Build targets:
    186+
    187+To build an individual package (useful for debugging), following build targets are available.
    

    ---

    ---

    

    jonatack commented at 10:40 am on August 23, 2019:

    nit: missing “the” before “following”
21. fanquake referenced this in commit 442a9c6477 on Aug 23, 2019
22. 
    jonatack commented at 10:42 am on August 23, 2019: member

    ACK. After my questions on the #bitcoin-builds irc channel, like you I was thinking this info would be useful to add here.
23. fanquake merged this on Aug 23, 2019
24. fanquake closed this on Aug 23, 2019

    ---

25. fanquake deleted the branch on Aug 23, 2019
26. deadalnix referenced this in commit cedd72596f on Apr 2, 2020
27. fanquake referenced this in commit 3aa4935db7 on Apr 13, 2021
28. DrahtBot locked this on Feb 15, 2022

Contributors
fanquake ryanofsky practicalswift hebasto DrahtBot Sjors jonasschnelli jonatack

Labels
Docs