summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-developer.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Modernize example find module docs in cmake-developer(7)Brad King2018-11-201-32/+61
|
* Help/dev: Factor out a CMake Documentation Guide for developing the docsBrad King2018-11-141-529/+10
| | | | | | Remove this content from the `cmake-developer(7)` manual because it is relevant only to developers working on CMake itself. Move it to a guide in the developer documentation.
* Help: Fix policy markup example in cmake-developer(7)Brad King2018-11-141-1/+1
|
* Help: Drop compile features section from cmake-developer(7) manualBrad King2018-11-141-47/+0
| | | | | | We no longer add granular compile features. Only language standard meta features like `cxx_std_##`` need to be added, and these can be done by following existing patterns.
* Help: Link to cmake.org "Get Involved" page from cmake-developer(7)Joachim Wuttke (h)2018-11-061-0/+3
|
* doc: Consistently use <PackageName> for describing the name of a packageJean-Christophe Fillion-Robin2018-08-141-3/+3
|
* FindPython*: New implementation for Python stuffMarc Chevrier2018-03-201-0/+2
| | | | Fixes: #16142
* Maint: misc. typosluz.paz2018-02-161-1/+1
| | | | Found via `codespell`
* Help/dev: Adopt C++ subset rules in coding guideBrad King2017-04-191-24/+0
| | | | | | Move the C++ subset rules from the `cmake-developer(7)` into our dedicated coding guide since they do not need to be in user-facing documentation.
* Help: Fix cmake code block warnings produced by Sphinx 1.4Brad King2017-02-101-2/+2
| | | | | | | Some of our "cmake" code blocks do not use fully valid CMake syntax because they have placeholders for human reference. Sphinx has never been able to properly lex and highlight these, but now warns. Fix each block's syntax or change to a non-cmake block as appropriate.
* Help: Extend documented purpose of cmake-developer(7) manualBrad King2017-02-011-1/+1
| | | | Issue: #16616
* Help: Update cmake-developer(7) module license docs for new noticeBrad King2016-09-271-43/+24
|
* Avoid using KWSys auto_ptr by adopting it ourselvesBrad King2016-06-291-3/+4
| | | | | | | | | | | | Replace use of cmsys::auto_ptr with a CM_AUTO_PTR macro that maps to our own implementation adopted from the KWSys auto_ptr implementation. Later we may be able to map CM_AUTO_PTR to std::auto_ptr on compilers that do not warn about it. Automate the client site conversions: git grep -l auto_ptr -- Source/ | grep -v Source/kwsys/ | xargs sed -i \ 's|cmsys::auto_ptr|CM_AUTO_PTR|;s|cmsys/auto_ptr.hxx|cm_auto_ptr.hxx|'
* Help: Fix typo in `cmake-developer(7)` manualPrayag Verma2016-02-011-1/+1
| | | | Fix spelling mistake `sytem` => `system`.
* Project: Determine default language dialect for the compiler.Stephen Kelly2015-09-181-3/+3
| | | | | | Use the __cplusplus and __STDC_VERSION__ macros to automatically determine the default dialect for the compiler while determining its id and version.
* Help: Drop incorrect advice from cmake-developer.7 manualBrad King2015-06-081-1/+0
| | | | | Drop the comment on the purpose of PATH_SUFFIXES in our Find Module example. It was incorrect.
* Help: Add link target for Find Modules section of cmake-developer.7Brad King2015-04-071-0/+1
|
* cmTarget: Remove template argument workaround.Stephen Kelly2015-02-171-28/+0
| | | | | | Pre-C++98 compilers required that the template argument be used in the function parameters. Those compilers are no longer supported as hosts, so drop the workaround.
* Features: Define meaning for no language standard defaultBrad King2015-01-291-1/+3
| | | | | | | | | | | | Define an empty string in CMAKE_<LANG>_STANDARD_DEFAULT to mean that the toolchain has no notion of lanuage standard levels. In this case the <LANG>_STANDARD[_REQUIRED] properties will have no effect. Update the RunCMake.CompileFeatures test to exclude the LinkImplementationFeatureCycle test when there is no standard default. It can never fail because no use of specific features will adjust the CXX_STANDARD level required for any target since the standard levels have no meaning in this case.
* Help: Remove documented restriction on template use.Stephen Kelly2015-01-111-6/+0
|
* Help: Remove documented restriction on find in conditions.Stephen Kelly2015-01-111-26/+0
| | | | The necessary conversion is supported by all CMake host compilers.
* Help: Remove documented restriction on insert APIs.Stephen Kelly2015-01-111-47/+0
|
* Help: Drop FeatureSummary example in cmake-developer.7Brad King2014-12-091-11/+0
| | | | | | | | | The use of FeatureSummary inside a find module is not a convention yet used by upstream CMake modules. Drop the example from the documentation about how to write find modules. If in the future we add use of FeatureSummary to many of the upstream find modules then this example can be restored as part of establishing the convention.
* Help: Document that IMPORTED targets in Find modules may be UNKNOWN.Stephen Kelly2014-12-041-0/+5
|
* Help: Document IMPORTED_CONFIGURATIONS target property for Find modules.Stephen Kelly2014-12-041-1/+40
|
* Help: Remove recommendation about checking minimum CMake version.Stephen Kelly2014-12-041-10/+0
| | | | | If this file is being executed, the user has the CMake version providing it.
* Help: Add useful links to IMPORTED targets and usage requirements.Stephen Kelly2014-12-041-4/+3
|
* Help: Remove disadvantage creating IMPORTED targets in Find modules.Stephen Kelly2014-12-041-4/+1
| | | | | | | An IMPORTED target in either type of package can equally depend on an IMPORTED target in a Find module, which must be found as a dependency, which is presumably the problem being implied. This is not a distinction of creating an IMPORTED target in a Find module.
* Help: Link to cmake-packages(7) from the Module creation documentation.Stephen Kelly2014-12-041-1/+3
|
* Remove note disallowing use of some string and vector API.Stephen Kelly2014-11-251-26/+0
| | | | | The compilers introducing these limitations are no longer supported as host compilers.
* Remove disallowed feature which Borland did not accept.Stephen Kelly2014-11-251-22/+0
|
* Help: Update developer manual with some C++ features now permitted.Stephen Kelly2014-11-201-7/+1
|
* Help: Drop TOC from latex manualsBrad King2014-11-061-1/+1
| | | | A latex document can have its own TOC.
* Help/manual: Avoid long lines in code blocksBrad King2014-10-221-1/+2
| | | | | | Update the wording of some examples to avoid long lines in code blocks. Otherwise the formatted documentation can exceed certain column width limitations.
* Help: Clarify size_t usage in cmake-developer.7Robert Maynard2014-10-031-2/+2
|
* Help: Update style guide to use section headers for command signaturesBrad King2014-06-121-3/+4
| | | | | In order to be able to link to specific command signatures we need to use a section header instead of a horizontal separator.
* Help: Document section header underline hierarchy in cmake-developer.7Brad King2014-06-021-0/+9
| | | | | | Explicitly specify the sequence of underline characters we use in the CMake documentation. It is the same sequence as that suggested in the Sphinx documentation, but we have our own descriptions.
* Help: Organize documentation style sections in cmake-developer.7Brad King2014-06-021-77/+73
| | | | | Now that the style guidelines have section titles instead of numbers, organize them into more well-defined sections.
* Help: Add documentation style section headers to cmake-developer.7Brad King2014-06-021-110/+132
| | | | Give the style guides titles instead of numbers so we can link to them.
* Help: Use "^^^^" for subsubsection headersBrad King2014-06-021-2/+2
| | | | | | This is the convention suggested in the Sphinx documentation and is already used in several other places in the CMake documentation. Update a few places where we were using other characters.
* Merge topic 'cpack-properties'Brad King2014-05-281-4/+4
|\ | | | | | | | | | | d0b1d2a6 CPackWiX: Implement CPACK_NEVER_OVERWRITE and CPACK_PERMANENT properties 15a8af21 Add an "installed file" property scope
| * Add an "installed file" property scopeNils Gladitz2014-05-281-4/+4
| | | | | | | | | | | | | | Teach set_property and get_property an "INSTALL" property type to be associated with install-tree file paths. Make the properties available to CPack for use during packaging. Add a "prop_inst" Sphinx domain object type for documentation of such properties.
* | Help: Add a manual for compiler feature control.Stephen Kelly2014-05-271-0/+45
|/ | | | | | | | Link to it from the documentation of related properties, variables and commands. Extend the cmake-developer(7) documentation with notes on extending feature support for compilers.
* Help: Rewrite the cmake-developer.7 find module documentationAlex Merry2014-04-021-175/+370
| | | | | | | | | | | | | | As well as the traditional variables, providing imported targets is suggested, and the relative advantages and disadvantages briefly discussed. A mini-tutorial walking through creating a simple find module is provided. This changes the recommended version variable from Foo_VERSION_STRING to Foo_VERSION, because there is really no need to have different variable names for package version files vs. find modules. It notes the old variable name, though, and suggests setting it for compatibility.
* Help: Drop cmStdString from cmake-developer(7) examplesBrad King2014-03-131-6/+6
| | | | The type no longer exists within CMake.
* Help: Fix typoStephen Kelly2014-02-171-2/+2
| | | | binary_find -> binary_search.
* Help: Add a style guide.Stephen Kelly2014-02-061-2/+167
|
* Help: Fix typosStephen Kelly2014-02-061-1/+1
| | | | | | | | Psuedo -> Pseudo behaviour -> behavior CMake uses American spelling.
* Help: Note that std::string::clear may not be used.Stephen Kelly2014-01-271-4/+6
| | | | | As found in commit 519c0a5d (Can't use std::string::clear() in cmake., 2012-09-15).
* Help: Document non-use of std::set::insert.Stephen Kelly2014-01-271-0/+23
| | | | | As found in commit 8e7c207e (Use a manual loop to insert into set::set., 2012-09-15).