summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2018-03-22 09:32:28 +0000
committerPatrick Steinhardt <ps@pks.im>2018-05-30 11:11:08 +0200
commit432dfda0fb1b93fe52a13f33319eac350423e445 (patch)
treedaa1283d3c3b82529eb9a3cf411de4d3f6236d2c /README.md
parentfaf2629ae34139c76f6887aa6ae583c33e4acc25 (diff)
downloadlibgit2-432dfda0fb1b93fe52a13f33319eac350423e445.tar.gz
README.md: detail how to list all build options
We do not list all build options inside of the README.md, and we definitly shouldn't do so. But in order to help people discover what can be configured, add instructions on how to have CMake generate the list of all knobs together with their current value.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index c5adafa97..5b5018854 100644
--- a/README.md
+++ b/README.md
@@ -254,6 +254,15 @@ The following CMake variables are declared:
- `THREADSAFE`: Build libgit2 with threading support (defaults to ON)
- `STDCALL`: Build libgit2 as `stdcall`. Turn off for `cdecl` (Windows; defaults to ON)
+To list all build options and their current value, you can do the
+following:
+
+ # Create and set up a build directory
+ $ mkdir build
+ $ cmake ..
+ # List all build options and their values
+ $ cmake -L
+
Compiler and linker options
---------------------------