Skip to content

Commit 369a80f

Browse files
committed
docs: mention install interface for target_link_system_libraries
1 parent 14d4bee commit 369a80f

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,14 @@ Named String:
120120

121121
## `target_link_system_libraries` function
122122

123-
A very useful function that accepts the same arguments as `target_link_libraries` while marking their include directories as "SYSTEM", which suppresses their warnings. This helps in enabling `WARNINGS_AS_ERRORS` for your own source code.
123+
A function that accepts the same arguments as `target_link_libraries`. It has the following features:
124+
125+
- The include directories of the library are included as `SYSTEM` to suppress their warnings. This helps in enabling `WARNINGS_AS_ERRORS` for your own source code.
126+
- For installation of the package, the includes are considered to be at `${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_INCLUDEDIR}`.
124127

125128
## `target_include_system_directories` function
126129

127-
Similar to `target_include_directories`, but it suppresses the warnings. It is useful if you want to include some external directories directly.
130+
A function that accepts the same arguments as `target_include_directories`. It has the above mentioned features of `target_link_system_libraries`
128131

129132
## `target_link_cuda` function
130133

0 commit comments

Comments
 (0)