Commit 432dfda0fb1b93fe52a13f33319eac350423e445

Patrick Steinhardt 2018-03-22T09:32:28

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
diff --git a/README.md b/README.md
index c5adafa..5b50188 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
 ---------------------------