cmake-annotate1

Parse cmake listfiles and re-emit them with semantic annotations in html.

Usage

cmake-annotate [-h] [--format page,stub] [-o OUTFILE_PATH] [-c CONFIG_FILE] infilepath [infilepath ...]

Overview

Parse cmake listfiles and re-emit them with semantic annotations in HTML.

Some options regarding parsing are configurable by providing a configuration file. The configuration file format is the same as that used by cmake-format, and the same file can be used for both programs.

cmake-format can spit out the default configuration for you as starting point for customization. Run with `--dump-config [yaml|json|python]`.

infilepaths

Options

-v, --version: show program's version number and exit

-f {page,stub,iframe}, --format {page,stub,iframe}: whether to output a standalone `page` complete with <html></html> tags, or just the annotated content

-o OUTFILE_PATH, --outfile-path OUTFILE_PATH: Where to write the formatted file. Default is stdout.

-c CONFIG_FILE, --config-file CONFIG_FILE: path to configuration file

Distribution

The latest version of cmake-annotate may be downloaded from ⟨https://github.com/cheshirekow/cmake_format⟩

History

Debian 13 (Trixie): the text shown here
Debian 12 (Bookworm) to Debian 11 (Bullseye)