Browse Source

Merge pull request #655 from aya-rs/logs-docs

site: generate docs for logging crates
Tamir Duberstein 1 year ago
parent
commit
464fb54b25
1 changed files with 10 additions and 3 deletions
  1. 10 3
      xtask/src/docs.rs

+ 10 - 3
xtask/src/docs/mod.rs → 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#"
-            <li><a href="{package}/index.html">Aya {description} Development Documentation</a></li>
+            <li><a href="{package}/index.html">Aya {description}</a></li>
         "#}
         .context("write to string")?;
     }