summaryrefslogtreecommitdiffstats
path: root/Help/command/add_library.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-24/+46
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: add_library(<name> OBJECT) can omit the source filesDeniz Bahadir2020-09-101-2/+2
|
* Merge topic 'build-interface-targets'Brad King2020-08-101-2/+29
|\ | | | | | | | | | | | | | | | | | | bafa9fe887 fileapi: Add INTERFACE libraries with SOURCES to codemodel-v2 4391913133 Add INTERFACE libraries to generated buildsystem if they have SOURCES afb998704e Remove filtering of allowed INTERFACE library properties e7edba2baf Makefiles: Use IsInBuildSystem in global generator target type checks Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5078
| * Add INTERFACE libraries to generated buildsystem if they have SOURCESBrad King2020-08-071-2/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | INTERFACE libraries were created with the intention of collecting usage requirements for use by other targets via `target_link_libraries`. Therefore they were not allowed to have SOURCES and were not included in the generated buildsystem. In practice, this has become limiting: * Header-only libraries do have sources, they just do not compile. Developers should be able to edit those sources (the header files) in their IDE. * Header-only libraries may need to generate some of their header files via custom commands. Some projects work around these limitations by pairing each interface library with an `add_custom_target` that makes the header files and custom commands appear in the generated buildsystem and in IDEs. Lift such limitations by allowing INTERFACE libraries to have SOURCES. For those with sources, add a corresponding build target to the generated buildsystem. Fixes: #19145
* | Help: Document in add_library that IMPORTED_IMPLIB is for DLL import libsBrad King2020-08-041-1/+6
|/ | | | Fixes: #21053
* Help: State in add_library that INTERFACE libraries have no build targetsBrad King2020-07-311-5/+9
|
* Help: Consolidate add_library documentation on IMPORTED librariesBrad King2020-07-311-32/+34
| | | | | | | | | Move documentation on IMPORTED INTERFACE libraries to the main section on Imported Libraries. Revise the section to clarify the different kinds of imported libraries that can be created and what properties they need. Issue: #18975
* Help: Re-order add_library sectionsBrad King2020-07-311-61/+61
| | | | | Put all the sections that create in-project targets first, and move Imported Libraries and Alias Libraries at the end.
* add_library/add_executable: allow local alias to imported targetsMarc Chevrier2020-06-021-2/+7
| | | | Fixes: #20641
* add_library: Document UNKNOWN type of imported targetsCristian Adam2019-06-021-0/+6
|
* INTERFACE Target: allow (PUBLIC/PRIVATE)_HEADER propertiesAvraham Shukron2019-04-111-6/+11
| | | | | | | Also support installing headers on an INTERFACE library. Signed-off-by: Avraham Shukron <avraham.shukron@gmail.com> Fixes: #15234
* 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.
* Help: Replace occurrences of "Mac OS X" with "macOS"Bartosz Kosiorek2018-09-051-1/+1
| | | | | | | | Apple's main Operating system changed their name from OS X to macOS: https://www.engadget.com/2016/06/13/os-x-is-now-macos/ Revise documentation accordingly.
* Merge topic 'doc-add_library-IMPORTED_OBJECTS'Brad King2018-07-161-2/+5
|\ | | | | | | | | | | | | 62b4df1e84 Help: Mention IMPORTED_OBJECTS in add_library docs Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2216
| * Help: Mention IMPORTED_OBJECTS in add_library docsBrad King2018-07-161-2/+5
| | | | | | | | | | | | | | The `IMPORTED_OBJECTS` is to object libraries as `IMPORTED_LOCATION` is to normal libraries. Fixes: #18176
* | Help: add_library(INTERFACE): add reference to add_link_options()Marc Chevrier2018-06-201-0/+1
|/
* Help: Document linking behavior of OBJECT librariesBrad King2018-03-011-4/+4
| | | | | Inspired-by: Deniz Bahadir <dbahadir@benocs.com> Issue: #14778
* add_library: mention that Xcode requires a real source fileBen Boeckel2017-12-011-3/+3
| | | | | | | The docs mentioned that it happened, but not when. Mention Xcode since it is the culprit today. See #16524.
* Add support for IMPORTED GLOBAL targets to be aliasedDeniz Bahadir2017-10-261-1/+2
| | | | | Issue: #15569 Issue: #17197
* Defer check for sources within a target until generation.Deniz Bahadir2017-10-241-5/+6
| | | | | | | | | | | | | | | The `add_library` and `add_executable` commands can now be called with no source-files and won't generate a warning or error message, as long as source-files will be added later via the `target_sources` command. If during the generation step still no sources are associated with targets created by such calls a useful error message will be generated and generation fails. Targets of type `INTERFACE_LIBRARY`, `UTILITY` or `GLOBAL_TARGET` are excluded from this check because we do not need sources for these target types during generation. Fixes: #16872
* Help: Fix typo in add_library(... ALIAS ...) textGregor Jasny2017-05-141-1/+1
|
* Help: Document HEADER_FILE_ONLY use caseRoman Lebedev2017-05-091-0/+4
| | | | Describe how to get sources into IDE project files.
* Allow OBJECT libraries to be installed, exported, and importedRobert Maynard2017-04-181-5/+4
| | | | | | | | Teach install() and export() to handle the actual object files. Disallow this on Xcode with multiple architectures because it still cannot be cleanly supported there. Co-Author: Brad King <brad.king@kitware.com>
* Apple: Add support for static frameworksGregor Jasny2017-01-311-1/+1
| | | | Closes: #16432
* Fix spelling typos in comments and documentation (#16037)Felix Geyer2016-03-291-1/+1
| | | | | The Debian package checker tool (lintian) detected several typos in CMake.
* Help: Document that SHARED libraries must export a symbol (#15775)James Johnston2015-10-081-0/+6
| | | | | | | CMake assumes that a SHARED library compiled on Windows will export a LIB file. This is not actually the case on Visual C++ if the library does not export any symbols, and causes incremental builds to break if the user specifies SHARED anyway. (Users should use MODULE libraries instead.)
* Help: Document Apple Framework creation with an example (#15651)Brad King2015-07-141-0/+2
|
* Merge branch 'release-doc-formatting' into doc-formattingBrad King2014-11-061-8/+11
|\ | | | | | | | | Resolve conflict in Modules/ExternalProject.cmake by keeping our side, which is more completely revised.
| * Help: Format add_library documented list of INTERFACE commandsBrad King2014-11-061-8/+11
| | | | | | | | Use a bullet list to make it easier to read.
* | Documentation: Fix minor typo thecommand -> the commandNils Gladitz2014-10-311-1/+1
|/
* add_library: Allow arbitrary non-linked sources in OBJECT librariesBrad King2014-07-091-1/+2
| | | | | | | | | | | Loosen this restriction on OBJECT libraries to allow source files of any name to be generated by custom commands or listed for reference in IDE projects so long as they would not affect linking of a normal library. Update the rejection message to be more specific about the looser restriction. Extend the ObjectLibrary test to cover a ".cmake" file generated by a custom command in an OBJECT library.
* Help: Link to Object Library docs from add_libraryBrad King2014-06-121-2/+2
|
* Help: Organize add_library command documentationBrad King2014-06-121-4/+15
| | | | | Add a section for each library type signature. Add a table of contents at the top for the html builder.
* Help: Mention INTERFACE_SOURCES as settable for INTERFACE libsBrad King2014-06-121-2/+3
| | | | | | | The add_library(INTERFACE) and Interface Libraries documentation list all the INTERFACE_* properties and target_* commands that can be used to define the interface. Add INTERFACE_SOURCES and target_sources() to these lists for completeness.
* cmTarget: Allow any generator expression in SOURCES property.Stephen Kelly2014-04-021-2/+4
| | | | | | | | | | | | | | | | Remove use of UseObjectLibraries from Makefile and Ninja generators. It is not needed now because those generators use GetExternalObjects which already contains the objects from object libraries. The VS10 generator calls both the UseObjectLibraries and the GetExternalObjects methods. Ensure that duplicates are not created by skipping objects from object libraries in handling of GetExternalObjects. Similarly, fix VS6, VS7 and Xcode object handling by skipping external objects from OBJECT_LIBRARY usage as appropriate. The error message in the BadSourceExpression1 test is now reported by the generator expression evaluator, so it has different text.
* Help: Mark up the buildsystem commands documentationStephen Kelly2014-02-061-80/+87
| | | | Cross-link to the cmake-buildsystem manual.
* add_library: Disallow invalid signatures for INTERFACE_LIBRARY.Stephen Kelly2014-01-061-4/+13
| | | | | Document the valid signatures. Add a test for the IMPORTED GLOBAL signature.
* Help: Fix reStructuredText syntax in auto-generated documentsBrad King2013-10-151-1/+1
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+120
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 2025-01-09 19:33:30 (GMT)