LCOV 使用文档

LCOV 使用文档

摘要

LCOV 是一个用于操作和显示程序在运行特定测试用例或测试用例集时哪些部分被执行（即“覆盖”）的工具。LCOV 由一组 Perl 脚本组成，这些脚本基于各种覆盖率工具（例如 gcov、llvm-cov、Coverage.py、Cobertura、Devel::Cover、Jacoco 等）的文本输出，实现了以下增强功能：

• HTML 输出：使用条形图和特定颜色在超链接的覆盖率报告中指示覆盖率，旨在使用户能够快速诊断和解决覆盖率问题。
• 支持大型项目：概览页面允许通过提供分层目录结构视图、项目中所有源文件的平面列表或三级详细视图（目录、文件和源代码视图）快速浏览覆盖率数据。
• 支持多种语言：包括 C/C++、Perl 和 Python。

LCOV 最初是为支持 Linux 内核覆盖率测量而设计的，但也适用于标准用户空间应用程序的覆盖率测量。

LCOV 支持差异覆盖率，以及日期和所有者分箱。有关概念和几种可能使用模型的详细解释，请参阅：

• https://arxiv.org/abs/2008.07947
• https://ieeexplore.ieee.org/document/9438597

基本思想的视频演示可以在以下网址找到：

• http://doi.org/10.5281/zenodo.4653252

此外，还提供了其他一些功能和能力。有关简要说明，请参阅下面的第 6 节，也可以参阅手册页和测试用例。

目录

1. 包含的文件
2. 安装 LCOV
3. 依赖项
4. 访问 Linux 内核覆盖率数据的示例
5. 访问用户空间程序覆盖率数据的示例
6. LCOV 功能
7. 问题和评论
8. 提交新问题

1. 重要文件

• README：本 README 文件
• CHANGES：各版本之间的更改列表
• bin/lcov：用于捕获 LCOV 覆盖率数据的工具
• bin/genhtml：用于从 LCOV 数据创建 HTML 输出的工具
• bin/gendesc：用于创建 genhtml 使用的描述文件的工具
• bin/perl2lcov：用于将 Perl Devel::Cover 数据转换为 lcov 格式的工具
• bin/llvm2lcov：用于将 LLVM ‘llvm-cov’ JSON 数据转换为 LCOV 格式的工具
• bin/py2lcov：用于将 Python Coverage.py 数据转换为 lcov 格式的工具
• bin/xml2lcov：用于将类似 Cobertura 的 XML 覆盖率数据转换为 lcov 格式的工具
• bin/geninfo：内部工具（创建 LCOV 数据文件）
• bin/genpng：内部工具（创建源文件的 png 概览）
• lcovrc：LCOV 配置文件
• man：包含所包含工具的手册页的目录
• example：包含演示 LCOV 的示例的目录
• tests：包含 LCOV 回归测试的目录
• Makefile：提供 ‘install’ 和 ‘uninstall’ 目标的 Makefile

2. 安装 LCOV

LCOV 包可以从以下网址以 RPM 或 tarball 的形式获得：

• https://github.com/linux-test-project/lcov/releases

要安装 tarball，请将其解压到目录中并运行：

make install

使用 Git 获取最新（但可能不稳定）版本：

git clone https://github.com/linux-test-project/lcov.git

切换到生成的 lcov 目录并输入：

make install

默认安装位置是 /usr/local。请注意，您可能需要具有超级用户权限才能写入系统目录。

要安装在不同位置（例如，您的主目录），请运行：