qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Marc-André Lureau" <marcandre.lureau@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, armbru@redhat.com,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [Qemu-devel] [PATCH v8 10/21] docs: add master qapi texi files
Date: Fri, 13 Jan 2017 15:41:24 +0100	[thread overview]
Message-ID: <20170113144135.5150-11-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20170113144135.5150-1-marcandre.lureau@redhat.com>

The qapi2texi script generates a file to be included in a texi file. Add
"QEMU QMP Reference Manual" and "QEMU Guest Agent Protocol Reference"
master texi files.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
---
 docs/qemu-ga-ref.texi  | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/qemu-qmp-ref.texi | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 148 insertions(+)
 create mode 100644 docs/qemu-ga-ref.texi
 create mode 100644 docs/qemu-qmp-ref.texi

diff --git a/docs/qemu-ga-ref.texi b/docs/qemu-ga-ref.texi
new file mode 100644
index 0000000000..b8898027dc
--- /dev/null
+++ b/docs/qemu-ga-ref.texi
@@ -0,0 +1,74 @@
+\input texinfo
+@setfilename qemu-ga-ref.info
+
+@exampleindent 0
+@paragraphindent 0
+
+@settitle QEMU Guest Agent Protocol Reference
+
+@copying
+This is the QEMU Guest Agent Protocol reference manual.
+
+Copyright @copyright{} 2016 The QEMU Project developers
+
+@quotation
+This manual is free documentation: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 2 of the
+License, or (at your option) any later version.
+
+This manual is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this manual.  If not, see http://www.gnu.org/licenses/.
+@end quotation
+@end copying
+
+@dircategory QEMU
+@direntry
+* QEMU-GA-Ref: (qemu-ga-ref).   QEMU Guest Agent Protocol Reference
+@end direntry
+
+@titlepage
+@title Guest Agent Protocol Reference Manual
+@subtitle QEMU version @value{VERSION}
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top QEMU Guest Agent protocol reference
+@end ifnottex
+
+@menu
+* API Reference::
+* Commands and Events Index::
+* Data Types Index::
+@end menu
+
+@node API Reference
+@chapter API Reference
+
+@c for texi2pod:
+@c man begin DESCRIPTION
+
+@include qemu-ga-qapi.texi
+
+@c man end
+
+@node Commands and Events Index
+@unnumbered Commands and Events Index
+@printindex fn
+
+@node Data Types Index
+@unnumbered Data Types Index
+@printindex tp
+
+@bye
diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
new file mode 100644
index 0000000000..efb3370a24
--- /dev/null
+++ b/docs/qemu-qmp-ref.texi
@@ -0,0 +1,74 @@
+\input texinfo
+@setfilename qemu-qmp-ref.info
+
+@exampleindent 0
+@paragraphindent 0
+
+@settitle QEMU QMP Reference Manual
+
+@copying
+This is the QEMU QMP reference manual.
+
+Copyright @copyright{} 2016 The QEMU Project developers
+
+@quotation
+This manual is free documentation: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 2 of the
+License, or (at your option) any later version.
+
+This manual is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this manual.  If not, see http://www.gnu.org/licenses/.
+@end quotation
+@end copying
+
+@dircategory QEMU
+@direntry
+* QEMU-QMP-Ref: (qemu-qmp-ref). QEMU QMP Reference Manual
+@end direntry
+
+@titlepage
+@title QMP Reference Manual
+@subtitle QEMU version @value{VERSION}
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top QEMU QMP reference
+@end ifnottex
+
+@menu
+* API Reference::
+* Commands and Events Index::
+* Data Types Index::
+@end menu
+
+@node API Reference
+@chapter API Reference
+
+@c for texi2pod:
+@c man begin DESCRIPTION
+
+@include qemu-qapi.texi
+
+@c man end
+
+@node Commands and Events Index
+@unnumbered Commands and Events Index
+@printindex fn
+
+@node Data Types Index
+@unnumbered Data Types Index
+@printindex tp
+
+@bye
-- 
2.11.0

  parent reply	other threads:[~2017-01-13 14:41 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-13 14:41 [Qemu-devel] [PATCH v8 00/21] qapi doc generation (whole version, squashed) Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 01/21] qapi: replace 'o' for list items Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 02/21] qapi: move QKeyCode doc body at the top Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 03/21] qapi: make TODOs named-sections Marc-André Lureau
2017-01-13 16:03   ` Markus Armbruster
2017-01-13 16:07     ` Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 04/21] qapi: improve device_add schema Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 05/21] qapi: improve TransactionAction doc Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 06/21] qga/schema: improve guest-set-vcpus Returns: section Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 07/21] qapi: avoid interleaving sections and parameters Marc-André Lureau
2017-01-13 16:14   ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 08/21] qapi: move experimental note down Marc-André Lureau
2017-01-13 16:14   ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 09/21] qapi: add some sections in docs Marc-André Lureau
2017-01-13 14:41 ` Marc-André Lureau [this message]
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 11/21] qapi: rework qapi Exception Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 12/21] qapi.py: fix line break before binary operator pep8 Marc-André Lureau
2017-01-13 16:15   ` Markus Armbruster
2017-01-13 16:26     ` Marc-André Lureau
2017-01-13 16:46       ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 13/21] texi2pod: learn quotation, deftp and deftypefn Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 14/21] (SQUASHED) move doc to schema Marc-André Lureau
2017-05-22 21:31   ` Eric Blake
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 15/21] qapi: add qapi2texi script Marc-André Lureau
2017-01-16  9:37   ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 16/21] docs: add qemu logo to pdf Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 17/21] build-sys: use --no-split for info Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 18/21] build-sys: remove dvi doc generation Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 19/21] build-sys: use a generic TEXI2MAN rule Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 20/21] build-sys: add txt documentation rules Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 21/21] build-sys: add qapi doc generation targets Marc-André Lureau

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170113144135.5150-11-marcandre.lureau@redhat.com \
    --to=marcandre.lureau@redhat.com \
    --cc=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).