]> granicus.if.org Git - libevent/commitdiff
doc: add MSVC and GNUC options
authoryuangongji <82787816@qq.com>
Wed, 19 Jun 2019 14:27:39 +0000 (22:27 +0800)
committerAzat Khuzhin <azat@libevent.org>
Sun, 13 Nov 2022 12:59:39 +0000 (13:59 +0100)
Documentation/Building.md

index d32816cb964b49b6899f34d0a9de2b84437f8136..cf02d79f78a88f775674d01354c51a10c579e3d6 100644 (file)
@@ -76,6 +76,7 @@ $ make verify # Optional
 ```
 
 ## CMake Variables
+General options:
 ```
 # Type of the library to build (SHARED or STATIC)
 # Default is: SHARED for MSVC, otherwise BOTH
@@ -124,6 +125,26 @@ EVENT__FORCE_KQUEUE_CHECK:BOOL=OFF
 # Build documentation with doxygen
 EVENT__DOXYGEN:BOOL=OFF
 ```
+MSVC specific options:
+```
+# Link static runtime libraries.
+# Defaults to ON if EVENT_LIBRARY_TYPE is equal to "STATIC", otherwise OFF
+EVENT__MSVC_STATIC_RUNTIME:BOOL
+```
+GNUC specific options:
+```
+# Disable verbose warnings with GCC
+EVENT__DISABLE_GCC_WARNINGS:BOOL=OFF
+
+# Enable compiler security checks
+EVENT__ENABLE_GCC_HARDENING:BOOL=OFF
+
+# Enable gcc function sections
+EVENT__ENABLE_GCC_FUNCTION_SECTIONS:BOOL=OFF
+
+# Make all GCC warnings into errors
+EVENT__ENABLE_GCC_WARNINGS:BOOL=OFF
+```
 __More variables can be found by running `cmake -LAH <sourcedir_path>`__
 
 [Back to top &uarr;](#jump-to)