Skip to content

Commit

Permalink
doc: add MSVC and GNUC options
Browse files Browse the repository at this point in the history
  • Loading branch information
yuangongji authored and azat committed Nov 13, 2022
1 parent 8800b17 commit a3973a5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions Documentation/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)

0 comments on commit a3973a5

Please sign in to comment.