roman/srt
1
0
Fork 0
mirror of https://github.com/Haivision/srt.git synced 2026-07-04 15:07:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

[build] Add enabler variable to importing variable feature (#3307)

Browse Source 
Co-authored-by: Mikołaj Małecki <mmalecki@haivision.com>
This commit is contained in:
Sektor van Skijlen
2026-04-17 08:56:57 +02:00
committed by GitHub
parent c3cfa17e2a
commit b6b4ae990d
2 changed files with 35 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CMakeLists.txt
+17 -12
View File
@@ -122,19 +122,24 @@ endforeach()
# SRT_MAVG_SAMPLING_RATE 40 /* Max sampling rate */
# SRT_ENABLE_FREQUENT_LOG_TRACE 0 : set to 1 to enable printing reason for suppressed freq logs
# CMake offers the OLD behavior, where names that are defined below with
# option() function, will be deleted if they are not in cache or do not have set
# type - so effectively options provided through LIBSRT_* prefix would be rejected.
# We do want these variables, obviously.
# NOTE: This is introduced in cmake 3.13, so the namespaced-option feature will not
# work properly in the old cmake.
if (CMAKE_VERSION VERSION_GREATER 3.12)
cmake_policy(SET CMP0077 NEW)
endif()
# Blocked by a general enabler, LIBSRT_ENABLE_IMPORT_VARIABLES, to prevent accidental use.
if ( (DEFINED LIBSRT_ENABLE_IMPORT_VARIABLES) AND (LIBSRT_ENABLE_IMPORT_VARIABLES EQUAL 1))
unset(LIBSRT_ENABLE_IMPORT_VARIABLES)
# Import all options preceded with LIBSRT_ likely from a parent scope.
# Names are not being checked, at worst it will set an unused variable.
srt_import_parent_options()
# CMake offers sometimes OLD behavior, where names that are defined below with
# option() function, will be deleted if they are not in cache or do not have set
# type - so effectively options provided through LIBSRT_* prefix would be rejected.
# We do want these variables, obviously.
# NOTE: This is introduced in cmake 3.13, so the namespaced-option feature will not
# work properly in the old cmake.
if (CMAKE_VERSION VERSION_GREATER 3.12)
cmake_policy(SET CMP0077 NEW)
endif()
# Import all options preceded with LIBSRT_ likely from a parent scope.
# Names are not being checked, at worst it will set an unused variable.
srt_import_parent_options()
endif()
# option defaults
set(ENABLE_HEAVY_LOGGING_DEFAULT OFF)
docs/build/build-options.md
Vendored
+18 -7
View File
@@ -20,12 +20,22 @@ document and in the [SRT CookBook](https://srtlab.github.io/srt-cookbook/getting
## Building as a subproject
The CMake tool offers the ability to add a complete project as a subdirectory.
Variables used by the SRT project in this case remain in their own scope, but
all variables from the parent scope are reflected. In order to prevent name
clashes for option-designating variables, SRT provides a namespace-like
prefixing for the optional variables it uses. If you want to configure optional
variables from the level of `CMakeLists.txt` of the parent project, use the
`LIBSRT_` prefix for the option names.
If you do this with SRT, note that all variables that can be optionally set
will get values from the parent configuration file including the one from SRT.
To allow isolation of these variables and setting them explicitly to desired
values in case when the parent project uses variables with the same names,
there's a special feature provided: set the desired variables for the SRT
project using `LIBSRT_` prefix - this way they will get the values to the
right variables, visible only in the scope of the SRT build configuration.
NOTE: This feature needs to be generally enabled by:
```
set (LIBSRT_ENABLE_IMPORT_VARIABLES 1)
```
otherwise all other variables with `LIBSRT_` prefix will be ignored.
This will not prevent the variables from being seen as derived in SRT project
scope, but if you explicitly set a variable this way, it will be set to the
@@ -34,9 +44,10 @@ parent project, and it will also override (locally in SRT project only) any
value of a variable with the same name in the parent project.
For example, if you want to set `ENABLE_SHARED=OFF` in the parent project,
simply do:
add this before importing the SRT project:
```
set (LIBSRT_ENABLE_IMPORT_VARIABLES 1)
set (LIBSRT_ENABLE_SHARED OFF)
```