From: yoni206 <yoni206@users.noreply.github.com>
Date: Thu, 4 Feb 2021 21:58:38 +0000 (-0800)
Subject: Clarifying documentation of `--static-binary` (#5844)
X-Git-Tag: cvc5-1.0.0~2322
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d89ff37c2dfbd91dd89169ad5dda06b5cc8f0a7b;p=cvc5.git

Clarifying documentation of `--static-binary` (#5844)

The documentation regarding --static-binary is improved.
---

diff --git a/INSTALL.md b/INSTALL.md
index 5693dbc1c..86a317168 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -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
diff --git a/configure.sh b/configure.sh
index 48d1b82b2..0455e6360 100755
--- a/configure.sh
+++ b/configure.sh
@@ -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