docs: add backup reader protocol

This commit is contained in:
Dietmar Maurer 2019-11-22 06:59:37 +01:00
parent 5e6b9e4428
commit 45cc157f7c
4 changed files with 34 additions and 3 deletions

View File

@ -9,7 +9,8 @@ endif
GENERATED_SYNOPSIS := \
proxmox-backup-client/synopsis.rst \
proxmox-backup-manager/synopsis.rst \
backup-protocol-api.rst
backup-protocol-api.rst \
reader-protocol-api.rst
MANUAL_PAGES := \
pxar.1 \
@ -37,6 +38,10 @@ all: ${MANUAL_PAGES}
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
@ -80,7 +85,7 @@ epub3: ${GENERATED_SYNOPSIS}
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
clean:
rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} backup-protocol-api.rst
rm -r -f *~ *.1 ${BUILDDIR} ${GENERATED_SYNOPSIS}
install: ${MANUAL_PAGES}
install -dm755 $(DESTDIR)$(MAN1DIR)

View File

@ -1,11 +1,19 @@
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

View File

@ -11,3 +11,8 @@ Command Syntax
.. include:: proxmox-backup-manager/synopsis.rst
``pxar``
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: pxar/synopsis.rst

View File

@ -0,0 +1,13 @@
use failure::*;
use proxmox_backup::api2;
use proxmox_backup::api_schema::format::*;
fn main() -> Result<(), Error> {
let api = api2::reader::READER_API_ROUTER;
dump_api(&mut std::io::stdout(), &api, ".", 0)?;
Ok(())
}