Clarifying documentation of `--static-binary` (#5844)
authoryoni206 <yoni206@users.noreply.github.com>
Thu, 4 Feb 2021 21:58:38 +0000 (13:58 -0800)
committerGitHub <noreply@github.com>
Thu, 4 Feb 2021 21:58:38 +0000 (15:58 -0600)
The documentation regarding --static-binary is improved.

INSTALL.md
configure.sh

index 5693dbc1c26e5d284cba9acb7c57215468b50053..86a3171689b9540293ac44e6ce211d692c3951ab 100644 (file)
@@ -22,6 +22,8 @@ using Mingw-w64.  We recommend a 64-bit operating system.
 On macOS, we recommend using Homebrew (https://brew.sh/) to install the
 dependencies.  We also have a Homebrew Tap available at
 https://github.com/CVC4/homebrew-cvc4 .
+To build a static binary for macOS, use:
+`./configure.sh --static --no-static-binary`.
 
 ### Cross-compiling for Windows
 
@@ -29,7 +31,7 @@ Cross-compiling CVC4 with Mingw-w64 can be done as follows:
 
 ```
   HOST=x86_64-w64-mingw32 ./contrib/get-win-dependencies
-  ./configure --win64 --static <configure options...>
+  ./configure.sh --win64 --static <configure options...>
 
   cd <build_dir>   # default is ./build
   make             # use -jN for parallel build with N threads
index 48d1b82b234300ef17e69478e456a02ef12f2c83..0455e63604fdea19e162962e849031d96594127b 100755 (executable)
@@ -29,7 +29,8 @@ General options;
 Features:
 The following flags enable optional features (disable with --no-<option name>).
   --static                 build static libraries and binaries [default=no]
-  --static-binary          enable/disable static binaries
+  --static-binary          statically link against system libraries
+                           (must be disabled for static macOS builds) [default=yes]
   --proofs                 support for proof generation
   --optimized              optimize the build
   --debug-symbols          include debug symbols