diff options
author | scivision <scivision@users.noreply.github.com> | 2024-10-02 16:23:29 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2024-10-03 12:00:41 (GMT) |
commit | 7a88ca2e56276c6d28b8476b1185fdf99189b4c2 (patch) | |
tree | 0d57890aae18e2c003e0c8b9616e9c9d8c2951ef /Help | |
parent | 823e0a3a6187f02c06b86c32d6966eff25b9abc8 (diff) | |
download | CMake-7a88ca2e56276c6d28b8476b1185fdf99189b4c2.zip CMake-7a88ca2e56276c6d28b8476b1185fdf99189b4c2.tar.gz CMake-7a88ca2e56276c6d28b8476b1185fdf99189b4c2.tar.bz2 |
Help: Document find_program filename suffix behavior
Issue: #16453
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/find_program.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/command/find_program.rst b/Help/command/find_program.rst index b6b2508..d20ca93 100644 --- a/Help/command/find_program.rst +++ b/Help/command/find_program.rst @@ -41,3 +41,23 @@ When more than one value is given to the ``NAMES`` option this command by default will consider one name at a time and search every directory for it. The ``NAMES_PER_DIR`` option tells this command to consider one directory at a time and search for all names in it. + +The set of files considered to be programs is platform-specific: + +* On Windows, filename suffixes are considered in order ``.com``, ``.exe``, + and no suffix. + +* On non-Windows systems, no filename suffix is considered, but files + must have execute permission (see policy :policy:`CMP0109`). + +To search for scripts, specify an extension explicitly: + +.. code-block:: cmake + + if(WIN32) + set(_script_suffix .bat) + else() + set(_script_suffix .sh) + endif() + + find_program(MY_SCRIPT NAMES my_script${_script_suffix}) |