Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool
- On Sep 16, 2017, at 12:41 AM, jsnow js...@redhat.com wrote: > On 09/08/2017 12:41 PM, Ishani Chugh wrote: >> qemu-backup will be a command-line tool for performing full and >> incremental disk backups on running VMs. It is intended as a >> reference implementation for management stack and backup developers >> to see QEMU's backup features in action. This commit is an >> initial implementation of manpage listing the commands which the >> backup tool will support. The manpage will be built along with other >> docs when configure is provided with --enable-docs flag in the >> location contrib/backup in build directory. >> >> Signed-off-by: Ishani Chugh>> --- >> Makefile| 14 ++-- >> contrib/backup/qemu-backup.texi | 142 >> >> 2 files changed, 152 insertions(+), 4 deletions(-) >> create mode 100644 contrib/backup/qemu-backup.texi >> >> diff --git a/Makefile b/Makefile >> index 337a1f6..794cac5 100644 >> --- a/Makefile >> +++ b/Makefile >> @@ -209,6 +209,7 @@ ifdef BUILD_DOCS >> DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8 >> DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt >> docs/interop/qemu-qmp-ref.7 >> DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt >> docs/interop/qemu-ga-ref.7 >> +DOCS+=contrib/backup/qemu-backup.html contrib/backup/qemu-backup.txt >> ifdef CONFIG_VIRTFS >> DOCS+=fsdev/virtfs-proxy-helper.1 >> endif >> @@ -517,6 +518,8 @@ VERSION ?= $(shell cat VERSION) >> >> dist: qemu-$(VERSION).tar.bz2 >> >> +qemu-backup.8: contrib/backup/qemu-backup.texi >> + >> qemu-%.tar.bz2: >> $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst >> qemu-%.tar.bz2,%,$@)" >> >> @@ -728,16 +731,19 @@ fsdev/virtfs-proxy-helper.1: >> fsdev/virtfs-proxy-helper.texi >> qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi >> qemu-ga.8: qemu-ga.texi >> >> -html: qemu-doc.html docs/interop/qemu-qmp-ref.html >> docs/interop/qemu-ga-ref.html >> -info: qemu-doc.info docs/interop/qemu-qmp-ref.info >> docs/interop/qemu-ga-ref.info >> -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf >> -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt >> +html: qemu-doc.html docs/interop/qemu-qmp-ref.html >> docs/interop/qemu-ga-ref.html contrib/backup/qemu-backup.html >> +info: qemu-doc.info docs/interop/qemu-qmp-ref.info >> docs/interop/qemu-ga-ref.info contrib/backup/qemu-backup.info >> +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf >> contrib/backup/qemu-backup.pdf >> +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt >> contrib/backup/qemu-backup.txt >> >> qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ >> qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \ >> qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \ >> qemu-monitor-info.texi >> >> +contrib/backup/qemu-backup.html contrib/backup/qemu-backup.pdf >> contrib/backup/qemu-backup.txt contrib/backup/qemu-backup.info: \ >> +contrib/backup/qemu-backup.texi >> + >> docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ >> docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ >> docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \ >> diff --git a/contrib/backup/qemu-backup.texi >> b/contrib/backup/qemu-backup.texi >> new file mode 100644 >> index 000..7ad266c >> --- /dev/null >> +++ b/contrib/backup/qemu-backup.texi >> @@ -0,0 +1,142 @@ >> +\input texinfo >> +@setfilename qemu-backup >> + >> +@documentlanguage en >> +@documentencoding UTF-8 >> + >> +@settitle QEMU Backup Tool >> +@copying >> + >> +Copyright @copyright{} 2017 The QEMU Project developers >> +@end copying >> +@ifinfo >> +@direntry >> +* QEMU: (QEMU-backup).Man page for QEMU Backup Tool. >> +@end direntry >> +@end ifinfo >> +@iftex >> +@titlepage >> +@sp 7 >> +@center @titlefont{QEMU Backup Tool} >> +@sp 1 >> +@sp 3 >> +@end titlepage >> +@end iftex >> +@ifnottex >> +@node Top >> +@top Short Sample >> + >> +@menu >> +* Name:: >> +* Synopsis:: >> +* List of Commands:: >> +* Command Parameters:: >> +* Command Descriptions:: >> +* License:: >> +@end menu >> + >> +@end ifnottex >> + >> +@node Name >> +@chapter Name >> + >> +QEMU disk backup tool. >> + >> +@node Synopsis >> +@chapter Synopsis >> + >> +qemu-backup command [command options]. >> + >> +@node List of Commands >> +@chapter List of Commands >> +@itemize >> +@item qemu-backup guest add --guest guestname --qmp socketpath >> +@item qemu-backup guest list >> +@item qemu-backup drive add --id driveid --guest guestname --target target >> +@item qemu-backup drive add --all --guest guestname --target target >> +@item qemu-backup drive list --guest guestname >> +@item qemu-backup restore --guest guestname >> +@item qemu-backup guest remove --guest guestname >> +@item qemu-backup
Re: [Qemu-devel] [PATCH v4 1/3] Add manpage for QEMU Backup Tool
On 09/08/2017 12:41 PM, Ishani Chugh wrote: > qemu-backup will be a command-line tool for performing full and > incremental disk backups on running VMs. It is intended as a > reference implementation for management stack and backup developers > to see QEMU's backup features in action. This commit is an > initial implementation of manpage listing the commands which the > backup tool will support. The manpage will be built along with other > docs when configure is provided with --enable-docs flag in the > location contrib/backup in build directory. > > Signed-off-by: Ishani Chugh> --- > Makefile| 14 ++-- > contrib/backup/qemu-backup.texi | 142 > > 2 files changed, 152 insertions(+), 4 deletions(-) > create mode 100644 contrib/backup/qemu-backup.texi > > diff --git a/Makefile b/Makefile > index 337a1f6..794cac5 100644 > --- a/Makefile > +++ b/Makefile > @@ -209,6 +209,7 @@ ifdef BUILD_DOCS > DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8 > DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt > docs/interop/qemu-qmp-ref.7 > DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt > docs/interop/qemu-ga-ref.7 > +DOCS+=contrib/backup/qemu-backup.html contrib/backup/qemu-backup.txt > ifdef CONFIG_VIRTFS > DOCS+=fsdev/virtfs-proxy-helper.1 > endif > @@ -517,6 +518,8 @@ VERSION ?= $(shell cat VERSION) > > dist: qemu-$(VERSION).tar.bz2 > > +qemu-backup.8: contrib/backup/qemu-backup.texi > + > qemu-%.tar.bz2: > $(SRC_PATH)/scripts/make-release "$(SRC_PATH)" "$(patsubst > qemu-%.tar.bz2,%,$@)" > > @@ -728,16 +731,19 @@ fsdev/virtfs-proxy-helper.1: > fsdev/virtfs-proxy-helper.texi > qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi > qemu-ga.8: qemu-ga.texi > > -html: qemu-doc.html docs/interop/qemu-qmp-ref.html > docs/interop/qemu-ga-ref.html > -info: qemu-doc.info docs/interop/qemu-qmp-ref.info > docs/interop/qemu-ga-ref.info > -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf > -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt > +html: qemu-doc.html docs/interop/qemu-qmp-ref.html > docs/interop/qemu-ga-ref.html contrib/backup/qemu-backup.html > +info: qemu-doc.info docs/interop/qemu-qmp-ref.info > docs/interop/qemu-ga-ref.info contrib/backup/qemu-backup.info > +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf > contrib/backup/qemu-backup.pdf > +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt > contrib/backup/qemu-backup.txt > > qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ > qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \ > qemu-monitor.texi qemu-img-cmds.texi qemu-ga.texi \ > qemu-monitor-info.texi > > +contrib/backup/qemu-backup.html contrib/backup/qemu-backup.pdf > contrib/backup/qemu-backup.txt contrib/backup/qemu-backup.info: \ > + contrib/backup/qemu-backup.texi > + > docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ > docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ > docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \ > diff --git a/contrib/backup/qemu-backup.texi b/contrib/backup/qemu-backup.texi > new file mode 100644 > index 000..7ad266c > --- /dev/null > +++ b/contrib/backup/qemu-backup.texi > @@ -0,0 +1,142 @@ > +\input texinfo > +@setfilename qemu-backup > + > +@documentlanguage en > +@documentencoding UTF-8 > + > +@settitle QEMU Backup Tool > +@copying > + > +Copyright @copyright{} 2017 The QEMU Project developers > +@end copying > +@ifinfo > +@direntry > +* QEMU: (QEMU-backup).Man page for QEMU Backup Tool. > +@end direntry > +@end ifinfo > +@iftex > +@titlepage > +@sp 7 > +@center @titlefont{QEMU Backup Tool} > +@sp 1 > +@sp 3 > +@end titlepage > +@end iftex > +@ifnottex > +@node Top > +@top Short Sample > + > +@menu > +* Name:: > +* Synopsis:: > +* List of Commands:: > +* Command Parameters:: > +* Command Descriptions:: > +* License:: > +@end menu > + > +@end ifnottex > + > +@node Name > +@chapter Name > + > +QEMU disk backup tool. > + > +@node Synopsis > +@chapter Synopsis > + > +qemu-backup command [command options]. > + > +@node List of Commands > +@chapter List of Commands > +@itemize > +@item qemu-backup guest add --guest guestname --qmp socketpath > +@item qemu-backup guest list > +@item qemu-backup drive add --id driveid --guest guestname --target target > +@item qemu-backup drive add --all --guest guestname --target target > +@item qemu-backup drive list --guest guestname > +@item qemu-backup restore --guest guestname > +@item qemu-backup guest remove --guest guestname > +@item qemu-backup drive remove --guest guestname --id driveid > +@end itemize > +@node Command Parameters > +@chapter Command Parameters > +@itemize > +@item --all: Add all the drives present in a guest which are