Skip to content

Commit

Permalink
style: improve comments for readability
Browse files Browse the repository at this point in the history
Signed-off-by: msclock <[email protected]>
  • Loading branch information
msclock committed Oct 12, 2023
1 parent 988c1db commit e6142fd
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 22 deletions.
33 changes: 17 additions & 16 deletions cmake/build/LinkOptimization.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ the License.

include(CheckIPOSupported)

# Checks for, and enables IPO/LTO for all following targets
#
# Running with GCC seems to have no effect
# ~~~
# Optional:
# REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
# ~~~
#[[
Checks for, and enables IPO/LTO for all following targets

Running with GCC seems to have no effect

Optional:
REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
]]
macro(link_time_optimization)
# Argument parsing
set(options REQUIRED)
Expand All @@ -55,15 +56,15 @@ macro(link_time_optimization)
endif()
endmacro()

# Checks for, and enables IPO/LTO for the specified target
#
# Running with GCC seems to have no effect
# ~~~
# Required:
# TARGET_NAME - Name of the target to generate code coverage for
# Optional:
# REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
# ~~~
#[[
Checks for, and enables IPO/LTO for the specified target

Running with GCC seems to have no effect

Arguments:
TARGET_NAME - Name of the target to generate code coverage for.(required)
REQUIRED - If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported.(optional)
]]
function(target_link_time_optimization TARGET_NAME)
# Argument parsing
set(options REQUIRED)
Expand Down
12 changes: 6 additions & 6 deletions cmake/install/InstallDependency.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ A function to enable installation of dependencies as part of the
`make install` process.

Arguments:
TARGETS - a list of installed targets to have dependencies copied for (required)
DESTINATION - the runtime directory for those targets (usually `bin`)
DIRECTORIES - the directories to search dependencies (required)
PRE_EXCLUDE_REGEXES - regular expressions to handle results (optional)
POST_EXCLUDE_REGEXES - regular expressions to handle results (optional)
POST_INCLUDE_REGEXES - regular expressions to handle results (optional)
TARGETS - a list of installed targets to have dependencies copied for. (required)
DIRECTORIES - the directories to search dependencies. (required)
DESTINATION - the runtime directory for those targets (usually `$<IF:$<PLATFORM_ID:Windows>,bin,lib>`).(optinal)
PRE_EXCLUDE_REGEXES - regular expressions to handle results. (optional)
POST_EXCLUDE_REGEXES - regular expressions to handle results. (optional)
POST_INCLUDE_REGEXES - regular expressions to handle results. (optional)

Examples:
set(app ${CMAKE_PROJECT_NAME}_app)
Expand Down

0 comments on commit e6142fd

Please sign in to comment.