website

CMake Docs

所属分类:开发者在线工具箱

CMake 官方文档站,提供参考手册、入门教程和社区论坛入口。

CMake Docs 是 CMake 构建系统的官方文档站,包含参考手册、分步教程、命令行工具说明和各版本的文档。读者既可以查 cmake、ctest、cpack 的用法,也可以从教程的 Step 1 开始,学习如何为源代码建立构建。

CMake Docs:查阅参考手册、分步教程,并切换 3.0 到 4.5 的版本

发布于 2026年10月18日更新于 2026年10月29日

文档总入口

CMake 官网文档与社区页面截图,页首为 CMake 标志,正文标题为 CMake Documentation and Community,下方列出 Reference Documentation 的 HTML 与 QtHelp 链接和各版本号

官网的文档与社区页(cmake.org/documentation/)标题为 CMake Documentation and Community,分为 Reference Documentation、Community、Contributions 和 Other Resources 等部分。参考手册可以在线以 HTML 阅读,也可以下载 QtHelp 格式。版本列表包括 master 与 stage 两个开发版本(stage 为 master 加上待合并的变更),以及 3.0 之前 cmake(1)、ctest(1)、cpack(1) 的 2.8 等历史版本。

参考手册的结构

在线参考手册(cmake.org/cmake/help/latest/)的版本菜单标明 latest release (4.5.0-rc2),即截至 2026 年 10 月官网标为最新的版本是 4.5.0-rc2。页面的 Introduction 说明,CMake 最初是生成 Makefile 的工具,之后能够生成 Ninja 构建文件,以及 Visual Studio 和 Xcode 的工程文件。

Introduction 还按读者的目标分流:要构建一个从网上下载的源代码包,先读 User Interaction Guide;要引入第三方库,读 Using Dependencies Guide;要新建项目,从 CMake Tutorial 开始;cmake-buildsystem(7) 则面向需要维护构建系统的开发者。目录中的 Reference Manuals 部分包括 cmake-commands(7)、cmake-variables(7)、cmake-presets(7)、cpack-generators(7) 等章节。

CMake 参考手册 Introduction 页面截图,左侧为目录,正文列出 Command-Line Tools、Interactive Dialogs 与 Reference Manuals 三组链接,标题栏显示 CMake 4.5.0-rc1

截图的标题栏写的是 CMake 4.5.0-rc1,截至 2026 年 10 月,同一页面的版本已标注为 4.5.0-rc2,目录结构和章节列表相同。

分步教程

教程(guide/tutorial)分为 Step 0 到 Step 10。Step 0 介绍获取教程代码、生成器和基本用法;Step 1 讲如何构建可执行文件、库、链接库以及子目录;Step 2 讲宏、函数、列表、条件与循环;Step 3 讲配置选项、缓存变量和 CMakePresets.json;Step 8 讲测试与 CTest;Step 9 讲安装与导出目标;Step 10 讲 find_package() 与依赖查找。页面说明,每一步的示例都是上一步的完整解答,因此教程按顺序阅读最合适。

社区与问题反馈

文档页明确区分了问题去向。问题跟踪器(Issue Tracker)用于向 Kitware 的 CMake 开发者报告技术问题,页面特别写明,跟踪器不适合提 CMake 使用问题;一般问题应发到 CMake Discourse Forum。社区 Wiki 对所有人开放,但需要登录并申请权限后才能编辑。

页面还有一个 Advanced Support for CMake 的推广区块,请读者联系 Kitware 的 CMake 专家。这一服务与公开的文档和论坛是两回事。