From 3832911d50ddff5a3a0728d04cdadfc43b66e789 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Fri, 26 Feb 2021 19:00:08 +0100 Subject: [PATCH] docs: remove backup protocol api dumps We now have the api-viewer for that. --- docs/Makefile | 10 ---------- docs/backup-protocol.rst | 14 -------------- src/bin/dump-backup-api.rs | 14 -------------- src/bin/dump-reader-api.rs | 14 -------------- 4 files changed, 52 deletions(-) delete mode 100644 src/bin/dump-backup-api.rs delete mode 100644 src/bin/dump-reader-api.rs diff --git a/docs/Makefile b/docs/Makefile index dfa1a0c9..05352b48 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -8,8 +8,6 @@ GENERATED_SYNOPSIS := \ pxar/synopsis.rst \ pmtx/synopsis.rst \ pmt/synopsis.rst \ - backup-protocol-api.rst \ - reader-protocol-api.rst \ config/media-pool/config.rst \ config/tape/config.rst \ config/tape-job/config.rst \ @@ -81,14 +79,6 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . all: ${MAN1_PAGES} ${MAN5_PAGES} -# Extract backup protocol docs -backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api - ${COMPILEDIR}/dump-backup-api >$@ - -# Extract reader protocol docs -reader-protocol-api.rst: ${COMPILEDIR}/dump-reader-api - ${COMPILEDIR}/dump-backup-api >$@ - # Build manual pages using rst2man pxar/synopsis.rst: ${COMPILEDIR}/pxar diff --git a/docs/backup-protocol.rst b/docs/backup-protocol.rst index a2ad2173..2d78f375 100644 --- a/docs/backup-protocol.rst +++ b/docs/backup-protocol.rst @@ -3,17 +3,3 @@ Backup Protocol .. todo:: add introduction to HTTP2 based backup protocols -Backup Protocol API -------------------- - -.. todo:: describe backup writer protocol - -.. include:: backup-protocol-api.rst - - -Reader Protocol API -------------------- - -.. todo:: describe backup reader protocol - -.. include:: reader-protocol-api.rst diff --git a/src/bin/dump-backup-api.rs b/src/bin/dump-backup-api.rs deleted file mode 100644 index 4cb908bc..00000000 --- a/src/bin/dump-backup-api.rs +++ /dev/null @@ -1,14 +0,0 @@ -use anyhow::{Error}; - -use proxmox::api::format::*; - -use proxmox_backup::api2; - -fn main() -> Result<(), Error> { - - let api = api2::backup::BACKUP_API_ROUTER; - - dump_api(&mut std::io::stdout(), &api, ".", 0)?; - - Ok(()) -} diff --git a/src/bin/dump-reader-api.rs b/src/bin/dump-reader-api.rs deleted file mode 100644 index 5abd96c6..00000000 --- a/src/bin/dump-reader-api.rs +++ /dev/null @@ -1,14 +0,0 @@ -use anyhow::{Error}; - -use proxmox::api::format::dump_api; - -use proxmox_backup::api2; - -fn main() -> Result<(), Error> { - - let api = api2::reader::READER_API_ROUTER; - - dump_api(&mut std::io::stdout(), &api, ".", 0)?; - - Ok(()) -}