doc: cleanup doc on need of Developer Account to obtain macOS SDK #24241

pull jarolrod wants to merge 1 commits into bitcoin:master from jarolrod:macdeploy-readme-cleanups changing 1 files +5 −13
  1. jarolrod commented at 7:59 pm on February 2, 2022: member

    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 :)

  2. DrahtBot added the label Scripts and tools on Feb 2, 2022
  3. RandyMcMillan commented at 10:29 pm on February 2, 2022: contributor

    NIT:

    commit: https://github.com/RandyMcMillan/bitcoin/commit/118f821037f4ff4ef078f88a8cbbd4f88c70786d

    update the term “look for” to “search for” with the actual search link.

    This is the result of clicking on the updated link:

    Screen Shot 2022-02-02 at 5 24 51 PM

    commit: https://github.com/RandyMcMillan/bitcoin/commit/118f821037f4ff4ef078f88a8cbbd4f88c70786d as patch:

     0diff --git a/contrib/macdeploy/README.md b/contrib/macdeploy/README.md
     1index ef8c1f430c..31288284b7 100644
     2--- a/contrib/macdeploy/README.md
     3+++ b/contrib/macdeploy/README.md
     4@@ -19,7 +19,7 @@ Our current macOS SDK
     5 extracted from
     6 [Xcode_12.2.xip](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
     7 Alternatively, after logging in to your account go to 'Downloads', then 'More'
     8-and look for [`Xcode_12.2`](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
     9+and search for [`Xcode 12.2`](https://developer.apple.com/download/all/?q=Xcode%2012.2).
    10 An Apple ID and cookies enabled for the hostname are needed to download this.
    11 The `sha256sum` of the archive should be `28d352f8c14a43d9b8a082ac6338dc173cb153f964c6e8fb6ba389e5be528bd0`.
    
  4. DrahtBot commented at 3:17 am on February 3, 2022: member

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

    Conflicts

    No conflicts as of last run.

  5. in contrib/macdeploy/README.md:15 in b2dcf36663 outdated
    11@@ -12,6 +12,8 @@ When complete, it will have produced `Bitcoin-Core.dmg`.
    12 
    13 ### Step 1: Obtaining `Xcode.app`
    14 
    15+An Apple Developer Account is required to proceed.
    


    Sjors commented at 10:18 am on February 3, 2022:
    Maybe: “A free Apple Developer Account” (to clarify that you don’t need to sign up for their paid app developer program)
  6. Sjors commented at 10:21 am on February 3, 2022: member
    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.
  7. brunoerg commented at 12:02 pm on February 6, 2022: member

    Concept ACK

    I agree with @Sjors in mentioning that Apple Developer Account is free.

  8. fanquake removed the label Scripts and tools on Feb 9, 2022
  9. fanquake added the label Docs on Feb 9, 2022
  10. fanquake commented at 9:53 am on February 9, 2022: member
    Concept ACK - can you incorporate the suggestions here
  11. doc: cleanup doc on need of Developer Account to obtain macOS SDK
    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'.
    ddcac22f09
  12. jarolrod force-pushed on Feb 11, 2022
  13. jarolrod commented at 4:58 am on February 11, 2022: member

    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:

     0diff --git a/contrib/macdeploy/README.md b/contrib/macdeploy/README.md
     1index ef8c1f430..ce69079e2 100644
     2--- a/contrib/macdeploy/README.md
     3+++ b/contrib/macdeploy/README.md
     4@@ -12,14 +12,14 @@ When complete, it will have produced `Bitcoin-Core.dmg`.
     5 
     6 ### Step 1: Obtaining `Xcode.app`
     7 
     8-An Apple Developer Account is required to proceed.
     9+A free Apple Developer Account is required to proceed.
    10 
    11 Our current macOS SDK
    12 (`Xcode-12.2-12B45b-extracted-SDK-with-libcxx-headers.tar.gz`) can be
    13 extracted from
    14 [Xcode_12.2.xip](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
    15 Alternatively, after logging in to your account go to 'Downloads', then 'More'
    16-and look for [`Xcode_12.2`](https://download.developer.apple.com/Developer_Tools/Xcode_12.2/Xcode_12.2.xip).
    17+and search for [`Xcode_12.2`](https://developer.apple.com/download/all/?q=Xcode%2012.2).
    18 An Apple ID and cookies enabled for the hostname are needed to download this.
    19 The `sha256sum` of the archive should be `28d352f8c14a43d9b8a082ac6338dc173cb153f964c6e8fb6ba389e5be528bd0`.
    
  14. fanquake approved
  15. fanquake commented at 8:39 am on February 11, 2022: member
    ACK ddcac22f092de6f3a2a67acb3288a990fd13cb01
  16. fanquake merged this on Feb 11, 2022
  17. fanquake closed this on Feb 11, 2022

  18. fanquake added the label macOS on Feb 11, 2022
  19. jarolrod deleted the branch on Feb 11, 2022
  20. sidhujag referenced this in commit 0b9ab2e421 on Feb 11, 2022
  21. DrahtBot locked this on Feb 11, 2023

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-09-29 01:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me