Update instructions for building on macOS (#1052)

César Román · CAM-Gerlach · web-flow · commit 80cd8942fd95 · 2023-02-17T08:02:24.000Z
* Update instructions for building on macOS

Signed-off-by: César Román &lt;thecesrom@gmail.com&gt;

* Fix WARNING: Literal block expected; none found.

getting-started/setup-building.rst:420

* Apply suggestions from code review

Co-authored-by: C.A.M. Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;

* Install and use openssl@1.1 with Homebrew

* Apply suggestions from code review

Co-authored-by: C.A.M. Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;

* Restore Python 3.10+ PKG_CONFIG_PATH

* Update following text to match revised macOS building language

---------

Signed-off-by: César Román &lt;thecesrom@gmail.com&gt;
Co-authored-by: C.A.M. Gerlach &lt;CAM.Gerlach@Gerlach.CAM&gt;
diff --git a/getting-started/setup-building.rst b/getting-started/setup-building.rst
@@ -413,36 +413,36 @@ Apple no longer provides header files for the deprecated system version of
 OpenSSL which means that you will not be able to build the ``_ssl`` extension.
 One solution is to install these libraries from a third-party package
 manager, like Homebrew_ or MacPorts_, and then add the appropriate paths
-for the header and library files to your ``configure`` command.  For example,
+for the header and library files to your ``configure`` command.
 
-with **Homebrew**::
+For example, with **Homebrew**, install the dependencies::
 
     $ brew install pkg-config openssl@1.1 xz gdbm tcl-tk
 
-For Python 3.10 and newer::
+Then, for Python 3.10 and newer, run ``configure``::
 
     $ CFLAGS="-I$(brew --prefix gdbm)/include -I$(brew --prefix xz)/include" \
       LDFLAGS="-L$(brew --prefix gdbm)/lib -I$(brew --prefix xz)/lib" \
       PKG_CONFIG_PATH="$(brew --prefix tcl-tk)/lib/pkgconfig" \
       ./configure --with-pydebug \
-                  --with-openssl=$(brew --prefix openssl)
+                  --with-openssl="$(brew --prefix openssl@1.1)"
 
 
-For Python versions 3.9 through 3.7::
+Or, for Python 3.7 through 3.9::
 
-    $ CFLAGS="-I$(brew --prefix gdbm)/include -I$(brew --prefix xz)/include" \
+    $ export PKG_CONFIG_PATH="$(brew --prefix tcl-tk)/lib/pkgconfig"; \
+      CFLAGS="-I$(brew --prefix gdbm)/include -I$(brew --prefix xz)/include" \
       LDFLAGS="-L$(brew --prefix gdbm)/lib -L$(brew --prefix xz)/lib" \
-      PKG_CONFIG_PATH="$(brew --prefix tcl-tk)/lib/pkgconfig" \
       ./configure --with-pydebug \
-              --with-openssl=$(brew --prefix openssl@1.1) \
+              --with-openssl="$(brew --prefix openssl@1.1)" \
               --with-tcltk-libs="$(pkg-config --libs tcl tk)" \
               --with-tcltk-includes="$(pkg-config --cflags tcl tk)"
 
-and ``make``::
+And finally, run ``make``::
 
     $ make -s -j2
 
-or **MacPorts**::
+Alternatively, with **MacPorts**::
 
     $ sudo port install pkgconfig openssl xz gdbm
 
