CMake: Difference between revisions
From KitwarePublic
Jump to navigationJump to search
(→CMake: Reorganize page to put this wiki's content first, and to better indicate to users where to look) |
|||
| Line 17: | Line 17: | ||
* ''Getting Started With CMake'' Screencasts @[http://playcontrol.net/ewing/screencasts/getting_started_with_cmake_.html PlayControl.net] | * ''Getting Started With CMake'' Screencasts @[http://playcontrol.net/ewing/screencasts/getting_started_with_cmake_.html PlayControl.net] | ||
== | ==Reference Material== | ||
* [[CMake Useful Variables|Useful CMake Variables]] | |||
* [https://cmake.org/cmake/help/v3.9/manual/cmake-properties.7.html?highlight=properties List of CMake Properties] | |||
====The CMake Language==== | |||
* [https://cmake.org/HTML/syntax.html A quick introduction to CMake syntax] | |||
* [[CMake:VariablesListsStrings| On variables, lists, strings, maps, regexps, etc.]] | |||
* [[CMake/Language Syntax | Language syntax]] | |||
==Guides== | |||
====General==== | |||
* [[CMake Cross Compiling| Cross compiling]] | * [[CMake Cross Compiling| Cross compiling]] | ||
* [[CMake HowToDoPlatformChecks| How to write platform checks with CMake]] | |||
* [[CMake:How_To_Find_Libraries | How to find libraries]] | |||
* [[CMake:Install Commands| How to install things]] | |||
====Specific==== | |||
* [[CMake RPATH handling|RPATH handling]] | * [[CMake RPATH handling|RPATH handling]] | ||
* [[CMake Editors Support|Editors/IDEs with CMake syntax support]] | |||
* [[BuildingWinDLL| How to export symbols from a Windows DLL for the non-Windows Developer]] | |||
* [[RecipeAddSoVersionToDLLs|Appending the SO version to DLLs]] | |||
* [[CMake_Build_Rules | Advanced Usage of CMake Build Rules]] | |||
* [[CMake_Checking_Platform | How to Check the Current Platform]] | |||
==Development Topics== | |||
* [[CMake/Assembler|Assembler Support]] | * [[CMake/Assembler|Assembler Support]] | ||
* [[CMake Generator Specific Information|Docs for Specific Project Generators]] (Eclipse, KDevelop3, CodeBlocks, Makefile) | * [[CMake Generator Specific Information|Docs for Specific Project Generators]] (Eclipse, KDevelop3, CodeBlocks, Makefile) | ||
* [[CMake User Contributed Macros| Contributed macros]] | * [[CMake User Contributed Macros| Contributed macros]] | ||
| Line 43: | Line 63: | ||
* [http://www.visgraf.impa.br/seminar/slides/rodlima_cmake_presentation.pdf "CMake: Behind the Scenes of Code Development"] - Slides of an introductory talk/tutorial about CMake and its benefits | * [http://www.visgraf.impa.br/seminar/slides/rodlima_cmake_presentation.pdf "CMake: Behind the Scenes of Code Development"] - Slides of an introductory talk/tutorial about CMake and its benefits | ||
* [http://hackerwithin.org/thw/plugin_wiki/page/buildsystems The Hacker Within: Build Systems] Explains why and how to use build systems with a CMake example. | * [http://hackerwithin.org/thw/plugin_wiki/page/buildsystems The Hacker Within: Build Systems] Explains why and how to use build systems with a CMake example. | ||
* How CMake simplifies the build process by Bruno Abinader | * How CMake simplifies the build process by Bruno Abinader | ||
** [https://brunoabinader.com/how-cmake-simplifies-the-build-process-part-1-basic-build-system Part 1 - Basic build system] | ** [https://brunoabinader.com/how-cmake-simplifies-the-build-process-part-1-basic-build-system Part 1 - Basic build system] | ||
| Line 54: | Line 71: | ||
===Finding stuff and platform checking=== | ===Finding stuff and platform checking=== | ||
* [[CMake/Tutorials#CMake_Packages|How to package your project for use by others]], create FooConfig.cmake files, and exporting and importing targets. | * [[CMake/Tutorials#CMake_Packages|How to package your project for use by others]], create FooConfig.cmake files, and exporting and importing targets. | ||
* [[CMake:HowToUseExistingOSXFrameworks | How to find and use existing frameworks on OS X]]<br> A quick example to help OS X users find frameworks automatically. | * [[CMake:HowToUseExistingOSXFrameworks | How to find and use existing frameworks on OS X]]<br> A quick example to help OS X users find frameworks automatically. | ||
| Line 89: | Line 102: | ||
* [[CMake:How To Process Lots Of Input Files | How to process lots of input files with a processor built by CMake]] | * [[CMake:How To Process Lots Of Input Files | How to process lots of input files with a processor built by CMake]] | ||
* [[VSConfigSpecificSettings| Configuration Specific Settings for Visual Studio Generated Project Files]] | * [[VSConfigSpecificSettings| Configuration Specific Settings for Visual Studio Generated Project Files]] | ||
| Line 109: | Line 121: | ||
* [[RecipeAddUninstallTarget|Adding an uninstall target to your project]] | * [[RecipeAddUninstallTarget|Adding an uninstall target to your project]] | ||
==Converters from other buildsystems to CMake== | ==Converters from other buildsystems to CMake== | ||
| Line 149: | Line 160: | ||
* [[CMake:Experiments With Lua|Experiments With Lua]] | * [[CMake:Experiments With Lua|Experiments With Lua]] | ||
* [[CMake Performance Tips|Performance Tips]] | * [[CMake Performance Tips|Performance Tips]] | ||
* [[CMake:GNU style example | GNU style directory layout with CMake]] | * [[CMake:GNU style example | GNU style directory layout with CMake]] | ||
* [[CMake:OpenTasks| CMake TODO]] | * [[CMake:OpenTasks| CMake TODO]] | ||
Revision as of 02:18, 20 September 2017
Welcome to CMake, the cross-platform, open-source make system. CMake is used to control the software compilation process using simple platform and compiler independent configuration files. CMake generates native makefiles and workspaces that can be used in the compiler environment of your choice. CMake is quite sophisticated: it is possible to support complex environments requiring system configuration, pre-processor generation, code generation, and template instantiation.
You will find here not only documentation for CMake, but also for CPack and CTest.
CMake
Primary Resources - Look here first!
- Where can I download CMake?
- CMake Documentation
- Useful CMake Variables
- FAQ (Frequently asked questions)
- CMake Mailing List (for searchable archives see CMake FAQ )
- CMake 2.6 Notes
- Getting Started With CMake Screencasts @PlayControl.net
Reference Material
The CMake Language
- A quick introduction to CMake syntax
- On variables, lists, strings, maps, regexps, etc.
- Language syntax
Guides
General
Specific
- RPATH handling
- Editors/IDEs with CMake syntax support
- How to export symbols from a Windows DLL for the non-Windows Developer
- Appending the SO version to DLLs
- Advanced Usage of CMake Build Rules
- How to Check the Current Platform
Development Topics
- Assembler Support
- Docs for Specific Project Generators (Eclipse, KDevelop3, CodeBlocks, Makefile)
- Contributed macros
- Module Maintainers
- Platform Dependent Information
- Current CMake Version ChangeLog
- Documentation for previous releases
- CMake Life Cycle Considerations
- Matrix for checking backwards-compatibility of current features
- CMake builtin documentation handling
- The architecture of Open Source Applications - CMake
Tutorials
Basic Introductions
- A Simple CMake Example
- Cross-Platform Software Development Using CMake
- CMake: The Cross Platform Build System
- "Learning CMake" - Slides of a CMake workshop, including CPack, CTest and CDash
- CMake tutorial - Slides (with LaTeX bearmer source) of a CMake tutorial including CPack, CTest.
- "CMake: Behind the Scenes of Code Development" - Slides of an introductory talk/tutorial about CMake and its benefits
- The Hacker Within: Build Systems Explains why and how to use build systems with a CMake example.
- How CMake simplifies the build process by Bruno Abinader
- Empirical approach to CMAKE by Rachid Koucha
- Minimal examples (wiki page)
Finding stuff and platform checking
- How to package your project for use by others, create FooConfig.cmake files, and exporting and importing targets.
- How to find and use existing frameworks on OS X
A quick example to help OS X users find frameworks automatically.
How to use CMake with specific Libraries
- Qt with CMake
Explains how to use CMake to build software with Qt4, Qt3 and KDE3.
- Deploying Qt4 applications with CMake
Explains how to use the DeployQt4.cmake module coming with CMake 2.8.7.
- How to use CMake to create Matlab MEX files
Describes how to use CMake when developing Matlab Executable (MEX) files for use with The Mathworks Matlab scripting language.
Recipes
Converters from other buildsystems to CMake
All converters listed here are not "complete", i.e. the generated CMake files are not 100% finished, in all cases some work is left for the developer.
automake/autotools/autoconf
- am2cmake (requires Ruby) Converts automake/autotools/libtool based projects to CMake, specialized in converting from KDE 3 to KDE 4, should also work for others. This one has been used for converting the KDE buildsystem to CMake.
- Alternative Automake2CMake (requires PHP) Converts KDevelop projects that use automake to CMake.
qmake
- qmake converter (requires Ruby) Converts projects that use Qt's qmake.
Visual Studio
- vcproj2cmake.rb (requires Ruby) SourceForge project Creates and maintains CMakeLists.txt files by extracting info from Visual Studio project files (.vcproj/.vcxproj). Elaborate script for development side-by-side the updated original static .vc[x]proj files, supports script hooks and powerful definition mappings. Patches and new project members very welcome. Older script versions below:
- Original vcproj2cmake.rb version (requires Ruby)
- Slightly newer version here vcproj2cmake.rb, see:User_talk:Dweeves for details
- vcproj2cmake.ps1(PowerShell version) Creates CMakeLists.txt. it supports vcproj configuration and detect 'exclude from build' option
- folders4cmake (requires Java) Use Visual Studio project files to generate corresponding "source_group" information that you can use inside your own CMake scripts. Supports Visual Studio 9/10 project files (full round-trip possible).
Basic CMakeLists.txt from-scratch-generator
- gencmake (requires Ruby) Creates basic CMakeLists.txt files from looking at the existing files.
- CMakeListGenerator (Win32) Creates complete CMakeLists.txt files as described in the README using a combination of file and directory structure analysis. Supports resolving dependencies between multiple archives.
Success Stories
- What are some projects using CMake?
- Articles about CMake
- Really Cool CMake Features
More Topics
- Fortran Issues
- Generating dependency graphs with CMake
- Experiments With Lua
- Performance Tips
- GNU style directory layout with CMake
- CMake TODO
- Creating Qt Assistant Docs
- Writing FindXXX.cmake modules that work with static libraries
- Writing FindXXX.cmake modules that work when multiple versions of packages are installed
- CMake:Improving Find* Modules
- C Plugins for Loadable Commands
For anyone who wonders what the load_command command is for. - PC-Lint support for CMake
CTest
Tutorials
- Testing With CTest
Introduces to testing with CTest, submitting dashboards, and using CMake to add tests to the test system.
- CTest Scripting
Describes the scripting with CTest which can significantly simplify and automate testing and submitting dashboards.
- Generating Input Files For CTest
Describe more in details the concepts behind testing with CTest and also explans how to use CTest without using CMake.
- Buildmanagement With CTest
Describes how to setup a central configuration for all CTest scripts.
More Information
- Configuring CTest Submission Methods
- CTest Nightly, Experimental, Continuous, ...
- CTest:Coverage
- Media:CTest Running Modes.pdf
- CTest Frequently asked questions
More Topics
CDash
CPack
Tutorials
- Packaging with CPack
Introduction to CPack, installing and packaging of software. - CMake tutorial - Slides from a CMake tutorial (including LaTeX beamer source) including CPack.
- CPack Variables
- Supported package formats
- CPack Win32 Newbie Checklist
- Component Install With CPack
Recipes
