Polonius 项目教程

1. 项目目录结构及介绍

Polonius 项目的目录结构如下：

polonius/
├── .github/
│   └── workflows/
├── book/
│   └── inputs/
├── polonius-engine/
├── polonius-parser/
├── src/
├── .gitignore
├── .mailmap
├── CODE_OF_CONDUCT.md
├── Cargo.lock
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── RELEASES.md
├── rust-toolchain
└── triagebot.toml

目录介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• book/: 包含 Polonius 项目的文档和输入文件。
• polonius-engine/: Polonius 引擎的源代码目录。
• polonius-parser/: Polonius 解析器的源代码目录。
• src/: 项目的核心源代码目录。
• .gitignore: Git 忽略文件配置。
• .mailmap: 用于管理贡献者邮件地址的映射文件。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• Cargo.lock: Cargo 依赖锁文件。
• Cargo.toml: 项目的 Cargo 配置文件。
• LICENSE-APACHE: Apache 许可证文件。
• LICENSE-MIT: MIT 许可证文件。
• README.md: 项目的主 README 文件。
• RELEASES.md: 项目的发布说明文件。
• rust-toolchain: Rust 工具链配置文件。
• triagebot.toml: Triagebot 配置文件。

2. 项目启动文件介绍

Polonius 项目的启动文件主要是通过 Cargo.toml 文件来管理项目的依赖和构建配置。启动项目的主要命令如下：

cargo run --release -- -a DatafrogOpt inputs/clap-rs/app-parser-[[impl]]-add_defaults/

启动命令说明

• cargo run: 使用 Cargo 运行项目。
• --release: 以发布模式编译和运行项目。
• -a DatafrogOpt: 选择使用 DatafrogOpt 分析算法。
• inputs/clap-rs/app-parser-[[impl]]-add_defaults/: 指定输入文件路径。

3. 项目配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的配置文件，用于管理项目的依赖、构建配置和元数据。以下是 Cargo.toml 文件的部分内容示例：

[package]
name = "polonius"
version = "0.1.0"
edition = "2018"

[dependencies]
some_dependency = "1.0"

[build-dependencies]
build_dependency = "0.5"

[features]
default = []

rust-toolchain

rust-toolchain 文件用于指定项目使用的 Rust 工具链版本。例如：

nightly-2023-01-01

triagebot.toml

triagebot.toml 文件用于配置 Triagebot，这是一个用于自动化项目管理和问题分类的工具。以下是 triagebot.toml 文件的部分内容示例：

[triagebot]
enabled = true

通过这些配置文件，可以有效地管理和运行 Polonius 项目。