Rustdoc for seL4 crates

The public APIs of this project’s crates depend heavily on the combination of seL4 configuration, crate feature selection, and rustc target specification. We have generated rustdoc for a few representative combinations. Each entry below provides a consistent view of all relevant crates for one such combination.

The rustdoc for each view is generated all at once with one cargo doc invocation on the meta crate, whose only purpose is to depend on and select features for the other crates. Due to a current limitation of rustdoc, each view can only include at most one language runtime crate (e.g. sel4-root-task or sel4-microkit).

Views

rustdoc runtime crate: sel4-root-task rustc target spec: aarch64-sel4.json seL4 config: SEL4_ARCH=aarch64, PLAT=qemu-arm-virt, KERNEL_MCS=false (full seL4 config)

rustdoc runtime crate: sel4-root-task rustc target spec: aarch64-sel4-minimal.json seL4 config: SEL4_ARCH=aarch64, PLAT=qemu-arm-virt, KERNEL_MCS=false (full seL4 config)

rustdoc runtime crate: sel4-microkit rustc target spec: aarch64-sel4-microkit.json seL4 config: SEL4_ARCH=aarch64, PLAT=qemu-arm-virt, KERNEL_MCS=true (full seL4 config)

rustdoc runtime crate: sel4-microkit rustc target spec: aarch64-sel4-microkit-minimal.json seL4 config: SEL4_ARCH=aarch64, PLAT=qemu-arm-virt, KERNEL_MCS=true (full seL4 config)

rustdoc runtime crate: sel4-root-task rustc target spec: armv7a-sel4.json seL4 config: SEL4_ARCH=aarch32, PLAT=qemu-arm-virt, KERNEL_MCS=false (full seL4 config)

rustdoc runtime crate: sel4-root-task rustc target spec: riscv64imac-sel4.json seL4 config: SEL4_ARCH=riscv64, PLAT=qemu-riscv-virt, KERNEL_MCS=false (full seL4 config)

rustdoc runtime crate: sel4-root-task rustc target spec: riscv32imac-sel4.json seL4 config: SEL4_ARCH=riscv32, PLAT=spike, KERNEL_MCS=false (full seL4 config)

rustdoc runtime crate: sel4-root-task rustc target spec: x86_64-sel4.json seL4 config: SEL4_ARCH=x86_64, PLAT=pc99, KERNEL_MCS=false (full seL4 config)