docs: add utility binary to generate docs

src/bin/docgen.rs

@@ -0,0 +1,68 @@
+use anyhow::{bail, Error};
+
+use proxmox::api::{
+    format::*,
+    section_config::*,
+};
+
+use proxmox_backup::{
+    config,
+};
+
+fn dump_section_config(config: &SectionConfig) -> String {
+
+    let mut res = String::new();
+
+    let plugin_count = config.plugins().len();
+    
+    for plugin in config.plugins().values() {
+
+        let name = plugin.type_name();
+        let properties = plugin.properties();
+        let skip = match plugin.id_property() {
+            Some(id) => vec![id],
+            None => Vec::new(),
+        };
+
+        if plugin_count > 1 {
+            res.push_str(&format!("\n**Section type** \'``{}``\'\n\n", name));
+        }
+        
+        res.push_str(&dump_api_parameters(properties, "", ParameterDisplayStyle::Config, &skip));
+    }
+    
+    res
+}
+
+fn get_args() -> (String, Vec<String>) {
+
+    let mut args = std::env::args();
+    let prefix = args.next().unwrap();
+    let prefix = prefix.rsplit('/').next().unwrap().to_string(); // without path
+    let args: Vec<String> = args.collect();
+
+    (prefix, args)
+}
+
+fn main() -> Result<(), Error> {
+
+    let (_prefix, args) = get_args();
+
+    if args.len() < 1 {
+        bail!("missing arguments");
+    }
+    
+    for arg in args.iter() {
+        match arg.as_ref() {
+            "datastore.cfg" => println!("{}", dump_section_config(&config::datastore::CONFIG)),
+            "tape.cfg" => println!("{}", dump_section_config(&config::drive::CONFIG)),
+            "user.cfg" => println!("{}", dump_section_config(&config::user::CONFIG)),
+            "remote.cfg" => println!("{}", dump_section_config(&config::remote::CONFIG)),
+            "sync.cfg" => println!("{}", dump_section_config(&config::sync::CONFIG)),
+            "media-pool.cfg" => println!("{}", dump_section_config(&config::media_pool::CONFIG)),
+            _ => bail!("docgen: got unknown type"),
+        }
+    }
+   
+    Ok(())
+}

src/config/datastore.rs

@@ -18,7 +18,7 @@ use proxmox::tools::{fs::replace_file, fs::CreateOptions};
 use crate::api2::types::*;
 
 lazy_static! {
-    static ref CONFIG: SectionConfig = init();
+    pub static ref CONFIG: SectionConfig = init();
 }
 
 // fixme: define better schemas

src/config/remote.rs

@@ -18,7 +18,7 @@ use proxmox::tools::{fs::replace_file, fs::CreateOptions};
 use crate::api2::types::*;
 
 lazy_static! {
-    static ref CONFIG: SectionConfig = init();
+    pub static ref CONFIG: SectionConfig = init();
 }
 
 pub const REMOTE_PASSWORD_SCHEMA: Schema = StringSchema::new("Password or auth token for remote host.")

src/config/sync.rs

@@ -18,7 +18,7 @@ use proxmox::tools::{fs::replace_file, fs::CreateOptions};
 use crate::api2::types::*;
 
 lazy_static! {
-    static ref CONFIG: SectionConfig = init();
+    pub static ref CONFIG: SectionConfig = init();
 }
 
 #[api(

src/config/user.rs

@@ -20,7 +20,7 @@ use proxmox::tools::{fs::replace_file, fs::CreateOptions};
 use crate::api2::types::*;
 
 lazy_static! {
-    static ref CONFIG: SectionConfig = init();
+    pub static ref CONFIG: SectionConfig = init();
 }
 
 pub const ENABLE_USER_SCHEMA: Schema = BooleanSchema::new(