diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/get_filename_component.rst | 37 | ||||
| -rw-r--r-- | Help/prop_tgt/NO_SONAME.rst | 6 | ||||
| -rw-r--r-- | Help/release/dev/get-filename-component-base-dir.rst | 6 | ||||
| -rw-r--r-- | Help/release/dev/modules-no-soname.rst | 7 |
4 files changed, 48 insertions, 8 deletions
diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index 60488da..82f9120 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -3,6 +3,8 @@ get_filename_component Get a specific component of a full filename. +------------------------------------------------------------------------------ + :: get_filename_component(<VAR> <FileName> <COMP> [CACHE]) @@ -15,8 +17,6 @@ Set ``<VAR>`` to a component of ``<FileName>``, where ``<COMP>`` is one of: NAME = File name without directory EXT = File name longest extension (.b.c from d/a.b.c) NAME_WE = File name without directory or longest extension - ABSOLUTE = Full path to file - REALPATH = Full path to existing file with symlinks resolved PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) Paths are returned with forward slashes and have no trailing slahes. @@ -24,14 +24,41 @@ The longest file extension is always considered. If the optional ``CACHE`` argument is specified, the result variable is added to the cache. +------------------------------------------------------------------------------ + +:: + + get_filename_component(<VAR> <FileName> + <COMP> [BASE_DIR <BASE_DIR>] + [CACHE]) + +Set ``<VAR>`` to the absolute path of ``<FileName>``, where ``<COMP>`` is one +of: + +:: + + ABSOLUTE = Full path to file + REALPATH = Full path to existing file with symlinks resolved + +If the provided ``<FileName>`` is a relative path, it is evaluated relative +to the given base directory ``<BASE_DIR>``. If no base directory is +provided, the default base directory will be +:variable:`CMAKE_CURRENT_SOURCE_DIR`. + +Paths are returned with forward slashes and have no trailing slahes. If the +optional ``CACHE`` argument is specified, the result variable is added to the +cache. + +------------------------------------------------------------------------------ + :: - get_filename_component(<VAR> FileName + get_filename_component(<VAR> <FileName> PROGRAM [PROGRAM_ARGS <ARG_VAR>] [CACHE]) -The program in ``FileName`` will be found in the system search path or +The program in ``<FileName>`` will be found in the system search path or left as a full path. If ``PROGRAM_ARGS`` is present with ``PROGRAM``, then -any command-line arguments present in the ``FileName`` string are split +any command-line arguments present in the ``<FileName>`` string are split from the program name and stored in ``<ARG_VAR>``. This is used to separate a program name from its arguments in a command line string. diff --git a/Help/prop_tgt/NO_SONAME.rst b/Help/prop_tgt/NO_SONAME.rst index fc668b5..ee45ed8 100644 --- a/Help/prop_tgt/NO_SONAME.rst +++ b/Help/prop_tgt/NO_SONAME.rst @@ -1,11 +1,11 @@ NO_SONAME --------- -Whether to set "soname" when linking a shared library or module. +Whether to set "soname" when linking a shared library. -Enable this boolean property if a generated shared library or module +Enable this boolean property if a generated shared library should not have "soname" set. Default is to set "soname" on all -shared libraries and modules as long as the platform supports it. +shared libraries as long as the platform supports it. Generally, use this property only for leaf private libraries or plugins. If you use it on normal shared libraries which other targets link against, on some platforms a linker will insert a full path to diff --git a/Help/release/dev/get-filename-component-base-dir.rst b/Help/release/dev/get-filename-component-base-dir.rst new file mode 100644 index 0000000..c0df759 --- /dev/null +++ b/Help/release/dev/get-filename-component-base-dir.rst @@ -0,0 +1,6 @@ +get-filename-component-base-dir +------------------------------- + +* The :command:`get_filename_component` command learned a new ``BASE_DIR`` + subcommand. This is used to specify a base directory when calculating an + absolute path from a relative path. diff --git a/Help/release/dev/modules-no-soname.rst b/Help/release/dev/modules-no-soname.rst new file mode 100644 index 0000000..8fe74f8 --- /dev/null +++ b/Help/release/dev/modules-no-soname.rst @@ -0,0 +1,7 @@ +modules-no-soname +----------------- + +* The ``SONAME`` field is no longer set for ``MODULE`` libraries + created with the :command:`add_library` command. ``MODULE`` + libraries are meant for explicit dynamic loading at runtime. + They cannot be linked so ``SONAME`` is not useful. |