summaryrefslogtreecommitdiffstats
path: root/Help/command/export.rst
Commit message (Collapse)AuthorAgeFilesLines
* EXPORT_PACKAGE_DEPENDENCIES: Add experimental feature gateBrad King2024-03-121-1/+7
| | | | | | | Some design concerns have been raised after trying the 3.29 release candidates. Avoid committing to a stable public interface for now. Issue: #25767
* install(EXPORT): Add ability to point to .xcframework fileKyle Edwards2023-11-151-0/+13
| | | | Issue: #25262
* install(EXPORT): Export find_dependency() callsKyle Edwards2023-11-131-1/+54
| | | | | | Issue: #20511 Co-Authored-by: Brad King <brad.king@kitware.com> Co-Authored-by: Robert Maynard <rmaynard@nvidia.com>
* Help/export: Add signature directivesKyle Edwards2023-11-131-8/+8
|
* cmExperimental: remove the flag for C++ modulesBen Boeckel2023-10-021-4/+1
| | | | | | | All the major compilers now have scheduled releases with support for scanning, so remove the experimental gate. Fixes: #18355
* Help: Mention imported config mapping in export() and install() docsBrad King2023-07-181-0/+4
| | | | | | | | Suggest the `CMAKE_MAP_IMPORTED_CONFIG_<CONFIG>` variable for mapping configurations of dependent projects to configurations exported by these commands. Issue: #25096
* Help: Fix formatting of CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API notesBrad King2022-08-091-2/+2
|
* exports: support `CXX_MODULES_DIRECTORY`Ben Boeckel2022-07-061-2/+14
| | | | | | | | | | | | This directory will be used to store build-discovered information about targets such as the modules provided by the files in the relevant `FILE_SET` types. A directory is used because basing the name on a `<FILE_NAME>-*.cmake` pattern makes it end up being globbed in the configuration-dependent information mechanism. Since old modules and targets may be around, unconditionally including them may refer to targets that do not actually exist.
* Help: Organize and clarify export() command documentationBrad King2022-02-141-43/+88
| | | | | | | | | Add section headers for each signature, and a synopsis linking to them. Re-order sections to introduce the main `export(TARGETS)` functionality before mentioning the `export(EXPORT)` shorthand, which may be confused with `install(EXPORT)`. Fixes: #23221
* Help: Replace some `versionadded` directives with `versionchanged`Nikita Nemkin2020-11-121-2/+2
| | | | | | | | `.. versionchanged` directive might be more appropriate when documentation refers to previous CMake version, old behavior or a policy, and there's no new parameter or a variable involved. Issue: #19715
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-5/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
* Help: Improve formatting of Help documentationBartosz Kosiorek2019-04-081-1/+1
|
* export: Disable PACKAGE mode user package registry by defaultRobert Maynard2019-03-151-2/+7
| | | | | | | The user package registry populated by the `export()` command causes side effects outside the build and source directories. Such effects should be opt-in rather than op-out. Introduce a policy to change default behavior of `export(PACKAGE)` to do nothing.
* Help: Apply syntax highlighting to project commandsJoachim Wuttke (o)2018-10-251-5/+5
| | | | | | * Replace most "::" by ".. code-block:: cmake" * Header sentence in imperative voice, detailed command description in present tense.
* doc: Consistently use <PackageName> for describing the name of a packageJean-Christophe Fillion-Robin2018-08-141-4/+4
|
* Help: Document linking behavior of OBJECT librariesBrad King2018-03-011-1/+3
| | | | | Inspired-by: Deniz Bahadir <dbahadir@benocs.com> Issue: #14778
* install,export: Maybe transform OBJECT libraries to INTERFACE librariesBrad King2018-02-281-0/+7
| | | | | | | | | | | Teach the `install` and `export` commands to support installing and exporting `OBJECT` libraries without their object files. Transform them to `INTERFACE` libraries in such cases. For `install(TARGETS)`, activate this when no destination for the object files is specified. For `export`, activate this only under Xcode with multiple architectures when we have no well-defined object file locations to give to clients.
* Add support for creating prebuilt Android.mk filesBill Hoffman2016-09-131-0/+15
| | | | | | | | | | | Add options to the `install()` and `export()` commands to export the targets we build into Android.mk files that reference them as prebuilt libraries with associated usage requirements (compile definitions, include directories, link libraries). This will allow CMake-built projects to be imported into projects using the Android NDK build system. Closes: #15562
* Help: Improve formatting of command documentationMichael Scott2015-06-081-9/+9
| | | | | Use inline reStructuredText markup and add cross-references in more places.
* Allow the Package Registry to be disabled (#14849)Daniele E. Domenichelli2014-05-121-1/+4
| | | | | | | | | | | | | | | | When a project is packaged for redistribution the local package registries should not be updated or consulted. They are for developers. Add variables to disable use of package registries globally: * CMAKE_EXPORT_NO_PACKAGE_REGISTRY that disables the export(PACKAGE) command * CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY that disables the User Package Registry in all the find_package calls. * CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY that disables the System Package Registry in all the find_package calls. Update documentation and unit tests.
* export: Implement EXPORT subcommand (#9822)Stephen Kelly2013-12-241-10/+20
| | | | | | Teach the export command to handle export sets defined by invocations of install(TARGETS ... EXPORT foo). This makes maintenance of targets exported to both the build tree and install tree trivial.
* Help: Fix reStructuredText syntax in auto-generated documentsBrad King2013-10-151-1/+1
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+44
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
generated by cgit v0.12 at 2024-11-12 16:11:56 (GMT)