Update build-osx.md #26787

1. 
   Bhaney44 commented at 6:26 am on January 1, 2023: none

   I made the introduction more clear to help prevent confusion about installation and requirements.

   ORIGINAL: The commands in this guide should be executed in a Terminal application. macOS comes with a built-in Terminal located in:

   /Applications/Utilities/Terminal.app

   NEW: The commands in this guide should be executed in a Terminal application.

   ---

   The original text causes issues for developers by creating confusion regarding where code should be run, as described in #26778. Moreover, there are core problems relating to the technical convergence between the macOS GUI and Terminal App CLI. Specifically, the GUI and CLI are not in sync, which signifies problems deeper in the macOS architecture.

   I think it is important to focus on solving the real problem at hand, which is how to build bitcoin with a Mac. There is no reason to reference or direct developers to the Applications folder that I know of and please correct me if you believe I am mistaken. Here, the Principle of Parismony should apply and the simpler explanation is better.

2. Update build-osx.md ddbfe2c888
3. 
   DrahtBot commented at 6:26 am on January 1, 2023: contributor

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

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   Concept NACK	stickies-v

   If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

4. Merge branch 'bitcoin:master' into master 3597cf21f3
5. 
   maflcko commented at 8:17 am on January 3, 2023: member

   No opinion on the changes here, but please do not add merge commits and keep your commits squashed according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits
6. 
   fanquake commented at 9:49 am on January 3, 2023: member

   ~0 doesn’t seem like an improvement. I don’t see how this is related too, or solves your problems in #26778.
7. 
   stickies-v commented at 5:01 pm on January 3, 2023: contributor

   NACK

   Since macOS Catalina (10.15), utilities have been moved to /System/Applications/Utilities but in the GUI that location change was largely hidden, see e.g. this article. In the GUI, the terminal effectively still appears to be in /Applications/Utilities/Terminal.app

   These instructions, by definition, are only relevant to people that are using the GUI, because if they were using a terminal they already know where the terminal is. As such, I think they are fine to keep as is. I also wouldn’t be terribly opposed to removing them, but frankly to me this just looks like a waste of time.

8. 
   promag commented at 5:58 pm on January 3, 2023: member

   TBH, I think ## Preparation section adds no value and could be removed - below there are already references to “your terminal”. That is my suggestion if this is not closed.
9. 
   Bhaney44 commented at 9:08 pm on January 3, 2023: none

   Thanks for all the thoughts and feedback. My intention here was to help, certainly if you don’t think this helps, you do not have to merge the PR. I am still working through the pathing problem on installation defined in #26778. I ran into a massive sub-problem with the data requirements and now have to remove the installed software, but I’m struggling to find it on my machine because of the broader pathing issue.

   Some questions I have generally on contributions to Bitcoin Core.

   1. Does the core team want OSS developers to contribute?
   2. Does the core team want to solve problems in Bitcoin Core?
   3. What incentive is there for contributing to Bitcoin Core?

   I am indifferent to the answer to these questions, I just don’t have a good way to gauge the climate or need for the network. So, I only identify problems based on my own experience developing. Of course, one developers problems could also be another developers solution, especially if the intention is to keep developers out, as is the case with many L1s. It’s ok if that is the intention here too, it would just be helpful to know ahead of time. I don’t want to bother anyone here if the core team does not want help or new solutions.

10. 
    maflcko commented at 9:13 pm on January 3, 2023: member

    Getting started to contribute to Bitcoin Core

    Setting up your development environment

    New developers are very welcome and needed. There are a lot of open issues of any difficulty waiting to be fixed. However, before you start contributing, familiarize yourself with the Bitcoin Core build system and tests. Refer to the documentation in the repository on how to build Bitcoin Core and how to run the unit and functional tests. Once that is done, you are all set.

    If you need more help getting started, please refer to the following resources:

    • https://medium.com/@amitiu/onboarding-to-bitcoin-core-7c1a83b20365
    • https://jonatack.github.io/articles/how-to-review-pull-requests-in-bitcoin-core

    Pick something to work on

    If you are looking for useful contributions to help out with, you can

    • Search through the good first issues or the ones that are up for grabs. Some of them might no longer be applicable. So if you are interested, but unsure, you might want to leave a comment on the issue first.
    • Write tests to improve the coverage. Any kind of test is welcome and coverage information can be obtained from a relatively recent coverage report. If you are unsure, don’t hesitate to check back first.
    • Help with review and testing. There are easy ones such as the gui and rpc. However, review on any open pull request is welcome. Review will also help you understand the codebase better.
    • Help on meta projects related to Bitcoin Core, such as a high-level performance monitor.
    • Join us on irc and let us know what you are interested in.
11. 
    Bhaney44 commented at 10:28 pm on January 3, 2023: none

    • https://jonatack.github.io/articles/how-to-review-pull-requests-in-bitcoin-core

    Great, thank you!

12. Merge branch 'bitcoin:master' into master 42b51b4dd0
13. 
    fanquake commented at 11:58 am on January 4, 2023: member

    Closing for now (still unmergable in any case).
14. fanquake closed this on Jan 4, 2023

    ---

15. 
    Bhaney44 commented at 9:11 pm on January 4, 2023: none

    Closing for now (still unmergable in any case).

    You were right. The feature request in #26778 turned into a mish-mash. The goal for the feature request was to prevent that from happening and have a clear installation path, which you appropriately identified as downloading from the src, rather than downloading binaries. I did not previously know the difference.

    My aim with this PR was to make things less confusing by removing unnecessary terminal discussion because there is a core problem with downloading Bitcoin Core on macOS for purposes of development. You can download bitcoind to get bitcoin-cli access, but the problem is downloading bitcoin core to the Applications Support folder only gives you GUI access and downloading bitcoind requires over 500 GB of storage.

    However, I think @sipa solved this almost 10 years ago on Stack Exchange. So, the solution for a lightweight installation for developers, or at least the next one I want to pursue, is running bitcoin-qt -server from src. This should allow for both prune mode to reduce the storage requirement and for developers to gain access to bitcoin-cli.

    Once I’ve done this and validated the method, I can write up a new guide to solve #26778. Thanks again for your help, @fanquake.

16. bitcoin locked this on Jan 4, 2024

Contributors
Bhaney44 DrahtBot maflcko fanquake stickies-v promag