diff options
author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/export.rst | |
parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
download | CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2 |
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
Diffstat (limited to 'Help/command/export.rst')
-rw-r--r-- | Help/command/export.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Help/command/export.rst b/Help/command/export.rst index d4bab35..4419dc1 100644 --- a/Help/command/export.rst +++ b/Help/command/export.rst @@ -7,20 +7,20 @@ Export targets from the build tree for use by outside projects. export(EXPORT <export-name> [NAMESPACE <namespace>] [FILE <filename>]) -Create a file <filename> that may be included by outside projects to +Create a file ``<filename>`` that may be included by outside projects to import targets from the current project's build tree. This is useful during cross-compiling to build utility executables that can run on the host platform in one project and then import them into another -project being compiled for the target platform. If the NAMESPACE -option is given the <namespace> string will be prepended to all target +project being compiled for the target platform. If the ``NAMESPACE`` +option is given the ``<namespace>`` string will be prepended to all target names written to the file. -Target installations are associated with the export <export-name> +Target installations are associated with the export ``<export-name>`` using the ``EXPORT`` option of the :command:`install(TARGETS)` command. The file created by this command is specific to the build tree and -should never be installed. See the install(EXPORT) command to export -targets from an installation tree. +should never be installed. See the :command:`install(EXPORT)` command to +export targets from an installation tree. The properties set on the generated IMPORTED targets will have the same values as the final values of the input TARGETS. @@ -45,12 +45,12 @@ unspecified. export(PACKAGE <name>) Store the current build directory in the CMake user package registry -for package <name>. The find_package command may consider the -directory while searching for package <name>. This helps dependent +for package ``<name>``. The find_package command may consider the +directory while searching for package ``<name>``. This helps dependent projects find and use a package from the current project's build tree without help from the user. Note that the entry in the package registry that this command creates works only in conjunction with a -package configuration file (<name>Config.cmake) that works with the +package configuration file (``<name>Config.cmake``) that works with the build tree. In some cases, for example for packaging and for system wide installations, it is not desirable to write the user package registry. If the :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable |