book

CMake Best Practices

Name: CMake Best Practices
ISBN: 9781803239729

by Dominik Berner, Mustafa Kemal Gilor

May 2022

Beginner

406 pages

8h 47m

English

Packt Publishing

Read now

Unlock full access

CMake Best Practices
ContributorsAbout the authorsAbout the reviewers
Preface
Who this book is forWhat this book coversTo get the most out of this bookDownload the example code filesDownload the color imagesConventions usedGet in touchShare Your Thoughts
Part 1: The Basics
Chapter 1: Kickstarting CMake
Technical requirementsCMake in a nutshellInstalling CMakeBuilding CMake from sourceBuilding your first projectA minimal CMakeLists.txt fileUnderstanding the CMake build processSource folders and build foldersWriting CMake filesThe CMake language – a 10,000-feet overviewDifferent toolchains and build typesBuild typesMaintaining good build configurations with presetsSummary Further readingQuestions
Chapter 2: Accessing CMake in Best Ways
Technical requirementsUsing CMake via a command-line interfaceLearning the basics of the CMake CLIAdvanced configuration using CMake-GUI and ccmakeLearning how to use ccmake (CMake curses GUI)Using CMake via cmake-gui Tweaking environment variablesEvaluating regular expressions with CMakeUsing CMake in Visual Studio, Visual Studio Code, and Qt CreatorVisual StudioVisual Studio CodeQt CreatorSummaryQuestionsFurther reading
Chapter 3: Creating a CMake Project
Technical requirementsSetting up a projectWorking with nested projects Creating a "hello world" executableCreating a simple libraryNaming librariesSymbol visibility in shared librariesInterface or header-only librariesBringing it together – using your librariesSetting compiler and linker optionsLibrary aliases SummaryQuestions
Part 2: Practical CMake – Getting Your Hands Dirty with CMake
Chapter 4: Packaging, Deploying, and Installing a CMake Project
PrerequisitesMaking CMake targets installableThe install() commandSupplying configuration information for others using your projectEntering the CMake package world – Config-file packagesCreating an installable package with CPackSummaryQuestions
Chapter 5: Integrating Third-Party Libraries and Dependency Management
Technical requirementsFinding files, programs, and paths with CMake Finding files and pathsFinding programsFinding librariesUsing third-party libraries in your CMake projectWriting your own find moduleUsing package managers with CMakeGetting dependencies from ConanUsing vcpkg for dependency managementGetting the dependencies as source codeDownloading dependencies as the source using pure CMakeSummaryQuestions
Chapter 6: Automatically Generating Documentation with CMake
Technical requirementsGenerating documentation from your codeUnderstanding what Doxygen isUsing Doxygen with CMakeEmbedding custom UML diagrams into documentationPackaging and distributing documentation with CPackCreating dependency graphs of CMake targetsSummaryQuestions

Chapter 7: Seamlessly Integrating Code Quality Tools with CMake
Technical requirementsDefining, discovering, and running testsAutomatically discovering testsAdvanced ways to determine test success or failureHandling timeouts and repeating testsWriting test fixturesRunning tests in parallel and managing test resourcesGenerating code coverage reportsGenerating coverage reports using Clang or GCCCreating coverage reports for MSVCSanitizing your codeStatic code analysis using CMakeCreating custom build types for quality toolsSummaryQuestions
Chapter 8: Executing Custom Tasks with CMake
Technical requirementsUsing external programs with CMakeExecuting custom tasks at build timeAdding custom tasks to existing targetsGenerating files with custom tasksExecuting custom tasks at configuration timeCopying and modifying files Using CMake for platform-independent commandsExecuting CMake files as scriptsSummaryQuestions
Chapter 9: Creating Reproducible Build Environments
Technical requirementsUsing CMake presetsInheriting from presetsConditions for presetsUsing build containers with CMakeUsing sysroots to isolate build environmentsSummaryQuestions
Chapter 10: Handling Big Projects and Distributed Repositories in a Superbuild
Technical requirementsRequirements and prerequisites for a super-buildBuilding across multiple code repositoriesThe recommended way – FetchContentThe legacy way – ExternalProject_AddBonus – using the Qt 6 framework with a super-buildEnsuring version consistency in a super-buildSummaryQuestions
Chapter 11: Automated Fuzzing with CMake
Technical requirementsA quick glance into fuzzing in CMake projectsIntegrating AFL++/libFuzzer into your projectUsing libFuzzer in your CMake projectUsing AFL++ in your CMake projectSummaryQuestions
Part 3: Mastering the Details
Chapter 12: Cross-Platform Compiling and Custom Toolchains
Technical requirementsUsing existing cross-platform toolchain files Creating toolchain filesDefining the target systemSelecting the build tools Setting the sysrootCross-compiling for AndroidCross-compiling for iOS, tvOS, or watchOSTesting cross-compiled binariesTesting a toolchain for supported featuresCommon checks for toolchain and language featuresSummaryQuestions
Chapter 13: Reusing CMake Code
Technical requirementsWhat is a CMake module?Fundamental building blocks of modules – functions and macrosFunctionsMacrosWriting your first very own CMake moduleCase study – dealing with project metadata filesRecommendations for sharing CMake modules between projectsSummaryQuestions
Chapter 14: Optimizing and Maintaining CMake Projects
Technical requirementsKeeping a CMake project maintainableProfiling a CMake buildOptimizing build performanceUsing unity buildsPrecompiled headersUsing a compiler cache (ccache) to speed up rebuildsSummaryQuestions
Chapter 15: Migrating to CMake
Technical requirementsHigh-level migration strategiesMigrating small projectsMigrating large projects to CMakeIntegrating legacy projects when migrating top downSummaryQuestions
Chapter 16: Contributing to CMake and Further Reading Material
PrerequisitesWhere to find the CMake communityStack OverflowReddit (r/cmake)The CMake Discourse forumThe Kitware CMake GitLab repository Contributing to CMakeRecommended books and blogsSummary
Assessments
Chapter 1, Kickstarting CMakeChapter 2, Accessing CMake in the Best WaysChapter 3, Creating a CMake ProjectChapter 4, Packaging, Deploying, and Installing a CMake ProjectChapter 5, Integrating Third-Party Libraries and Dependency ManagementChapter 6, Automatically Generating DocumentationChapter 7, Seamlessly Integrating Code-Quality Tools with CMakeChapter 8, Executing Custom Tasks with CMakeChapter 9, Creating Reproducible Build EnvironmentsChapter 10, Handling Big Projects and Distributed Repositories in a SuperbuildChapter 11, Automated Fuzzing with CMakeChapter 12, Cross-Platform-Compiling Custom ToolchainsChapter 13, Reusing CMake CodeChapter 14, Optimizing and Maintaining CMake ProjectsChapter 15, Migrating to CMake
Why subscribe?
Other Books You May EnjoyPackt is searching for authors like youShare Your Thoughts

Content preview from CMake Best Practices

Chapter 4: Packaging, Deploying, and Installing a CMake Project

Building a software project is only half the story. The other half is about delivering and presenting the software to your consumers. Consumers are the biggest stakeholders of any project, even if you are writing a hobby project for yourself. These consumers may have a variety of experiences and purposes. They might be developers, package maintainers, power users, or the average Joes. It is important to understand their use cases, scenarios, and requirements. Since the software is mostly abstract, let's assume that your project is baked beans instead – it may be delicious and may smell good in the factory, but improper packaging will reduce its shelf life, making it hard to transport ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9781803239729

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills

CMake Best Practices

by Dominik Berner, Mustafa Kemal Gilor

Chapter 4: Packaging, Deploying, and Installing a CMake Project

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.