doc: note on SDK for macOS depends cross-compile #21688

jarolrod commented at 5:11 AM on April 15, 2021: member

This PR adds a friendly note for those who are unfamiliar with our depends build system that an extracted SDK is needed before proceeding with a macOS cross-compile. Additionally, it refers a builder to look at macdeploy for instructions on obtaining the SDK and provides context to where this SDK should reside.

Master: render PR: render

fanquake added the label Docs on Apr 15, 2021

in depends/README.md:54 in e6c876d364 outdated

  48 | @@ -49,6 +49,10 @@ The paths are automatically configured and no other options are needed unless ta
  49 |  
  50 |      sudo apt-get install curl librsvg2-bin libtiff-tools bsdmainutils cmake imagemagick libz-dev python3-setuptools libtinfo5 xorriso
  51 |  
  52 | +Note: You must obtain the macOS SDK before proceeding with a cross-compile.
  53 | +The SDK should be placed under `depends/SDKs/`.
  54 | +For more information: [macdeploy](../contrib/macdeploy/README.md#sdk-extraction)

hebasto commented at 6:34 AM on April 15, 2021:

nit: could it look better

For more information: [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction)

?

jarolrod commented at 5:44 PM on April 15, 2021:

addressed in 241c401

hebasto approved

hebasto commented at 6:35 AM on April 15, 2021: member

ACK e6c876d364d1a4b71b178ba44e55a562a517aa70

Sjors commented at 7:23 AM on April 15, 2021: member

ACK

jarolrod force-pushed on Apr 15, 2021

jarolrod commented at 5:46 PM on April 15, 2021: member

Updated from e6c876d -> 241c401

Changes:

Changed text on link for SDK extraction info frommacdeploy to SDK Extraction

hebasto approved

hebasto commented at 5:55 PM on April 15, 2021: member

re-ACK 241c4017eddbe33a39073766accf556c2cad90a0

in depends/README.md:53 in 241c4017ed outdated

  48 | @@ -49,6 +49,10 @@ The paths are automatically configured and no other options are needed unless ta
  49 |  
  50 |      sudo apt-get install curl librsvg2-bin libtiff-tools bsdmainutils cmake imagemagick libz-dev python3-setuptools libtinfo5 xorriso
  51 |  
  52 | +Note: You must obtain the macOS SDK before proceeding with a cross-compile.
  53 | +The SDK should be placed under `depends/SDKs/`.

jonatack commented at 6:51 PM on April 17, 2021:

Does this directory need to be created manually?

jarolrod commented at 5:22 PM on April 18, 2021:

Yep, do you think as-is may imply that the directory SDKs should be created, or should I explicitly state that.

jonatack commented at 5:25 PM on April 18, 2021:

Thanks; I'd say it, so casual users or people who don't look often in /depends won't wonder if they are missing something. Less potential head-scratching.

jarolrod commented at 8:17 PM on April 22, 2021:

adressed in 5e7d1997fce15b3e2fb77e67491237812e1f98d9

in depends/README.md:54 in 241c4017ed outdated

  48 | @@ -49,6 +49,10 @@ The paths are automatically configured and no other options are needed unless ta
  49 |  
  50 |      sudo apt-get install curl librsvg2-bin libtiff-tools bsdmainutils cmake imagemagick libz-dev python3-setuptools libtinfo5 xorriso
  51 |  
  52 | +Note: You must obtain the macOS SDK before proceeding with a cross-compile.
  53 | +The SDK should be placed under `depends/SDKs/`.
  54 | +For more information: [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction)

jonatack commented at 6:52 PM on April 17, 2021:

nit, I think the presentation with colon and no period at the end would be good if the URL is displayed, or in this case, the rendering might be better with:

For more information, see [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction).

jarolrod commented at 5:23 PM on April 18, 2021:

will do, pending your response to: #21688 (review)

jarolrod commented at 8:17 PM on April 22, 2021:

addressed in 5e7d1997fce15b3e2fb77e67491237812e1f98d9

jonatack commented at 6:55 PM on April 17, 2021: member

ACK modulo a nit and a question.

doc: note on SDK for macOS depends cross-compile 5e7d1997fc

jarolrod force-pushed on Apr 22, 2021

jarolrod commented at 8:19 PM on April 22, 2021: member

updated from 241c401 -> 5e7d1997fce15b3e2fb77e67491237812e1f98d9

addressed @jonatack suggestions:

Explicitly state that the SDKs directory must be created
Cleanup presentation of link to SDK extraction instructions

in depends/README.md:55 in 5e7d1997fc

  48 | @@ -49,6 +49,11 @@ The paths are automatically configured and no other options are needed unless ta
  49 |  
  50 |      sudo apt-get install curl librsvg2-bin libtiff-tools bsdmainutils cmake imagemagick libz-dev python3-setuptools libtinfo5 xorriso
  51 |  
  52 | +Note: You must obtain the macOS SDK before proceeding with a cross-compile.
  53 | +Under the depends directory, create a subdirectory named `SDKs`.
  54 | +Then, place the extracted SDK under this new directory.
  55 | +For more information, see [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction).

jonatack commented at 9:07 AM on April 23, 2021:

suggested simplication for brevity

-Note: You must obtain the macOS SDK before proceeding with a cross-compile.
-Under the depends directory, create a subdirectory named `SDKs`.
-Then, place the extracted SDK under this new directory.
-For more information, see [SDK Extraction](../contrib/macdeploy/README.md#sdk-extraction).
+You will need the macOS SDK. In the depends directory, create a subdirectory
+named `SDKs` and place the extracted SDK in it. For more information, see [SDK
+Extraction](../contrib/macdeploy/README.md#sdk-extraction).

jonatack commented at 9:09 AM on April 23, 2021: member

ACK 5e7d1997fce15b3e2fb77e67491237812e1f98d9

One optional suggested comment to shorten/simplify.

hebasto approved

hebasto commented at 12:32 PM on April 25, 2021: member

re-ACK 5e7d1997fce15b3e2fb77e67491237812e1f98d9

Sjors commented at 9:52 AM on April 29, 2021: member

ACK 5e7d199

There's ambiguity in the term "extracted", because you also have to extract the .tar.gz file.

fanquake merged this on Apr 29, 2021

fanquake closed this on Apr 29, 2021

sidhujag referenced this in commit 618f150131 on Apr 29, 2021

furszy referenced this in commit dc1ead77d3 on Aug 13, 2021

PastaPastaPasta referenced this in commit 9ff70e3f5e on Oct 20, 2021

PastaPastaPasta referenced this in commit e57404ce50 on Oct 21, 2021

pravblockc referenced this in commit 466c8bb26f on Nov 18, 2021

gwillen referenced this in commit 6cb16b5c8e on Jun 1, 2022

DrahtBot locked this on Aug 16, 2022