cabinpkg 0.15.0

A package manager and build system for C/C++
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

#[test]
fn environment_variables_doc_lists_terminal_env_controls() {
    let docs = include_str!("../../../../docs/environment-variables.md");
    for name in [
        cabin_env::CABIN_TERM_COLOR,
        cabin_env::CABIN_TERM_VERBOSE,
        cabin_env::CABIN_TERM_QUIET,
    ] {
        assert!(
            docs.contains(&format!("`{name}`")),
            "docs/environment-variables.md must list `{name}` because Cabin reads it"
        );
    }
}

#[test]
fn environment_variables_doc_lists_build_time_version_metadata() {
    let docs = include_str!("../../../../docs/environment-variables.md");
    for name in [
        "CABIN_BUILD_COMMIT",
        "CABIN_BUILD_COMMIT_DATE",
        "CABIN_BUILD_HOST",
    ] {
        assert!(
            docs.contains(&format!("`{name}`")),
            "docs/environment-variables.md claims to list every CABIN_* variable Cabin reads, so it must list build-time `{name}`"
        );
    }
    assert!(
        docs.contains("not runtime controls"),
        "build-time metadata docs must make clear these variables are not runtime controls"
    );
}