doc: Document ALLOW_HOST_PACKAGES dependency option #19124

pull skmcontrib wants to merge 1 commits into bitcoin:master from skmcontrib:allowHostDoc changing 1 files +4 −0
  1. skmcontrib commented at 4:12 pm on May 31, 2020: none
    Provided entry in depends, README.md to ensure that ALLOW_HOST_PACKAGES dependency option is documented, #19113
  2. DrahtBot added the label Build system on May 31, 2020
  3. DrahtBot added the label Docs on May 31, 2020
  4. hebasto commented at 7:11 pm on May 31, 2020: member

    @skmcontrib Thank you for working on it.

    cc @dongcarl

  5. DrahtBot commented at 12:02 pm on July 11, 2020: 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:

    • #18077 (net: Add NAT-PMP port forwarding support by hebasto)

    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.

  6. in depends/README.md:137 in a127beb8a1 outdated 
    94@@ -95,6 +95,7 @@ The following can be set when running make: make FOO=bar
95     DEBUG: disable some optimizations and enable more runtime checking
96     HOST_ID_SALT: Optional salt to use when generating host package ids
97     BUILD_ID_SALT: Optional salt to use when generating build package ids
98+    ALLOW_HOST_PACKAGE: compile using hosts library set (via pkg-config)
    hebasto commented at 12:16 pm on July 11, 2020:

    Concept ACK. @skmcontrib Could you emphasize that the host’s packages are used when they are not built due to the NO_* variable set?

    Also this line could be moved up to be just under the NO_UPNP line.

    dongcarl commented at 8:14 pm on July 13, 2020: 
    0    ALLOW_HOST_PACKAGES: compile using hosts library set (via pkg-config)
    laanwj commented at 8:29 pm on July 22, 2020:
    Can you please elaborate a bit further what this means? What is compiled using hosts libraries? And which host libraries, which packages are replaced by host packages? When would one want to use this option?
  7. DrahtBot added the label Needs rebase on Jul 16, 2020
  8. hebasto commented at 6:39 am on July 23, 2020: member
    @skmcontrib Mind rebasing and addressing reviewers’ comments?
  9. fanquake added the label Waiting for author on Jul 23, 2020
  10. skmcontrib commented at 4:50 pm on July 24, 2020: none
    Thanks @hebasto. Will look
  11. hebasto commented at 6:48 pm on July 26, 2020: member
    @skmcontrib Mind squashing into one commit?
  12. skmcontrib commented at 6:49 pm on July 26, 2020: none
    @hebasto @dongcarl @laanwj Thanks for your review comments. I have incorporated all the changes.
  13. skmcontrib force-pushed on Jul 26, 2020
  14. DrahtBot removed the label Needs rebase on Jul 26, 2020
  15. hebasto commented at 9:03 am on August 4, 2020: member
    Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits
  16. skmcontrib commented at 10:36 am on August 9, 2020: none
    @hebasto The earlier squash I did merged all my previous commits into a single commit. So now there are two commits - a squashed commit (e8c3e2bef) and also a merge commit(e4946cbcf). I’m having some trouble squashing these two. Maybe I don’t understand this fully. Any pointers? Also as suggested in the contributing guidelines I have enabled “allow edits from maintainers”. Sorry for the trouble and thanks for the help.
  17. hebasto commented at 11:07 am on August 9, 2020: member

    @skmcontrib

    @hebasto The earlier squash I did merged all my previous commits into a single commit. So now there are two commits - a squashed commit (e8c3e2b) and also a merge commit(e4946cb). I’m having some trouble squashing these two. Maybe I don’t understand this fully. Any pointers? Also as suggested in the contributing guidelines I have enabled “allow edits from maintainers”. Sorry for the trouble and thanks for the help.

    You could start from this GitHub guide.

    Your working branch in your forked repo should contain no merge commits. Only commits with your changes, that are based on “master” branch at some point, are allowed. The merge commit is made by a maintainer when your working branch is merged into this repo “master” branch.

    “allow edits from maintainers” allows maintainers to edit PR’s title and posts. It is a contributor’s burden to keep his own working branch in ready-to-merge state.

  18. in depends/README.md:107 in e4946cbcf9 outdated 
    100@@ -101,6 +101,10 @@ The following can be set when running make: `make FOO=bar`
101 <dd>Don't download/build/cache libs needed to enable the wallet</dd>
102 <dt>NO_UPNP</dt>
103 <dd>Don't download/build/cache packages needed for enabling upnp</dd>
104+<dt>ALLOW_HOST_PACKAGES</dt>
105+<dd>Enables the hosts packages in case automatic download/build of dependencies
106+is disabled via the NO_* options (example NO_QT etc). This is useful in case of
107+cross-compilation (example: compilation for macOS on debian)</dd>
    hebasto commented at 11:27 am on August 9, 2020:

    Two notes to consider:

    • NO_PACKAGE is not the only way to miss package in depends (see #18051, my previous comment was a bit misleading, sorry for that)
    • in general, building with depends is used not only for cross-compilation
    0<dd>Packages that are missed in dependencies (due to `NO_*` option or
1build script logic) are searched for among the host system packages using
2`pkg-config`. It allows to build with packages of other (newer) versions</dd>
    skmcontrib commented at 2:33 pm on August 11, 2020:
    @hebasto Hopefully I got it right this time. Sorry for being dense and the delay. Appreciate your help and the good learning.
  19. doc: Document ALLOW_HOST_PACKAGES dependency option 47e2a35fac
  20. skmcontrib force-pushed on Aug 11, 2020
  21. skmcontrib commented at 11:46 am on August 12, 2020: none
    @hebasto incorporated all the review comments. Thanks
  22. hebasto approved
  23. hebasto commented at 10:20 am on August 13, 2020: member

    ACK 47e2a35fac9951c125b784a9d14027338c56c750.

    nit: it appears that back quoting doesn’t work within <dd> ... </dd>, therefore it could be dropped

  24. MarcoFalke removed the label Waiting for author on Aug 30, 2020
  25. hebasto commented at 9:47 am on October 6, 2020: member
    friendly ping @dongcarl
  26. laanwj commented at 9:18 am on October 27, 2020: member
    ACK 47e2a35fac9951c125b784a9d14027338c56c750
  27. laanwj merged this on Oct 27, 2020
  28. laanwj closed this on Oct 27, 2020
  29. sidhujag referenced this in commit 4487add335 on Oct 27, 2020
  30. furszy referenced this in commit 816f42d7ac on May 25, 2021
  31. DrahtBot locked this on Feb 15, 2022


skmcontrib hebasto DrahtBot dongcarl laanwj

Labels
Docs Build system

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-11-17 12:12 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me