kcov 项目技术文档

1. 安装指南

1.1 使用 Docker 安装

kcov 提供了官方的 Docker 镜像，适用于 v31 及以上版本。您可以通过以下命令拉取并运行 Docker 镜像：

docker pull kcov/kcov
docker run -it --rm kcov/kcov

1.2 手动安装

如果您不想使用 Docker，可以按照以下步骤手动安装 kcov：

1. 克隆项目仓库：

   git clone https://github.com/SimonKagstrom/kcov.git
   cd kcov
   

2. 按照 INSTALL.md 文件中的说明进行编译和安装：

   mkdir build
   cd build
   cmake ..
   make
   sudo make install
   

2. 项目的使用说明

2.1 基本用法

kcov 的基本用法非常简单，只需指定输出目录和可执行文件即可：

kcov /path/to/outdir executable [args for the executable]

其中，/path/to/outdir 是生成的覆盖率报告的输出目录，executable 是您要测试的可执行文件。

2.2 过滤输出

在某些情况下，您可能希望过滤掉某些不感兴趣的文件或路径。kcov 提供了两种方式来过滤输出：

2.2.1 字符串比较过滤

kcov --exclude-pattern=/usr/include --include-pattern=part/of/path,other/path \
      /path/to/outdir executable

此命令将排除包含 /usr/include 的路径，并仅包含包含 part/of/path 或 other/path 的路径。

2.2.2 路径过滤

kcov --include-path=/my/src/path /path/to/outdir executable
kcov --exclude-path=/usr/include /path/to/outdir executable

这种方式使用路径查找来过滤输出。

2.3 合并多个 kcov 运行结果

kcov 还支持合并多个运行结果。使用 --merge 选项，您可以将多个 kcov 运行的结果合并到一个输出目录中：

kcov --merge /tmp/merged-output /tmp/kcov-output1 /tmp/kcov-output2
kcov --merge /tmp/merged-output /tmp/kcov-output*    # 使用通配符

3. 项目API使用文档

kcov 提供了丰富的命令行选项，以下是一些常用的 API 选项：

• --exclude-pattern=<pattern>: 排除匹配指定模式的文件。
• --include-pattern=<pattern>: 仅包含匹配指定模式的文件。
• --include-path=<path>: 仅包含指定路径的文件。
• --exclude-path=<path>: 排除指定路径的文件。
• --merge: 合并多个 kcov 运行的结果。

4. 项目安装方式

kcov 的安装方式主要有两种：

1. Docker 安装：使用官方 Docker 镜像进行安装，适用于 v31 及以上版本。
2. 手动安装：通过克隆项目仓库并按照 INSTALL.md 文件中的说明进行编译和安装。

通过以上步骤，您可以轻松安装并使用 kcov 进行代码覆盖率测试。