bpfman 0.6.0

An eBPF Program Manager
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of bpfman

use std::{
    fs::{File, create_dir_all},
    io::Write as _,
    path::{Path, PathBuf},
};

use clap::{CommandFactory, Parser};
use flate2::{Compression, write::GzEncoder};

use crate::args::Cli;

const VERSION: &str = env!("CARGO_PKG_VERSION");

#[derive(Debug, Parser)]
pub struct Args {
    /// Output directory
    out_dir: PathBuf,
}

fn build_manpage(cmd: clap::Command, name: String, out_dir: &Path) -> Result<(), anyhow::Error> {
    let man = clap_mangen::Man::new(cmd.version(VERSION));
    let mut buffer: Vec<u8> = Default::default();
    man.render(&mut buffer)?;
    let file_path = Path::new(out_dir).join(format!("{}.1.gz", name));
    let f = File::create(&file_path)?;
    let mut e = GzEncoder::new(f, Compression::default());
    e.write_all(&buffer)?;
    e.finish()?;
    eprintln!("map page generated in {file_path:?}");
    Ok(())
}

pub fn generate(args: &Args) -> Result<(), anyhow::Error> {
    let Args { out_dir } = args;
    create_dir_all(out_dir)?;

    let cmd: clap::Command = Cli::command();
    let bpfman_name = cmd.get_name().to_owned();

    // Generate `bpfman` manpage
    build_manpage(cmd, bpfman_name.to_string(), out_dir)?;

    // Generate subcommand manpages
    let mut commands = vec![(Cli::command(), bpfman_name.to_string())];

    while let Some((cmd, name)) = commands.pop() {
        build_manpage(cmd.clone(), name.clone(), out_dir)?;

        for subcommand in cmd.get_subcommands() {
            if subcommand.is_hide_set() {
                continue;
            }
            let subcommand_name = format!("{}-{}", name, subcommand.get_name());
            commands.push((subcommand.clone(), subcommand_name));
        }
    }

    Ok(())
}