doc: cleanup doc on need of Developer Account to obtain macOS SDK #24241
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
NIT: commit: RandyMcMillan@118f821 update the term "look for" to "search for" with the actual search link. This is the result of clicking on the updated link: commit: RandyMcMillan@118f821 as patch: |
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsNo conflicts as of last run. |
Sjors
reviewed
Feb 3, 2022
There was a problem hiding this comment.
Concept ACK
@RandyMcMillan's suggestion to replace the link with a search URL makes sense. Apple doesn't believe in statelessness, so the direct link doesn't work until you perform the right rituals on their site.
|
Concept ACK - can you incorporate the suggestions here |
The explicit statement that an Apple Developer Account is required in order to obtain the SDK is buried within the "Deterministic macOS DMG Notes" section. It should be the first thing mentioned under the "SDK Extraction" section. The reason to do this is to set expectations of what is required before starting any steps or clicking on links. This fixes the issue by doing just that; moving this information to the "SDK Extraction" section. Now that the information is moved, this also deletes unnecessary SDK related notes from the "Deterministic macOS DMG Notes" section. It is not necessary to explain under what sub-directory 'most' of the important files are inside of the 'Xcode.app'.
b2dcf36 to
ddcac22
Compare
|
updated from b2dcf36 -> ddcac22 (pr24241.01 -> pr24241.02, diff) Thanks everyone for the reviews! Incorporated review feedback, here's a convenient diff of the changes: diff --git a/contrib/macdeploy/README.md b/contrib/macdeploy/README.md
index ef8c1f430..ce69079e2 100644
--- a/contrib/macdeploy/README.md
+++ b/contrib/macdeploy/README.md
@@ -12,14 +12,14 @@ When complete, it will have produced `Bitcoin-Core.dmg`.
### Step 1: Obtaining `Xcode.app`
-An Apple Developer Account is required to proceed.
+A free Apple Developer Account is required to proceed.
Our current macOS SDK
(`Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz`) can be
extracted from
[Xcode_12.2.xip](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
Alternatively, after logging in to your account go to 'Downloads', then 'More'
-and look for [`Xcode_12.2`](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
+and search for [`Xcode_12.2`](https://developer.apple.com/download/all/?q=Xcode%2012.2).
An Apple ID and cookies enabled for the hostname are needed to download this.
The `sha256sum` of the archive should be `28d352f8c14a43d9b8a082ac6338dc173cb153f964c6e8fb6ba389e5be528bd0`. |
fanquake
approved these changes
Feb 11, 2022
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Feb 11, 2022
… obtain macOS SDK ddcac22 doc: cleanup doc on need of Developer Account to obtain macOS SDK (jarolrod) Pull request description: The explicit statement that an Apple Developer Account is required in order to obtain the SDK is buried within the `Deterministic macOS DMG Notes` section. It should be the first thing mentioned under the `SDK Extraction` section. The reason to do this is to set expectations of what is required before starting any steps or clicking on links. This fixes the issue by doing just that; moving this information to the `SDK Extraction` section. Now that the information is moved, this also deletes unnecessary SDK related notes from the `Deterministic macOS DMG Notes` section. It is not necessary to explain under what sub-directory 'most' of the important files are inside of the `Xcode.app`. Note that this also fixes a missed Xcode version link bump by deleting it :) ACKs for top commit: fanquake: ACK ddcac22 Tree-SHA512: 9fe7fddd66b68a0475be8b0c78cb58932bf5b68d962ece36a86f3b743a88d8561c0ec3e8d88bcaf338da7ab9d3dfcfb9399f6e1a884d83c8f3117c186d049469
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The explicit statement that an Apple Developer Account is required in order to obtain the SDK is buried within the
Deterministic macOS DMG Notessection. It should be the first thing mentioned under theSDK Extractionsection.The reason to do this is to set expectations of what is required before starting any steps or clicking on links.
This fixes the issue by doing just that; moving this information to the
SDK Extractionsection. Now that the information is moved, this also deletes unnecessary SDK related notes from theDeterministic macOS DMG Notessection. It is not necessary to explain under what sub-directory 'most' of the important files are inside of theXcode.app.Note that this also fixes a missed Xcode version link bump by deleting it :)