summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authoryuangongji <82787816@qq.com>2019-06-19 22:27:39 +0800
committerAzat Khuzhin <azat@libevent.org>2022-11-13 13:59:39 +0100
commita3973a5a5344bb2fa71adccd01d17c4218644667 (patch)
tree1efaa3a40d612b25c951d4a6b4f49257f44ee65f /Documentation
parent8800b17a3d37a764027874e8f89796e7539b7ae1 (diff)
downloadlibevent-a3973a5a5344bb2fa71adccd01d17c4218644667.tar.gz
doc: add MSVC and GNUC options
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Building.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/Documentation/Building.md b/Documentation/Building.md
index d32816cb..cf02d79f 100644
--- a/Documentation/Building.md
+++ b/Documentation/Building.md
@@ -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)