aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile1
-rw-r--r--contrib/local.mk.example30
2 files changed, 31 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 9390463762..1683c558e8 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
filter-false = $(strip $(filter-out 0 off OFF false FALSE,$1))
filter-true = $(strip $(filter-out 1 on ON true TRUE,$1))
+# See contrib/local.mk.example
-include local.mk
CMAKE_BUILD_TYPE ?= Debug
diff --git a/contrib/local.mk.example b/contrib/local.mk.example
new file mode 100644
index 0000000000..c8ccf8c03f
--- /dev/null
+++ b/contrib/local.mk.example
@@ -0,0 +1,30 @@
+# Copy this to 'local.mk' in the repository root to take effect.
+# Individual entries must be uncommented to take effect.
+
+# By default, the installation prefix is '/usr/local'.
+# CMAKE_EXTRA_FLAGS += -DCMAKE_INSTALL_PREFIX=/usr/local/neovim-latest
+
+# Sets the build type; defaults to Debug. Valid values:
+#
+# - Debug: Disables optimizations (-O0), enables debug information.
+#
+# - RelWithDebInfo: Enables optimizations that do not interfere with debugging
+# (-O2) which do, enables debug information.
+#
+# - MinSizeRel: Enables all -O2 optimization that do not typically
+# increase code size, and performs further optimizations
+# designed to reduce code size. Disables debug information.
+#
+# - Release: Same as RelWithDebInfo, but disables debug information.
+#
+# CMAKE_BUILD_TYPE := Debug
+
+# By default, all libraries are statically linked to nvim. Uncomment these
+# entries to use dynamic linking instead.
+#
+# CMAKE_EXTRA_FLAGS += -DLIBTERMKEY_USE_STATIC=OFF
+# CMAKE_EXTRA_FLAGS += -DLIBUNIBILIUM_USE_STATIC=OFF
+# CMAKE_EXTRA_FLAGS += -DLIBUV_USE_STATIC=OFF
+# CMAKE_EXTRA_FLAGS += -DLIBVTERM_USE_STATIC=OFF
+# CMAKE_EXTRA_FLAGS += -DLUAJIT_USE_STATIC=OFF
+# CMAKE_EXTRA_FLAGS += -DMSGPACK_USE_STATIC=OFF