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
34
35
36
37
38
39

#[test]
fn installation_docs_list_the_c_compiler_slot() {
    let docs = include_str!("../../../../docs/installation.md");
    assert!(
        docs.contains("C compiler") && docs.contains("`cc`, `clang`, `gcc`"),
        "installation docs must list the separate C compiler requirement for selected `.c` sources"
    );
}

#[test]
fn contributing_docs_list_the_c_compiler_slot() {
    let docs = include_str!("../../../../CONTRIBUTING.md");
    assert!(
        docs.contains("a **C compiler**"),
        "contributing docs must not describe end-to-end C/C++ coverage as requiring only a C++ compiler"
    );
    assert!(
        docs.contains("tests that exercise `.c` sources"),
        "contributing docs should explain when the C compiler is required"
    );
}

#[test]
fn install_source_docs_do_not_describe_runtime_tools_as_cxx_only() {
    let docs = include_str!("../../../../INSTALL.md");
    assert!(
        docs.contains("C/C++ toolchains"),
        "source install docs must not point users at runtime requirements as C++-only"
    );
}

#[test]
fn toolchain_crate_description_mentions_c_and_cxx() {
    let manifest = include_str!("../../../../crates/cabin-toolchain/Cargo.toml");
    assert!(
        manifest.contains("C/C++ toolchain"),
        "cabin-toolchain crate metadata should not describe the crate as C++-only: {manifest}"
    );
}