tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: remove backup protocol api dumps 

We now have the api-viewer for that.
This commit is contained in:
Dietmar Maurer 2021-02-26 19:00:08 +01:00
parent 28c86760da
commit 3832911d50
4 changed files with 0 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Makefile
View File

@ -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

14
docs/backup-protocol.rst
View File

@ -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

14
src/bin/dump-backup-api.rs
View File

@ -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(())
}

14
src/bin/dump-reader-api.rs
View File

@ -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(())
}