neovim

commit 6c20531e486a72c00ac992f57d3c73dffb9d92ae
parent 1c12073db6c64eb365748f153f96be9b0fe61070
Author: Justin M. Keyes <justinkz@gmail.com>
Date:   Sat, 22 Nov 2025 14:33:13 -0500

docs: deprecate BUNDLED_CMAKE_FLAG

Problem:
We have too many build flags.
BUNDLED_CMAKE_FLAG is redundant with DEPS_CMAKE_FLAGS.

Solution:
In documentation, refer to DEPS_CMAKE_FLAGS instead of BUNDLED_CMAKE_FLAG.

Diffstat:
M
BUILD.md
 | 
4
++--
M
Makefile
 | 
2
++
M
runtime/doc/news.txt
 | 
2
+-

3 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/BUILD.md b/BUILD.md
@@ -297,7 +297,7 @@ are good enough. To avoid this dependency, build with support for loading
 custom terminfo at runtime, use
 
 ```sh
-make CMAKE_EXTRA_FLAGS="-DENABLE_UNIBILIUM=0" BUNDLED_CMAKE_FLAG="-DUSE_BUNDLED_UNIBILIUM=0"
+make CMAKE_EXTRA_FLAGS="-DENABLE_UNIBILIUM=0" DEPS_CMAKE_FLAGS="-DUSE_BUNDLED_UNIBILIUM=0"
 ```
 
 ### How to build static binary (on Linux)
@@ -341,7 +341,7 @@ cmake --build build
   ```
 - Example of using a package with some dependencies:
   ```
-  make BUNDLED_CMAKE_FLAG="-DUSE_BUNDLED=OFF -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_TS=ON -DUSE_BUNDLED_LIBUV=ON"
+  make DEPS_CMAKE_FLAGS="-DUSE_BUNDLED=OFF -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_TS=ON -DUSE_BUNDLED_LIBUV=ON"
   ```
 
 ## Build prerequisites
diff --git a/Makefile b/Makefile
@@ -77,6 +77,8 @@ DEPS_CMAKE_FLAGS ?=
 USE_BUNDLED ?=
 
 ifneq (,$(USE_BUNDLED))
+  # Note: BUNDLED_CMAKE_FLAG is only supported for back-compat. Don't
+  # mention it in docs. It is redundant with DEPS_CMAKE_FLAGS.
   BUNDLED_CMAKE_FLAG := -DUSE_BUNDLED=$(USE_BUNDLED)
 endif
 
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
@@ -159,7 +159,7 @@ BUILD
   the user's terminfo database won't be loaded and only internal definitions
   for the most common terminals are used. >
 
-  make distclean && make CMAKE_EXTRA_FLAGS="-DENABLE_UNIBILIUM=0" BUNDLED_CMAKE_FLAG="-DUSE_BUNDLED_UNIBILIUM=0"
+  make distclean && make CMAKE_EXTRA_FLAGS="-DENABLE_UNIBILIUM=0" DEPS_CMAKE_FLAGS"-DUSE_BUNDLED_UNIBILIUM=0"
 <
 DEFAULTS