diff options
author | Brad King <brad.king@kitware.com> | 2013-10-16 13:28:12 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-16 13:28:12 (GMT) |
commit | c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch) | |
tree | 96102c69673467ce7b922697cd5f378511249201 /Help/command/install_files.rst | |
parent | 5029da5eac08171653a92b961c341f7ffcca3640 (diff) | |
parent | 7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff) | |
download | CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2 |
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...
Diffstat (limited to 'Help/command/install_files.rst')
-rw-r--r-- | Help/command/install_files.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/Help/command/install_files.rst b/Help/command/install_files.rst new file mode 100644 index 0000000..7b6bd81 --- /dev/null +++ b/Help/command/install_files.rst @@ -0,0 +1,39 @@ +install_files +------------- + +Deprecated. Use the install(FILES ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. The FILES form is +directly replaced by the FILES form of the install command. The +regexp form can be expressed more clearly using the GLOB form of the +file command. + +:: + + install_files(<dir> extension file file ...) + +Create rules to install the listed files with the given extension into +the given directory. Only files existing in the current source tree +or its corresponding location in the binary tree may be listed. If a +file specified already has an extension, that extension will be +removed first. This is useful for providing lists of source files +such as foo.cxx when you want the corresponding foo.h to be installed. +A typical extension is '.h'. + +:: + + install_files(<dir> regexp) + +Any files in the current source directory that match the regular +expression will be installed. + +:: + + install_files(<dir> FILES file file ...) + +Any files listed after the FILES keyword will be installed explicitly +from the names given. Full paths are allowed in this form. + +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. |