summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Merge remote-tracking branch 'remotes/armbru/tags/pull-qapi-2017-01-16' into ↵Peter Maydell2017-01-177-4591/+304Star
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | staging QAPI patches for 2017-01-16 # gpg: Signature made Mon 16 Jan 2017 09:26:49 GMT # gpg: using RSA key 0x3870B400EB918653 # gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" # gpg: aka "Markus Armbruster <armbru@pond.sub.org>" # Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867 4E5F 3870 B400 EB91 8653 * remotes/armbru/tags/pull-qapi-2017-01-16: (180 commits) build-sys: add qapi doc generation targets build-sys: add txt documentation rules build-sys: use a generic TEXI2MAN rule build-sys: remove dvi doc generation build-sys: use --no-split for info docs: add qemu logo to pdf qapi: add qapi2texi script qmp-events: move 'MIGRATION_PASS' doc to schema qmp-events: move 'DUMP_COMPLETED' doc to schema qmp-events: move 'MEM_UNPLUG_ERROR' doc to schema qmp-events: move 'VSERPORT_CHANGE' doc to schema qmp-events: move 'QUORUM_REPORT_BAD' doc to schema qmp-events: move 'QUORUM_FAILURE' doc to schema qmp-events: move 'GUEST_PANICKED' doc to schema qmp-events: move 'BALLOON_CHANGE' doc to schema qmp-events: move 'ACPI_DEVICE_OST' doc to schema qmp-events: move 'MIGRATION' doc to schema qmp-events: move 'SPICE_MIGRATE_COMPLETED' doc to schema qmp-events: move 'SPICE_DISCONNECTED' doc to schema qmp-events: move 'SPICE_INITIALIZED' doc to schema ... Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
| * build-sys: add qapi doc generation targetsMarc-André Lureau2017-01-161-2/+1Star
| | | | | | | | | | | | | | | | | | | | | | | | Generate and install the man, txt and html versions of QAPI documentation (generate and install qemu-doc.txt too). Add it also to optional pdf/info targets. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20170113144135.5150-22-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * docs: add qemu logo to pdfMarc-André Lureau2017-01-163-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add a logo to texi2pdf output. Other formats (info/html) are left as future improvements. The PDF (needed by texi2pdf for vectorized images) was generated from pc-bios/qemu_logo.svg like this: inkscape --export-pdf=docs/qemu_logo.pdf pc-bios/qemu_logo.svg Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20170113144135.5150-17-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qapi: add qapi2texi scriptMarc-André Lureau2017-01-161-33/+147
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As the name suggests, the qapi2texi script converts JSON QAPI description into a texi file suitable for different target formats (info/man/txt/pdf/html...). It parses the following kind of blocks: Free-form: ## # = Section # == Subsection # # Some text foo with *emphasis* # 1. with a list # 2. like that # # And some code: # | $ echo foo # | -> do this # | <- get that # ## Symbol description: ## # @symbol: # # Symbol body ditto ergo sum. Foo bar # baz ding. # # @param1: the frob to frobnicate # @param2: #optional how hard to frobnicate # # Returns: the frobnicated frob. # If frob isn't frobnicatable, GenericError. # # Since: version # Notes: notes, comments can have # - itemized list # - like this # # Example: # # -> { "execute": "quit" } # <- { "return": {} } # ## That's roughly following the following EBNF grammar: api_comment = "##\n" comment "##\n" comment = freeform_comment | symbol_comment freeform_comment = { "# " text "\n" | "#\n" } symbol_comment = "# @" name ":\n" { member | tag_section | freeform_comment } member = "# @" name ':' [ text ] "\n" freeform_comment tag_section = "# " ( "Returns:", "Since:", "Note:", "Notes:", "Example:", "Examples:" ) [ text ] "\n" freeform_comment text = free text with markup Note that the grammar is ambiguous: a line "# @foo:\n" can be parsed both as freeform_comment and as symbol_comment. The actual parser recognizes symbol_comment. See docs/qapi-code-gen.txt for more details. Deficiencies and limitations: - the generated QMP documentation includes internal types - union type support is lacking - type information is lacking in generated documentation - doc comment error message positions are imprecise, they point to the beginning of the comment. - a few minor issues, all marked TODO/FIXME in the code Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20170113144135.5150-16-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [test-qapi.py tweaked to avoid trailing empty lines in .out] Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'MIGRATION_PASS' doc to schemaMarc-André Lureau2017-01-161-16/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'DUMP_COMPLETED' doc to schemaMarc-André Lureau2017-01-161-18/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'MEM_UNPLUG_ERROR' doc to schemaMarc-André Lureau2017-01-161-17/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'VSERPORT_CHANGE' doc to schemaMarc-André Lureau2017-01-161-18/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'QUORUM_REPORT_BAD' doc to schemaMarc-André Lureau2017-01-161-33/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'QUORUM_FAILURE' doc to schemaMarc-André Lureau2017-01-161-19/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'GUEST_PANICKED' doc to schemaMarc-André Lureau2017-01-161-14/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BALLOON_CHANGE' doc to schemaMarc-André Lureau2017-01-161-19/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'ACPI_DEVICE_OST' doc to schemaMarc-André Lureau2017-01-161-10/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'MIGRATION' doc to schemaMarc-André Lureau2017-01-161-15/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SPICE_MIGRATE_COMPLETED' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SPICE_DISCONNECTED' doc to schemaMarc-André Lureau2017-01-161-25/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SPICE_INITIALIZED' doc to schemaMarc-André Lureau2017-01-161-37/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SPICE_CONNECTED' doc to schemaMarc-André Lureau2017-01-161-25/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'VNC_DISCONNECTED' doc to schemaMarc-André Lureau2017-01-161-29/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'VNC_INITIALIZED' doc to schemaMarc-André Lureau2017-01-161-30/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'VNC_CONNECTED' doc to schemaMarc-André Lureau2017-01-161-31/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'NIC_RX_FILTER_CHANGED' doc to schemaMarc-André Lureau2017-01-161-17/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'DEVICE_DELETED' doc to schemaMarc-André Lureau2017-01-161-18/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'WATCHDOG' doc to schemaMarc-André Lureau2017-01-161-21/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'RTC_CHANGE' doc to schemaMarc-André Lureau2017-01-161-18/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'WAKEUP' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SUSPEND_DISK' doc to schemaMarc-André Lureau2017-01-161-14/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SUSPEND' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'RESUME' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'STOP' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'RESET' doc to schemaMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'POWERDOWN' doc to schemaMarc-André Lureau2017-01-161-13/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'SHUTDOWN' doc to schemaMarc-André Lureau2017-01-161-16/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'DEVICE_TRAY_MOVED' doc to schemaMarc-André Lureau2017-01-161-22/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_JOB_READY' doc to schemaMarc-André Lureau2017-01-161-27/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_JOB_ERROR' doc to schemaMarc-André Lureau2017-01-161-23/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_JOB_CANCELLED' doc to schemaMarc-André Lureau2017-01-161-25/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_JOB_COMPLETED' doc to schemaMarc-André Lureau2017-01-161-30/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_IO_ERROR' doc to schemaMarc-André Lureau2017-01-161-31/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-events: move 'BLOCK_IMAGE_CORRUPTED' doc to schemaMarc-André Lureau2017-01-161-28/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move documentation bits to schemaMarc-André Lureau2017-01-161-53/+0Star
| | | | | | | | | | | | | | | | Moving the remaining bits of documentation to the json file (text improvements is not the objective of this patch) Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: remove device_add from txtMarc-André Lureau2017-01-161-26/+0Star
| | | | | | | | | | | | | | | | It's already fully described in the schema. Fix the schema to document the command and not the argument (place doc before first arg). Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: remove cpu from txtMarc-André Lureau2017-01-161-16/+0Star
| | | | | | | | | | | | | | The cpu command is deprecated since commit 755f196898. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: remove qmp_capabilities from txtMarc-André Lureau2017-01-161-14/+0Star
| | | | | | | | | | | | | | It's better described in the schema already. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: remove query-qmp-schema from txtMarc-André Lureau2017-01-161-12/+0Star
| | | | | | | | | | | | | | It's better described in the schema already. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move 'x-colo-lost-heartbeat' doc to schemaMarc-André Lureau2017-01-161-10/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move 'xen-load-devices-state' doc to schemaMarc-André Lureau2017-01-161-18/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move 'migrate-set-cache-size' doc to schemaMarc-André Lureau2017-01-161-15/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move 'query-dump' doc to schemaMarc-André Lureau2017-01-161-13/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| * qmp-commands: move 'blockdev-mirror' doc to schemaMarc-André Lureau2017-01-161-41/+0Star
| | | | | | | | | | Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
generated by cgit v1.2.3-55-g7522 (git 2.39.0) at 2026-05-21 09:50:45 +0200