docs: add manual page for verification.cfg

debian/proxmox-backup-server.install

@@ -25,6 +25,7 @@ usr/share/man/man5/datastore.cfg.5
 usr/share/man/man5/user.cfg.5
 usr/share/man/man5/remote.cfg.5
 usr/share/man/man5/sync.cfg.5
+usr/share/man/man5/verification.cfg.5
 usr/share/zsh/vendor-completions/_proxmox-backup-manager
 usr/share/zsh/vendor-completions/_pmtx
 usr/share/zsh/vendor-completions/_pmt

docs/Makefile

@@ -12,6 +12,7 @@ GENERATED_SYNOPSIS := 						\
 	config/user/config.rst					\
 	config/remote/config.rst				\
 	config/sync/config.rst					\
+	config/verification/config.rst				\
 	config/acl/roles.rst					\
 	config/datastore/config.rst
 
@@ -28,6 +29,7 @@ MAN5_PAGES :=				\
 	user.cfg.5			\
 	remote.cfg.5			\
 	sync.cfg.5			\
+	verification.cfg.5		\
 	datastore.cfg.5
 
 PRUNE_SIMULATOR_FILES := 					\
@@ -121,6 +123,12 @@ config/sync/config.rst: ${COMPILEDIR}/docgen
 sync.cfg.5: config/sync/man5.rst config/sync/config.rst config/sync/format.rst
 	rst2man $< >$@
 
+config/verification/config.rst: ${COMPILEDIR}/docgen
+	${COMPILEDIR}/docgen verification.cfg >$@
+
+verification.cfg.5: config/verification/man5.rst config/verification/config.rst config/verification/format.rst
+	rst2man $< >$@
+
 config/acl/roles.rst: ${COMPILEDIR}/docgen
 	${COMPILEDIR}/docgen "config::acl::Role" >$@
 

docs/config/verification/format.rst

@@ -0,0 +1,16 @@
+Each entry starts with a header ``verification: <name>``, followed by the
+job configuration options.
+
+::
+
+  verification: verify-store2
+	ignore-verified true
+	outdated-after 7
+	schedule daily
+	store store2
+
+  verification: ...
+
+
+You can use the ``proxmox-backup-manager verify-job`` command to manipulate
+this file.

docs/config/verification/man5.rst

@@ -0,0 +1,35 @@
+==========================
+verification.cfg
+==========================
+
+.. include:: ../../epilog.rst
+
+-------------------------------------------------------------
+Verification Job Configuration
+-------------------------------------------------------------
+
+:Author: |AUTHOR|
+:Version: Version |VERSION|
+:Manual section: 5
+
+Description
+===========
+
+The file /etc/proxmox-backup/sync.cfg is a configuration file for
+Proxmox Backup Server. It contains the verification job
+configuration.
+
+
+File Format
+===========
+
+.. include:: format.rst
+
+
+Options
+=======
+
+.. include:: config.rst
+
+
+.. include:: ../../pbs-copyright.rst

docs/configuration-files.rst

@@ -80,3 +80,18 @@ Options
 ^^^^^^^
 
 .. include:: config/sync/config.rst
+
+
+``verification.cfg``
+~~~~~~~~~~~~~~~~~
+
+File Format
+^^^^^^^^^^^
+
+.. include:: config/verification/format.rst
+
+
+Options
+^^^^^^^
+
+.. include:: config/verification/config.rst

src/bin/docgen.rs

@@ -34,6 +34,7 @@ fn main() -> Result<(), Error> {
             "user.cfg" => dump_section_config(&config::user::CONFIG),
             "remote.cfg" => dump_section_config(&config::remote::CONFIG),
             "sync.cfg" => dump_section_config(&config::sync::CONFIG),
+            "verification.cfg" => dump_section_config(&config::verify::CONFIG),
             "media-pool.cfg" => dump_section_config(&config::media_pool::CONFIG),
             "config::acl::Role" => dump_enum_properties(&config::acl::Role::API_SCHEMA)?,
             _ => bail!("docgen: got unknown type"),

src/config/verify.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();
 }