Skip to content

Commit

Permalink
Added description for build options. (#886)
Browse files Browse the repository at this point in the history
* Added build options description.
* Added entry info in README.
* Removed unnecessary descriptions in cmake.
* Fixed duplicated enable-unittests.
  • Loading branch information
ethouris authored and rndi committed Nov 7, 2019
1 parent 2bcc08b commit 325dc3f
Show file tree
Hide file tree
Showing 4 changed files with 413 additions and 10 deletions.
9 changes: 0 additions & 9 deletions CMakeLists.txt
Expand Up @@ -109,15 +109,6 @@ option(ENABLE_CXX_DEPS "Extra library dependencies in srt.pc for the CXX librari
option(USE_STATIC_LIBSTDCXX "Should use static rather than shared libstdc++" OFF)
option(ENABLE_INET_PTON "Set to OFF to prevent usage of inet_pton when building against modern SDKs while still requiring compatibility with older Windows versions, such as Windows XP, Windows Server 2003 etc." ON)
option(ENABLE_CODE_COVERAGE "Enable code coverage reporting" OFF)

# ENABLE_MONOTONIC_CLOCK: enforces the use of clock_gettime to get the current
# time, instead of gettimeofday. This function allows to force a monotonic
# clock, which is independent on the currently set time in the system. The CV,
# for which the *_timedwait() functions are used with so obtained current time,
# must be appropriately configured. The consequence of enabling this option,
# however, may be portability issues around the clock_gettime() function, which
# is not available on every SDK, or extra -lrt option is sometimes required
# (this requirement will be autodetected).
option(ENABLE_MONOTONIC_CLOCK "Enforced clock_gettime with monotonic clock on GC CV /temporary fix for #729/" OFF)
option(USE_OPENSSL_PC "Use pkg-config to find OpenSSL libraries" ON)
option(USE_BUSY_WAITING "Enable more accurate sending times at a cost of potentially higher CPU load" OFF)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -41,6 +41,8 @@ As audio/video packets are streamed from a source to a destination device, SRT d
* OpenSSL
* Pthreads (for POSIX systems it's builtin, for Windows there's a library)

For detailed description of the build system and options, please read [BuildOptions.md](docs/BuildOptions.md).

## For Linux:

Install cmake and openssl-devel (or similar name) package. For pthreads
Expand Down
1 change: 0 additions & 1 deletion configure-data.tcl
Expand Up @@ -35,7 +35,6 @@ set internal_options {
set cmake_options {
cygwin-use-posix "Should the POSIX API be used for cygwin. Ignored if the system isn't cygwin. (default: OFF)"
enable-encryption "Should encryption features be enabled (default: ON)"
enable-unittests "Should the unit tests be enabled (default: OFF)"
enable-c++11 "Should the c++11 parts (srt-live-transmit) be enabled (default: ON)"
enable-apps "Should the Support Applications be Built? (default: ON)"
enable-testing "Should developer testing applications be built (default: OFF)"
Expand Down

0 comments on commit 325dc3f

Please sign in to comment.