From 40f24fe8e1a4cb8aecd5f9b41e7a94915a12b99a Mon Sep 17 00:00:00 2001 From: Tamir Duberstein Date: Fri, 14 Jul 2023 10:26:10 -0400 Subject: [PATCH] site: generate docs for logging crates --- xtask/src/{docs/mod.rs => docs.rs} | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) rename xtask/src/{docs/mod.rs => docs.rs} (88%) diff --git a/xtask/src/docs/mod.rs b/xtask/src/docs.rs similarity index 88% rename from xtask/src/docs/mod.rs rename to xtask/src/docs.rs index a8ef37cb..e10c80a2 100644 --- a/xtask/src/docs/mod.rs +++ b/xtask/src/docs.rs @@ -17,8 +17,15 @@ pub fn exec(cmd: &mut Command) -> Result<()> { } pub fn docs() -> Result<()> { - const PACKAGE_TO_DESCRIPTION: &[(&str, &str)] = - &[("aya", "User-space"), ("aya-bpf", "Kernel-space")]; + const PACKAGE_TO_DESCRIPTION: &[(&str, &str)] = &[ + ("aya", "User-space BPF program loading and manipulation"), + ("aya-bpf", "Kernel-space BPF program implementation toolkit"), + ("aya-log-ebpf", "Kernel-space logging from BPF programs"), + ( + "aya-log", + "User-space consumption of logs from BPF programs", + ), + ]; let Metadata { workspace_root, @@ -92,7 +99,7 @@ pub fn docs() -> Result<()> { for (package, description) in PACKAGE_TO_DESCRIPTION { let package = package.replace('-', "_"); writedoc! {&mut index, r#" -
  • Aya {description} Development Documentation
  • +
  • Aya {description}
  • "#} .context("write to string")?; }