[Qemu-devel] [PATCH v2 05/11] docs: add qapi texi template

[Marc-André Lureau]

The qapi2texi scripts uses a template for the texi file. Since we are
going to generate the documentation in multiple formats, move qmp-intro
to qemu-qapi template. (it would be nice to write something similar for
qemu-ga, but this is left for a future patch)

Signed-off-by: Marc-André Lureau <address@hidden>
---
 docs/qemu-ga-qapi.template.texi |  58 ++++++++++++++++
 docs/qemu-qapi.template.texi    | 148 ++++++++++++++++++++++++++++++++++++++++
 docs/qmp-intro.txt              |  87 -----------------------
 3 files changed, 206 insertions(+), 87 deletions(-)
 create mode 100644 docs/qemu-ga-qapi.template.texi
 create mode 100644 docs/qemu-qapi.template.texi
 delete mode 100644 docs/qmp-intro.txt

diff --git a/docs/qemu-ga-qapi.template.texi b/docs/qemu-ga-qapi.template.texi
new file mode 100644
index 0000000..3ddbf56
--- /dev/null
+++ b/docs/qemu-ga-qapi.template.texi
@@ -0,0 +1,58 @@
+\input texinfo
address@hidden qemu-ga-qapi
address@hidden en
address@hidden 0
address@hidden 0
+
address@hidden QEMU-GA QAPI Reference Manual
+
address@hidden
address@hidden
+* QEMU-GA-QAPI: (qemu-doc).    QEMU-GA QAPI Reference Manual
address@hidden direntry
address@hidden ifinfo
+
address@hidden
address@hidden
address@hidden 7
address@hidden @titlefont{{QEMU Guest Agent {version}}}
address@hidden 1
address@hidden @titlefont{{QAPI Reference Manual}}
address@hidden 3
address@hidden titlepage
address@hidden iftex
+
address@hidden
address@hidden Top
address@hidden
+
+This is the QEMU Guest Agent QAPI reference for QEMU {version}.
+
address@hidden
+* API Reference::
+* Commands and Events Index::
+* Data Types Index::
address@hidden menu
+
address@hidden ifnottex
+
address@hidden
+
address@hidden API Reference
address@hidden API Reference
+
address@hidden man begin DESCRIPTION
+{qapi}
address@hidden man end
+
address@hidden man begin SEEALSO
+The HTML documentation of QEMU for more precise information.
address@hidden man end
+
address@hidden Commands and Events Index
address@hidden Commands and Events Index
address@hidden fn
address@hidden Data Types Index
address@hidden Data Types Index
address@hidden tp
address@hidden
diff --git a/docs/qemu-qapi.template.texi b/docs/qemu-qapi.template.texi
new file mode 100644
index 0000000..102c8d9
--- /dev/null
+++ b/docs/qemu-qapi.template.texi
@@ -0,0 +1,148 @@
+\input texinfo
address@hidden qemu-qapi
address@hidden en
address@hidden 0
address@hidden 0
+
address@hidden QEMU QAPI Reference Manual
+
address@hidden
address@hidden
+* QEMU: (qemu-doc).    QEMU QAPI Reference Manual
address@hidden direntry
address@hidden ifinfo
+
address@hidden
address@hidden
address@hidden 7
address@hidden @titlefont{{QEMU Emulator {version}}}
address@hidden 1
address@hidden @titlefont{{QAPI Reference Manual}}
address@hidden 3
address@hidden titlepage
address@hidden iftex
+
address@hidden
address@hidden Top
address@hidden
+
+This is the QMP QAPI reference for QEMU {version}.
+
address@hidden
+* Introduction::
+* API Reference::
+* Commands and Events Index::
+* Data Types Index::
address@hidden menu
+
address@hidden ifnottex
+
address@hidden
+
address@hidden Introduction
address@hidden Introduction
+
+The QEMU Machine Protocol (@acronym{{QMP}}) allows applications to
+operate a QEMU instance.
+
+QMP is @uref{{http://www.json.org, JSON}} based and features the
+following:
+
address@hidden @minus
address@hidden
+Lightweight, text-based, easy to parse data format
address@hidden
+Asynchronous messages support (ie. events)
address@hidden
+Capabilities Negotiation
address@hidden itemize
+
+For detailed information on QEMU Machine Protocol, the specification
+is in @file{{qmp-spec.txt}}.
+
address@hidden Usage
+
+You can use the @option{{-qmp}} option to enable QMP. For example, the
+following makes QMP available on localhost port 4444:
+
address@hidden
+$ qemu [...] -qmp tcp:localhost:4444,server,nowait
address@hidden example
+
+However, for more flexibility and to make use of more options, the
address@hidden command-line option should be used. For instance, the
+following example creates one HMP instance (human monitor) on stdio
+and one QMP instance on localhost port 4444:
+
address@hidden
+$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \
+             -chardev socket,id=mon1,host=localhost,port=4444,server,nowait \
+             -mon chardev=mon1,mode=control,pretty=on
address@hidden example
+
+Please, refer to QEMU's manpage for more information.
+
address@hidden Simple testing
+
+To manually test QMP one can connect with telnet and issue commands by
+hand:
+
address@hidden
+$ telnet localhost 4444
+Trying 127.0.0.1...
+Connected to localhost.
+Escape character is '^]'.
address@hidden
+    "QMP": @{{
+        "version": @{{
+            "qemu": @{{
+                "micro": 50,
+                "minor": 6,
+                "major": 1
+            @}},
+            "package": ""
+        @}},
+        "capabilities": [
+        ]
+    @}}
address@hidden
+
address@hidden "execute": "qmp_capabilities" @}}
address@hidden
+    "return": @{{
+    @}}
address@hidden
+
address@hidden "execute": "query-status" @}}
address@hidden
+    "return": @{{
+        "status": "prelaunch",
+        "singlestep": false,
+        "running": false
+    @}}
address@hidden
address@hidden example
+
address@hidden Wiki
+
+Please refer to the @uref{{http://wiki.qemu-project.org/QMP, QMP QEMU
+ wiki page}} for more details on QMP.
+
address@hidden API Reference
address@hidden API Reference
+
address@hidden man begin DESCRIPTION
+{qapi}
address@hidden man end
+
address@hidden man begin SEEALSO
+The HTML documentation of QEMU for more precise information.
address@hidden man end
+
address@hidden Commands and Events Index
address@hidden Commands and Events Index
address@hidden fn
address@hidden Data Types Index
address@hidden Data Types Index
address@hidden tp
address@hidden
diff --git a/docs/qmp-intro.txt b/docs/qmp-intro.txt
deleted file mode 100644
index f6a3a03..0000000
--- a/docs/qmp-intro.txt
+++ /dev/null
@@ -1,87 +0,0 @@
-                          QEMU Machine Protocol
-                          =====================
-
-Introduction
-------------
-
-The QEMU Machine Protocol (QMP) allows applications to operate a
-QEMU instance.
-
-QMP is JSON[1] based and features the following:
-
-- Lightweight, text-based, easy to parse data format
-- Asynchronous messages support (ie. events)
-- Capabilities Negotiation
-
-For detailed information on QMP's usage, please, refer to the following files:
-
-o qmp-spec.txt      QEMU Machine Protocol current specification
-o qmp-commands.txt  QMP supported commands (auto-generated at build-time)
-o qmp-events.txt    List of available asynchronous events
-
-[1] http://www.json.org
-
-Usage
------
-
-You can use the -qmp option to enable QMP. For example, the following
-makes QMP available on localhost port 4444:
-
-$ qemu [...] -qmp tcp:localhost:4444,server,nowait
-
-However, for more flexibility and to make use of more options, the -mon
-command-line option should be used. For instance, the following example
-creates one HMP instance (human monitor) on stdio and one QMP instance
-on localhost port 4444:
-
-$ qemu [...] -chardev stdio,id=mon0 -mon chardev=mon0,mode=readline \
-             -chardev socket,id=mon1,host=localhost,port=4444,server,nowait \
-             -mon chardev=mon1,mode=control,pretty=on
-
-Please, refer to QEMU's manpage for more information.
-
-Simple Testing
---------------
-
-To manually test QMP one can connect with telnet and issue commands by hand:
-
-$ telnet localhost 4444
-Trying 127.0.0.1...
-Connected to localhost.
-Escape character is '^]'.
-{
-    "QMP": {
-        "version": {
-            "qemu": {
-                "micro": 50, 
-                "minor": 6, 
-                "major": 1
-            }, 
-            "package": ""
-        }, 
-        "capabilities": [
-        ]
-    }
-}
-
-{ "execute": "qmp_capabilities" }
-{
-    "return": {
-    }
-}
-
-{ "execute": "query-status" }
-{
-    "return": {
-        "status": "prelaunch", 
-        "singlestep": false, 
-        "running": false
-    }
-}
-
-Please, refer to the qapi-schema.json file for a complete command reference.
-
-QMP wiki page
--------------
-
-http://wiki.qemu-project.org/QMP
-- 
2.10.0