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.
This commit is contained in:
Justin M. Keyes
2025-11-22 14:33:13 -05:00
parent 1c12073db6
commit 6c20531e48
3 changed files with 5 additions and 3 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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