* [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
@ 2017-01-16 9:33 Markus Armbruster
2017-01-16 15:58 ` Peter Maydell
0 siblings, 1 reply; 25+ messages in thread
From: Markus Armbruster @ 2017-01-16 9:33 UTC (permalink / raw)
To: qemu-devel
This is Marc-André's "[PATCH v8 00/21] qapi doc generation (whole
version, squashed)" with a few commit messages tweaked, and "[PATCH v8
14/21] (SQUASHED) move doc to schema" unsquashed into 161 patches.
We did all the respins with in this squashed form to reduce noise.
However, since the unsquashed form is better suited for review, and
probably nicer if we have to revisit this part of the work down the
road, I'm proposing to merge this unsquashed.
If you want me to post the unsquashed patches, I'm happy to redo this
pull request.
If you'd rather pull the squashed version, likewise.
I'm afraid this is a bit of a doc conflict magnet. The sooner we can
get it in, the easier for Marc-André and me.
v2:
* Rebased (v1 conflicts with commit e1ff3c6)
* test-qapi.py tweaked to avoid trailing empty lines in .out
The following changes since commit b6af8ea60282df514f87d32e36afd1c9aeee28c8:
Merge remote-tracking branch 'remotes/ehabkost/tags/x86-and-machine-pull-request' into staging (2017-01-13 14:38:21 +0000)
are available in the git repository at:
git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2017-01-16
for you to fetch changes up to 56e8bdd46a8a42d89b0afea9da83ae7679cc0439:
build-sys: add qapi doc generation targets (2017-01-16 10:11:43 +0100)
----------------------------------------------------------------
QAPI patches for 2017-01-16
----------------------------------------------------------------
Marc-André Lureau (180):
qapi: replace 'o' for list items
qapi: move QKeyCode doc body at the top
qapi: Format TODO comments more consistently
qapi: improve device_add schema
qapi: improve TransactionAction doc
qga/schema: improve guest-set-vcpus Returns: section
qapi: Reorder doc comments for future doc generator
qapi: Move "command is experimental" notes down
qapi: add some sections in docs
docs: add master qapi texi files
qapi: rework qapi Exception
texi2pod: learn quotation, deftp and deftypefn
qmp-commands: move 'add_client' doc to schema
qmp-commands: move 'query-name' doc to schema
qmp-commands: move 'query-kvm' doc to schema
qmp-commands: move 'query-status' doc to schema
qmp-commands: move 'query-uuid' doc to schema
qmp-commands: move 'query-chardev' doc to schema
qmp-commands: move 'query-chardev-backends' doc to schema
qmp-commands: move 'ringbuf-write' doc to schema
qmp-commands: move 'ringbuf-read' doc to schema
qmp-commands: move 'query-events' doc to schema
qmp-commands: move 'query-migrate' doc to schema
qmp-commands: move 'migrate-set-capabilities' doc to schema
qmp-commands: move 'query-migrate-capabilities' doc to schema
qmp-commands: move 'migrate-set-parameters' doc to schema
qmp-commands: move 'query-migrate-parameters' doc to schema
qmp-commands: move 'client_migrate_info' doc to schema
qmp-commands: move 'migrate-start-postcopy' doc to schema
qmp-commands: move 'query-mice' doc to schema
qmp-commands: move 'query-cpus' doc to schema
qmp-commands: move 'query-iothreads' doc to schema
qmp-commands: move 'query-vnc' doc to schema
qmp-commands: move 'query-spice' doc to schema
qmp-commands: move 'query-balloon' doc to schema
qmp-commands: move 'query-pci' doc to schema
qmp-commands: move 'quit' doc to schema
qmp-commands: move 'stop' doc to schema
qmp-commands: move 'system_reset' doc to schema
qmp-commands: move 'system_powerdown' doc to schema
qmp-commands: move 'cpu-add' doc to schema
qmp-commands: move 'memsave' doc to schema
qmp-commands: move 'pmemsave' doc to schema
qmp-commands: move 'cont' doc to schema
qmp-commands: move 'system_wakeup' doc to schema
qmp-commands: move 'inject-nmi' doc to schema
qmp-commands: move 'set_link' doc to schema
qmp-commands: move 'balloon' doc to schema
qmp-commands: move 'transaction' doc to schema
qmp-commands: move 'human-monitor-command' doc to schema
qmp-commands: move 'migrate_cancel' doc to schema
qmp-commands: move 'migrate_set_downtime' doc to schema
qmp-commands: move 'migrate_set_speed' doc to schema
qmp-commands: move 'query-migrate-cache-size' doc to schema
qmp-commands: move 'set_password' doc to schema
qmp-commands: move 'expire_password' doc to schema
qmp-commands: move 'change' doc to schema
qmp-commands: move 'migrate' doc to schema
qmp-commands: move 'migrate-incoming' doc to schema
qmp-commands: move 'xen-save-devices-state' doc to schema
qmp-commands: move 'xen-set-global-dirty-log' doc to schema
qmp-commands: move 'device_del' doc to schema
qmp-commands: move 'dump-guest-memory' doc to schema
qmp-commands: move 'query-dump-guest-memory-capability' doc to schema
qmp-commands: move 'dump-skeys' doc to schema
qmp-commands: move 'netdev_add' doc to schema
qmp-commands: move 'netdev_del' doc to schema
qmp-commands: move 'object-add' doc to schema
qmp-commands: move 'object-del' doc to schema
qmp-commands: move 'getfd' doc to schema
qmp-commands: move 'closefd' doc to schema
qmp-commands: move 'add-fd' doc to schema
qmp-commands: move 'remove-fd' doc to schema
qmp-commands: move 'query-fdsets' doc to schema
qmp-commands: move 'send-key' doc to schema
qmp-commands: move 'screendump' doc to schema
qmp-commands: move 'chardev-add' doc to schema
qmp-commands: move 'chardev-remove' doc to schema
qmp-commands: move 'query-tpm-models' doc to schema
qmp-commands: move 'query-tpm-types' doc to schema
qmp-commands: move 'query-tpm' doc to schema
qmp-commands: move 'query-command-line-options' doc to schema
qmp-commands: move 'query-rx-filter' doc to schema
qmp-commands: move 'input-send-event' doc to schema
qmp-commands: move 'query-memdev' doc to schema
qmp-commands: move 'query-memory-devices' doc to schema
qmp-commands: move 'query-acpi-ospm-status' doc to schema
qmp-commands: move 'rtc-reset-reinjection' doc to schema
qmp-commands: move 'query-block' doc to schema
qmp-commands: move 'query-blockstats' doc to schema
qmp-commands: move 'block_passwd' doc to schema
qmp-commands: move 'block_resize' doc to schema
qmp-commands: move 'blockdev-snapshot-sync' doc to schema
qmp-commands: move 'blockdev-snapshot' doc to schema
qmp-commands: move 'change-backing-file' doc to schema
qmp-commands: move 'block-commit' doc to schema
qmp-commands: move 'drive-backup' doc to schema
qmp-commands: move 'blockdev-backup' doc to schema
qmp-commands: move 'query-named-block-nodes' doc to schema
qmp-commands: move 'drive-mirror' doc to schema
qmp-commands: move 'block-dirty-bitmap-add' doc to schema
qmp-commands: move 'block-dirty-bitmap-remove' doc to schema
qmp-commands: move 'block-dirty-bitmap-clear' doc to schema
qmp-commands: move 'block_set_io_throttle' doc to schema
qmp-commands: move 'block-stream' doc to schema
qmp-commands: move 'blockdev-add' doc to schema
qmp-commands: move 'x-blockdev-del' doc to schema
qmp-commands: move 'blockdev-open-tray' doc to schema
qmp-commands: move 'blockdev-close-tray' doc to schema
qmp-commands: move 'x-blockdev-remove-medium' doc to schema
qmp-commands: move 'x-blockdev-insert-medium' doc to schema
qmp-commands: move 'blockdev-change-medium' doc to schema
qmp-commands: move 'block-set-write-threshold' doc to schema
qmp-commands: move 'blockdev-snapshot-internal-sync' doc to schema
qmp-commands: move 'blockdev-snapshot-delete-internal-sync' doc to schema
qmp-commands: move 'eject' doc to schema
qmp-commands: move 'query-version' doc to schema
qmp-commands: move 'query-commands' doc to schema
qmp-commands: move 'query-rocker' doc to schema
qmp-commands: move 'query-rocker-ports' doc to schema
qmp-commands: move 'query-rocker-of-dpa-flows' doc to schema
qmp-commands: move 'query-rocker-of-dpa-groups' doc to schema
qmp-commands: move 'trace-event-get-state' doc to schema
qmp-commands: move 'trace-event-set-state' doc to schema
qmp-commands: move 'query-hotpluggable-cpus' doc to schema
qmp-commands: move 'query-gic-capabilities' doc to schema
qmp-commands: move 'x-blockdev-change' doc to schema
qmp-commands: move 'blockdev-mirror' doc to schema
qmp-commands: move 'query-dump' doc to schema
qmp-commands: move 'migrate-set-cache-size' doc to schema
qmp-commands: move 'xen-load-devices-state' doc to schema
qmp-commands: move 'x-colo-lost-heartbeat' doc to schema
qmp-commands: remove query-qmp-schema from txt
qmp-commands: remove qmp_capabilities from txt
qmp-commands: remove cpu from txt
qmp-commands: remove device_add from txt
qmp-commands: move documentation bits to schema
qmp-events: move 'BLOCK_IMAGE_CORRUPTED' doc to schema
qmp-events: move 'BLOCK_IO_ERROR' doc to schema
qmp-events: move 'BLOCK_JOB_COMPLETED' doc to schema
qmp-events: move 'BLOCK_JOB_CANCELLED' doc to schema
qmp-events: move 'BLOCK_JOB_ERROR' doc to schema
qmp-events: move 'BLOCK_JOB_READY' doc to schema
qmp-events: move 'DEVICE_TRAY_MOVED' doc to schema
qmp-events: move 'SHUTDOWN' doc to schema
qmp-events: move 'POWERDOWN' doc to schema
qmp-events: move 'RESET' doc to schema
qmp-events: move 'STOP' doc to schema
qmp-events: move 'RESUME' doc to schema
qmp-events: move 'SUSPEND' doc to schema
qmp-events: move 'SUSPEND_DISK' doc to schema
qmp-events: move 'WAKEUP' doc to schema
qmp-events: move 'RTC_CHANGE' doc to schema
qmp-events: move 'WATCHDOG' doc to schema
qmp-events: move 'DEVICE_DELETED' doc to schema
qmp-events: move 'NIC_RX_FILTER_CHANGED' doc to schema
qmp-events: move 'VNC_CONNECTED' doc to schema
qmp-events: move 'VNC_INITIALIZED' doc to schema
qmp-events: move 'VNC_DISCONNECTED' doc to schema
qmp-events: move 'SPICE_CONNECTED' doc to schema
qmp-events: move 'SPICE_INITIALIZED' doc to schema
qmp-events: move 'SPICE_DISCONNECTED' doc to schema
qmp-events: move 'SPICE_MIGRATE_COMPLETED' doc to schema
qmp-events: move 'MIGRATION' doc to schema
qmp-events: move 'ACPI_DEVICE_OST' doc to schema
qmp-events: move 'BALLOON_CHANGE' doc to schema
qmp-events: move 'GUEST_PANICKED' doc to schema
qmp-events: move 'QUORUM_FAILURE' doc to schema
qmp-events: move 'QUORUM_REPORT_BAD' doc to schema
qmp-events: move 'VSERPORT_CHANGE' doc to schema
qmp-events: move 'MEM_UNPLUG_ERROR' doc to schema
qmp-events: move 'DUMP_COMPLETED' doc to schema
qmp-events: move 'MIGRATION_PASS' doc to schema
qapi: add qapi2texi script
docs: add qemu logo to pdf
build-sys: use --no-split for info
build-sys: remove dvi doc generation
build-sys: use a generic TEXI2MAN rule
build-sys: add txt documentation rules
build-sys: add qapi doc generation targets
.gitignore | 11 +-
Makefile | 94 +-
configure | 2 +-
docs/qapi-code-gen.txt | 180 +-
docs/qemu-ga-ref.texi | 78 +
docs/qemu-qmp-ref.texi | 78 +
docs/qemu_logo.pdf | Bin 0 -> 9117 bytes
docs/qmp-commands.txt | 3825 --------------------
docs/qmp-events.txt | 731 ----
docs/qmp-intro.txt | 3 +-
qapi-schema.json | 1339 ++++++-
qapi/block-core.json | 700 +++-
qapi/block.json | 66 +-
qapi/common.json | 38 +-
qapi/crypto.json | 5 +-
qapi/event.json | 250 +-
qapi/introspect.json | 5 +-
qapi/rocker.json | 61 +-
qapi/trace.json | 17 +
qga/qapi-schema.json | 11 +-
rules.mak | 12 +
scripts/qapi.py | 583 ++-
scripts/qapi2texi.py | 271 ++
scripts/texi2pod.pl | 54 +-
tests/Makefile.include | 20 +
tests/qapi-schema/alternate-any.err | 2 +-
tests/qapi-schema/alternate-any.json | 4 +
tests/qapi-schema/alternate-array.err | 2 +-
tests/qapi-schema/alternate-array.json | 7 +
tests/qapi-schema/alternate-base.err | 2 +-
tests/qapi-schema/alternate-base.json | 7 +
tests/qapi-schema/alternate-clash.err | 2 +-
tests/qapi-schema/alternate-clash.json | 4 +
tests/qapi-schema/alternate-conflict-dict.err | 2 +-
tests/qapi-schema/alternate-conflict-dict.json | 10 +
tests/qapi-schema/alternate-conflict-string.err | 2 +-
tests/qapi-schema/alternate-conflict-string.json | 7 +
tests/qapi-schema/alternate-empty.err | 2 +-
tests/qapi-schema/alternate-empty.json | 4 +
tests/qapi-schema/alternate-nested.err | 2 +-
tests/qapi-schema/alternate-nested.json | 7 +
tests/qapi-schema/alternate-unknown.err | 2 +-
tests/qapi-schema/alternate-unknown.json | 4 +
tests/qapi-schema/args-alternate.err | 2 +-
tests/qapi-schema/args-alternate.json | 8 +
tests/qapi-schema/args-any.err | 2 +-
tests/qapi-schema/args-any.json | 4 +
tests/qapi-schema/args-array-empty.err | 2 +-
tests/qapi-schema/args-array-empty.json | 4 +
tests/qapi-schema/args-array-unknown.err | 2 +-
tests/qapi-schema/args-array-unknown.json | 4 +
tests/qapi-schema/args-bad-boxed.err | 2 +-
tests/qapi-schema/args-bad-boxed.json | 4 +
tests/qapi-schema/args-boxed-anon.err | 2 +-
tests/qapi-schema/args-boxed-anon.json | 4 +
tests/qapi-schema/args-boxed-empty.err | 2 +-
tests/qapi-schema/args-boxed-empty.json | 8 +
tests/qapi-schema/args-boxed-string.err | 2 +-
tests/qapi-schema/args-boxed-string.json | 4 +
tests/qapi-schema/args-int.err | 2 +-
tests/qapi-schema/args-int.json | 4 +
tests/qapi-schema/args-invalid.err | 2 +-
tests/qapi-schema/args-invalid.json | 3 +
tests/qapi-schema/args-member-array-bad.err | 2 +-
tests/qapi-schema/args-member-array-bad.json | 4 +
tests/qapi-schema/args-member-case.err | 2 +-
tests/qapi-schema/args-member-case.json | 4 +
tests/qapi-schema/args-member-unknown.err | 2 +-
tests/qapi-schema/args-member-unknown.json | 4 +
tests/qapi-schema/args-name-clash.err | 2 +-
tests/qapi-schema/args-name-clash.json | 4 +
tests/qapi-schema/args-union.err | 2 +-
tests/qapi-schema/args-union.json | 7 +
tests/qapi-schema/args-unknown.err | 2 +-
tests/qapi-schema/args-unknown.json | 4 +
tests/qapi-schema/bad-base.err | 2 +-
tests/qapi-schema/bad-base.json | 7 +
tests/qapi-schema/bad-data.err | 2 +-
tests/qapi-schema/bad-data.json | 4 +
tests/qapi-schema/bad-ident.err | 2 +-
tests/qapi-schema/bad-ident.json | 4 +
tests/qapi-schema/bad-type-bool.err | 2 +-
tests/qapi-schema/bad-type-bool.json | 4 +
tests/qapi-schema/bad-type-dict.err | 2 +-
tests/qapi-schema/bad-type-dict.json | 4 +
tests/qapi-schema/base-cycle-direct.err | 2 +-
tests/qapi-schema/base-cycle-direct.json | 4 +
tests/qapi-schema/base-cycle-indirect.err | 2 +-
tests/qapi-schema/base-cycle-indirect.json | 7 +
tests/qapi-schema/command-int.err | 2 +-
tests/qapi-schema/command-int.json | 4 +
tests/qapi-schema/comments.json | 4 +
tests/qapi-schema/comments.out | 1 +
tests/qapi-schema/doc-bad-args.err | 1 +
tests/qapi-schema/doc-bad-args.exit | 1 +
tests/qapi-schema/doc-bad-args.json | 8 +
tests/qapi-schema/doc-bad-args.out | 0
tests/qapi-schema/doc-bad-symbol.err | 1 +
tests/qapi-schema/doc-bad-symbol.exit | 1 +
tests/qapi-schema/doc-bad-symbol.json | 6 +
tests/qapi-schema/doc-bad-symbol.out | 0
tests/qapi-schema/doc-duplicated-arg.err | 1 +
tests/qapi-schema/doc-duplicated-arg.exit | 1 +
tests/qapi-schema/doc-duplicated-arg.json | 7 +
tests/qapi-schema/doc-duplicated-arg.out | 0
tests/qapi-schema/doc-duplicated-return.err | 1 +
tests/qapi-schema/doc-duplicated-return.exit | 1 +
tests/qapi-schema/doc-duplicated-return.json | 8 +
tests/qapi-schema/doc-duplicated-return.out | 0
tests/qapi-schema/doc-duplicated-since.err | 1 +
tests/qapi-schema/doc-duplicated-since.exit | 1 +
tests/qapi-schema/doc-duplicated-since.json | 8 +
tests/qapi-schema/doc-duplicated-since.out | 0
tests/qapi-schema/doc-empty-arg.err | 1 +
tests/qapi-schema/doc-empty-arg.exit | 1 +
tests/qapi-schema/doc-empty-arg.json | 6 +
tests/qapi-schema/doc-empty-arg.out | 0
tests/qapi-schema/doc-empty-section.err | 1 +
tests/qapi-schema/doc-empty-section.exit | 1 +
tests/qapi-schema/doc-empty-section.json | 8 +
tests/qapi-schema/doc-empty-section.out | 0
tests/qapi-schema/doc-empty-symbol.err | 1 +
tests/qapi-schema/doc-empty-symbol.exit | 1 +
tests/qapi-schema/doc-empty-symbol.json | 5 +
tests/qapi-schema/doc-empty-symbol.out | 0
tests/qapi-schema/doc-interleaved-section.err | 1 +
tests/qapi-schema/doc-interleaved-section.exit | 1 +
tests/qapi-schema/doc-interleaved-section.json | 21 +
tests/qapi-schema/doc-interleaved-section.out | 0
tests/qapi-schema/doc-invalid-end.err | 1 +
tests/qapi-schema/doc-invalid-end.exit | 1 +
tests/qapi-schema/doc-invalid-end.json | 5 +
tests/qapi-schema/doc-invalid-end.out | 0
tests/qapi-schema/doc-invalid-end2.err | 1 +
tests/qapi-schema/doc-invalid-end2.exit | 1 +
tests/qapi-schema/doc-invalid-end2.json | 5 +
tests/qapi-schema/doc-invalid-end2.out | 0
tests/qapi-schema/doc-invalid-return.err | 1 +
tests/qapi-schema/doc-invalid-return.exit | 1 +
tests/qapi-schema/doc-invalid-return.json | 7 +
tests/qapi-schema/doc-invalid-return.out | 0
tests/qapi-schema/doc-invalid-section.err | 1 +
tests/qapi-schema/doc-invalid-section.exit | 1 +
tests/qapi-schema/doc-invalid-section.json | 6 +
tests/qapi-schema/doc-invalid-section.out | 0
tests/qapi-schema/doc-invalid-start.err | 1 +
tests/qapi-schema/doc-invalid-start.exit | 1 +
tests/qapi-schema/doc-invalid-start.json | 5 +
tests/qapi-schema/doc-invalid-start.out | 0
tests/qapi-schema/doc-missing-colon.err | 1 +
tests/qapi-schema/doc-missing-colon.exit | 1 +
tests/qapi-schema/doc-missing-colon.json | 5 +
tests/qapi-schema/doc-missing-colon.out | 0
tests/qapi-schema/doc-missing-expr.err | 1 +
tests/qapi-schema/doc-missing-expr.exit | 1 +
tests/qapi-schema/doc-missing-expr.json | 5 +
tests/qapi-schema/doc-missing-expr.out | 0
tests/qapi-schema/doc-missing-space.err | 1 +
tests/qapi-schema/doc-missing-space.exit | 1 +
tests/qapi-schema/doc-missing-space.json | 6 +
tests/qapi-schema/doc-missing-space.out | 0
tests/qapi-schema/doc-optional.err | 1 +
tests/qapi-schema/doc-optional.exit | 1 +
tests/qapi-schema/doc-optional.json | 7 +
tests/qapi-schema/doc-optional.out | 0
tests/qapi-schema/double-type.err | 2 +-
tests/qapi-schema/double-type.json | 4 +
tests/qapi-schema/enum-bad-name.err | 2 +-
tests/qapi-schema/enum-bad-name.json | 4 +
tests/qapi-schema/enum-bad-prefix.err | 2 +-
tests/qapi-schema/enum-bad-prefix.json | 4 +
tests/qapi-schema/enum-clash-member.err | 2 +-
tests/qapi-schema/enum-clash-member.json | 4 +
tests/qapi-schema/enum-dict-member.err | 2 +-
tests/qapi-schema/enum-dict-member.json | 4 +
tests/qapi-schema/enum-member-case.err | 2 +-
tests/qapi-schema/enum-member-case.json | 7 +
tests/qapi-schema/enum-missing-data.err | 2 +-
tests/qapi-schema/enum-missing-data.json | 4 +
tests/qapi-schema/enum-wrong-data.err | 2 +-
tests/qapi-schema/enum-wrong-data.json | 4 +
tests/qapi-schema/event-boxed-empty.err | 2 +-
tests/qapi-schema/event-boxed-empty.json | 4 +
tests/qapi-schema/event-case.json | 4 +
tests/qapi-schema/event-case.out | 1 +
tests/qapi-schema/event-nest-struct.err | 2 +-
tests/qapi-schema/event-nest-struct.json | 4 +
tests/qapi-schema/flat-union-array-branch.err | 2 +-
tests/qapi-schema/flat-union-array-branch.json | 12 +
tests/qapi-schema/flat-union-bad-base.err | 2 +-
tests/qapi-schema/flat-union-bad-base.json | 13 +
tests/qapi-schema/flat-union-bad-discriminator.err | 2 +-
.../qapi-schema/flat-union-bad-discriminator.json | 16 +
tests/qapi-schema/flat-union-base-any.err | 2 +-
tests/qapi-schema/flat-union-base-any.json | 13 +
tests/qapi-schema/flat-union-base-union.err | 2 +-
tests/qapi-schema/flat-union-base-union.json | 16 +
tests/qapi-schema/flat-union-clash-member.err | 2 +-
tests/qapi-schema/flat-union-clash-member.json | 16 +
tests/qapi-schema/flat-union-empty.err | 2 +-
tests/qapi-schema/flat-union-empty.json | 10 +
tests/qapi-schema/flat-union-incomplete-branch.err | 2 +-
.../qapi-schema/flat-union-incomplete-branch.json | 10 +
tests/qapi-schema/flat-union-inline.err | 2 +-
tests/qapi-schema/flat-union-inline.json | 10 +
tests/qapi-schema/flat-union-int-branch.err | 2 +-
tests/qapi-schema/flat-union-int-branch.json | 13 +
.../qapi-schema/flat-union-invalid-branch-key.err | 2 +-
.../qapi-schema/flat-union-invalid-branch-key.json | 15 +
.../flat-union-invalid-discriminator.err | 2 +-
.../flat-union-invalid-discriminator.json | 15 +
tests/qapi-schema/flat-union-no-base.err | 2 +-
tests/qapi-schema/flat-union-no-base.json | 13 +
.../flat-union-optional-discriminator.err | 2 +-
.../flat-union-optional-discriminator.json | 13 +
.../flat-union-string-discriminator.err | 2 +-
.../flat-union-string-discriminator.json | 15 +
tests/qapi-schema/ident-with-escape.json | 4 +
tests/qapi-schema/ident-with-escape.out | 1 +
tests/qapi-schema/include-relpath-sub.json | 3 +
tests/qapi-schema/include-relpath.out | 1 +
tests/qapi-schema/include-repetition.out | 1 +
tests/qapi-schema/include-simple-sub.json | 3 +
tests/qapi-schema/include-simple.out | 1 +
tests/qapi-schema/indented-expr.json | 6 +
tests/qapi-schema/indented-expr.out | 2 +
tests/qapi-schema/missing-type.err | 2 +-
tests/qapi-schema/missing-type.json | 4 +
tests/qapi-schema/nested-struct-data.err | 2 +-
tests/qapi-schema/nested-struct-data.json | 4 +
tests/qapi-schema/qapi-schema-test.json | 213 ++
tests/qapi-schema/qapi-schema-test.out | 130 +
tests/qapi-schema/redefined-builtin.err | 2 +-
tests/qapi-schema/redefined-builtin.json | 4 +
tests/qapi-schema/redefined-command.err | 2 +-
tests/qapi-schema/redefined-command.json | 7 +
tests/qapi-schema/redefined-event.err | 2 +-
tests/qapi-schema/redefined-event.json | 7 +
tests/qapi-schema/redefined-type.err | 2 +-
tests/qapi-schema/redefined-type.json | 7 +
tests/qapi-schema/reserved-command-q.err | 2 +-
tests/qapi-schema/reserved-command-q.json | 7 +
tests/qapi-schema/reserved-enum-q.err | 2 +-
tests/qapi-schema/reserved-enum-q.json | 4 +
tests/qapi-schema/reserved-member-has.err | 2 +-
tests/qapi-schema/reserved-member-has.json | 4 +
tests/qapi-schema/reserved-member-q.err | 2 +-
tests/qapi-schema/reserved-member-q.json | 4 +
tests/qapi-schema/reserved-member-u.err | 2 +-
tests/qapi-schema/reserved-member-u.json | 4 +
tests/qapi-schema/reserved-member-underscore.err | 2 +-
tests/qapi-schema/reserved-member-underscore.json | 4 +
tests/qapi-schema/reserved-type-kind.err | 2 +-
tests/qapi-schema/reserved-type-kind.json | 4 +
tests/qapi-schema/reserved-type-list.err | 2 +-
tests/qapi-schema/reserved-type-list.json | 4 +
tests/qapi-schema/returns-alternate.err | 2 +-
tests/qapi-schema/returns-alternate.json | 7 +
tests/qapi-schema/returns-array-bad.err | 2 +-
tests/qapi-schema/returns-array-bad.json | 4 +
tests/qapi-schema/returns-dict.err | 2 +-
tests/qapi-schema/returns-dict.json | 4 +
tests/qapi-schema/returns-unknown.err | 2 +-
tests/qapi-schema/returns-unknown.json | 4 +
tests/qapi-schema/returns-whitelist.err | 2 +-
tests/qapi-schema/returns-whitelist.json | 16 +
tests/qapi-schema/struct-base-clash-deep.err | 2 +-
tests/qapi-schema/struct-base-clash-deep.json | 10 +
tests/qapi-schema/struct-base-clash.err | 2 +-
tests/qapi-schema/struct-base-clash.json | 7 +
tests/qapi-schema/struct-data-invalid.err | 2 +-
tests/qapi-schema/struct-data-invalid.json | 3 +
tests/qapi-schema/struct-member-invalid.err | 2 +-
tests/qapi-schema/struct-member-invalid.json | 3 +
tests/qapi-schema/test-qapi.py | 14 +
tests/qapi-schema/type-bypass-bad-gen.err | 2 +-
tests/qapi-schema/type-bypass-bad-gen.json | 4 +
tests/qapi-schema/unicode-str.err | 2 +-
tests/qapi-schema/unicode-str.json | 4 +
tests/qapi-schema/union-base-no-discriminator.err | 2 +-
tests/qapi-schema/union-base-no-discriminator.json | 12 +
tests/qapi-schema/union-branch-case.err | 2 +-
tests/qapi-schema/union-branch-case.json | 4 +
tests/qapi-schema/union-clash-branches.err | 2 +-
tests/qapi-schema/union-clash-branches.json | 4 +
tests/qapi-schema/union-empty.err | 2 +-
tests/qapi-schema/union-empty.json | 4 +
tests/qapi-schema/union-invalid-base.err | 2 +-
tests/qapi-schema/union-invalid-base.json | 10 +
tests/qapi-schema/union-optional-branch.err | 2 +-
tests/qapi-schema/union-optional-branch.json | 4 +
tests/qapi-schema/union-unknown.err | 2 +-
tests/qapi-schema/union-unknown.json | 4 +
tests/qapi-schema/unknown-escape.err | 2 +-
tests/qapi-schema/unknown-escape.json | 4 +
tests/qapi-schema/unknown-expr-key.err | 2 +-
tests/qapi-schema/unknown-expr-key.json | 4 +
297 files changed, 4751 insertions(+), 5013 deletions(-)
create mode 100644 docs/qemu-ga-ref.texi
create mode 100644 docs/qemu-qmp-ref.texi
create mode 100644 docs/qemu_logo.pdf
delete mode 100644 docs/qmp-commands.txt
delete mode 100644 docs/qmp-events.txt
create mode 100755 scripts/qapi2texi.py
create mode 100644 tests/qapi-schema/doc-bad-args.err
create mode 100644 tests/qapi-schema/doc-bad-args.exit
create mode 100644 tests/qapi-schema/doc-bad-args.json
create mode 100644 tests/qapi-schema/doc-bad-args.out
create mode 100644 tests/qapi-schema/doc-bad-symbol.err
create mode 100644 tests/qapi-schema/doc-bad-symbol.exit
create mode 100644 tests/qapi-schema/doc-bad-symbol.json
create mode 100644 tests/qapi-schema/doc-bad-symbol.out
create mode 100644 tests/qapi-schema/doc-duplicated-arg.err
create mode 100644 tests/qapi-schema/doc-duplicated-arg.exit
create mode 100644 tests/qapi-schema/doc-duplicated-arg.json
create mode 100644 tests/qapi-schema/doc-duplicated-arg.out
create mode 100644 tests/qapi-schema/doc-duplicated-return.err
create mode 100644 tests/qapi-schema/doc-duplicated-return.exit
create mode 100644 tests/qapi-schema/doc-duplicated-return.json
create mode 100644 tests/qapi-schema/doc-duplicated-return.out
create mode 100644 tests/qapi-schema/doc-duplicated-since.err
create mode 100644 tests/qapi-schema/doc-duplicated-since.exit
create mode 100644 tests/qapi-schema/doc-duplicated-since.json
create mode 100644 tests/qapi-schema/doc-duplicated-since.out
create mode 100644 tests/qapi-schema/doc-empty-arg.err
create mode 100644 tests/qapi-schema/doc-empty-arg.exit
create mode 100644 tests/qapi-schema/doc-empty-arg.json
create mode 100644 tests/qapi-schema/doc-empty-arg.out
create mode 100644 tests/qapi-schema/doc-empty-section.err
create mode 100644 tests/qapi-schema/doc-empty-section.exit
create mode 100644 tests/qapi-schema/doc-empty-section.json
create mode 100644 tests/qapi-schema/doc-empty-section.out
create mode 100644 tests/qapi-schema/doc-empty-symbol.err
create mode 100644 tests/qapi-schema/doc-empty-symbol.exit
create mode 100644 tests/qapi-schema/doc-empty-symbol.json
create mode 100644 tests/qapi-schema/doc-empty-symbol.out
create mode 100644 tests/qapi-schema/doc-interleaved-section.err
create mode 100644 tests/qapi-schema/doc-interleaved-section.exit
create mode 100644 tests/qapi-schema/doc-interleaved-section.json
create mode 100644 tests/qapi-schema/doc-interleaved-section.out
create mode 100644 tests/qapi-schema/doc-invalid-end.err
create mode 100644 tests/qapi-schema/doc-invalid-end.exit
create mode 100644 tests/qapi-schema/doc-invalid-end.json
create mode 100644 tests/qapi-schema/doc-invalid-end.out
create mode 100644 tests/qapi-schema/doc-invalid-end2.err
create mode 100644 tests/qapi-schema/doc-invalid-end2.exit
create mode 100644 tests/qapi-schema/doc-invalid-end2.json
create mode 100644 tests/qapi-schema/doc-invalid-end2.out
create mode 100644 tests/qapi-schema/doc-invalid-return.err
create mode 100644 tests/qapi-schema/doc-invalid-return.exit
create mode 100644 tests/qapi-schema/doc-invalid-return.json
create mode 100644 tests/qapi-schema/doc-invalid-return.out
create mode 100644 tests/qapi-schema/doc-invalid-section.err
create mode 100644 tests/qapi-schema/doc-invalid-section.exit
create mode 100644 tests/qapi-schema/doc-invalid-section.json
create mode 100644 tests/qapi-schema/doc-invalid-section.out
create mode 100644 tests/qapi-schema/doc-invalid-start.err
create mode 100644 tests/qapi-schema/doc-invalid-start.exit
create mode 100644 tests/qapi-schema/doc-invalid-start.json
create mode 100644 tests/qapi-schema/doc-invalid-start.out
create mode 100644 tests/qapi-schema/doc-missing-colon.err
create mode 100644 tests/qapi-schema/doc-missing-colon.exit
create mode 100644 tests/qapi-schema/doc-missing-colon.json
create mode 100644 tests/qapi-schema/doc-missing-colon.out
create mode 100644 tests/qapi-schema/doc-missing-expr.err
create mode 100644 tests/qapi-schema/doc-missing-expr.exit
create mode 100644 tests/qapi-schema/doc-missing-expr.json
create mode 100644 tests/qapi-schema/doc-missing-expr.out
create mode 100644 tests/qapi-schema/doc-missing-space.err
create mode 100644 tests/qapi-schema/doc-missing-space.exit
create mode 100644 tests/qapi-schema/doc-missing-space.json
create mode 100644 tests/qapi-schema/doc-missing-space.out
create mode 100644 tests/qapi-schema/doc-optional.err
create mode 100644 tests/qapi-schema/doc-optional.exit
create mode 100644 tests/qapi-schema/doc-optional.json
create mode 100644 tests/qapi-schema/doc-optional.out
--
2.7.4
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-16 9:33 [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16 Markus Armbruster
@ 2017-01-16 15:58 ` Peter Maydell
2017-01-17 8:31 ` Markus Armbruster
0 siblings, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-16 15:58 UTC (permalink / raw)
To: Markus Armbruster; +Cc: QEMU Developers
On 16 January 2017 at 09:33, Markus Armbruster <armbru@redhat.com> wrote:
> This is Marc-André's "[PATCH v8 00/21] qapi doc generation (whole
> version, squashed)" with a few commit messages tweaked, and "[PATCH v8
> 14/21] (SQUASHED) move doc to schema" unsquashed into 161 patches.
>
> We did all the respins with in this squashed form to reduce noise.
> However, since the unsquashed form is better suited for review, and
> probably nicer if we have to revisit this part of the work down the
> road, I'm proposing to merge this unsquashed.
>
> If you want me to post the unsquashed patches, I'm happy to redo this
> pull request.
>
> If you'd rather pull the squashed version, likewise.
>
> I'm afraid this is a bit of a doc conflict magnet. The sooner we can
> get it in, the easier for Marc-André and me.
>
> v2:
> * Rebased (v1 conflicts with commit e1ff3c6)
> * test-qapi.py tweaked to avoid trailing empty lines in .out
>
> The following changes since commit b6af8ea60282df514f87d32e36afd1c9aeee28c8:
>
> Merge remote-tracking branch 'remotes/ehabkost/tags/x86-and-machine-pull-request' into staging (2017-01-13 14:38:21 +0000)
>
> are available in the git repository at:
>
> git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2017-01-16
>
> for you to fetch changes up to 56e8bdd46a8a42d89b0afea9da83ae7679cc0439:
>
> build-sys: add qapi doc generation targets (2017-01-16 10:11:43 +0100)
>
> ----------------------------------------------------------------
> QAPI patches for 2017-01-16
This seems to trigger some warnings from older makeinfo versions:
On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
(Ubuntu: makeinfo (GNU texinfo) 5.2;
Fedora: makeinfo (GNU texinfo) 5.1)
/home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
/home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
/home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
/home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
On OSX (makeinfo (GNU texinfo) 4.8):
./qemu-options.texi:60: warning: unlikely character [ in @var.
./qemu-options.texi:60: warning: unlikely character ] in @var.
./qemu-options.texi:61: warning: unlikely character [ in @var.
./qemu-options.texi:61: warning: unlikely character ] in @var.
(OSX also has the long standing warning
/Users/pm215/src/qemu-for-merges/qemu-doc.texi:7: warning:
unrecognized encoding name `UTF-8'.
but you can ignore that since it's been that way for years
and is because osx's makeinfo is ancient.)
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-16 15:58 ` Peter Maydell
@ 2017-01-17 8:31 ` Markus Armbruster
2017-01-17 9:54 ` Marc-André Lureau
2017-01-17 11:08 ` Peter Maydell
0 siblings, 2 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-17 8:31 UTC (permalink / raw)
To: Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 16 January 2017 at 09:33, Markus Armbruster <armbru@redhat.com> wrote:
>> This is Marc-André's "[PATCH v8 00/21] qapi doc generation (whole
>> version, squashed)" with a few commit messages tweaked, and "[PATCH v8
>> 14/21] (SQUASHED) move doc to schema" unsquashed into 161 patches.
>>
>> We did all the respins with in this squashed form to reduce noise.
>> However, since the unsquashed form is better suited for review, and
>> probably nicer if we have to revisit this part of the work down the
>> road, I'm proposing to merge this unsquashed.
>>
>> If you want me to post the unsquashed patches, I'm happy to redo this
>> pull request.
>>
>> If you'd rather pull the squashed version, likewise.
>>
>> I'm afraid this is a bit of a doc conflict magnet. The sooner we can
>> get it in, the easier for Marc-André and me.
>>
>> v2:
>> * Rebased (v1 conflicts with commit e1ff3c6)
>> * test-qapi.py tweaked to avoid trailing empty lines in .out
>>
>> The following changes since commit b6af8ea60282df514f87d32e36afd1c9aeee28c8:
>>
>> Merge remote-tracking branch 'remotes/ehabkost/tags/x86-and-machine-pull-request' into staging (2017-01-13 14:38:21 +0000)
>>
>> are available in the git repository at:
>>
>> git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2017-01-16
>>
>> for you to fetch changes up to 56e8bdd46a8a42d89b0afea9da83ae7679cc0439:
>>
>> build-sys: add qapi doc generation targets (2017-01-16 10:11:43 +0100)
>>
>> ----------------------------------------------------------------
>> QAPI patches for 2017-01-16
>
> This seems to trigger some warnings from older makeinfo versions:
>
> On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
> (Ubuntu: makeinfo (GNU texinfo) 5.2;
> Fedora: makeinfo (GNU texinfo) 5.1)
Nobody should be using F20 by now, but the Ubuntu LTS is still legit.
> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
This is supposed to be defined in Makefile:
MAKEINFO=makeinfo -D 'VERSION $(VERSION)'
Hrrm, Texinfo's NEWS file has for 6.0:
* texi2any:
[...]
. -D'var val' on the command line works as intended again.
I tried to find out more about this fix, but the Texinfo repository's
commit log is useless.
I can reproduce the warning with 6.2 by running makeinfo without -D.
Curiously, output isn't affected. Looks like @subtitle is ignored by
makeinfo.
Possible work-around I could squash in:
diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
index 818e525..e0f2454 100644
--- a/docs/qemu-qmp-ref.texi
+++ b/docs/qemu-qmp-ref.texi
@@ -38,7 +38,9 @@ along with this manual. If not, see http://www.gnu.org/licens
es/.
@titlepage
@title QMP Reference Manual
+@iftex @c Work around bug in Texinfo prior to 6.0
@subtitle QEMU version @value{VERSION}
+@end iftex
@page
@vskip 0pt plus 1filll
@insertcopying
Marc-André, what do you think?
> On OSX (makeinfo (GNU texinfo) 4.8):
That's from 2004. Just sayin'.
> ./qemu-options.texi:60: warning: unlikely character [ in @var.
> ./qemu-options.texi:60: warning: unlikely character ] in @var.
> ./qemu-options.texi:61: warning: unlikely character [ in @var.
> ./qemu-options.texi:61: warning: unlikely character ] in @var.
Generated qemu-options.texi did not change (I checked).
The offending lines are
@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
which are generated from qemu-options.hx's
DEF("numa", HAS_ARG, QEMU_OPTION_numa,
"-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
"-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
by scripts/hxtool.
This use of @var{} is perhaps questionable, but nothing changed around
here for many moons. Are you sure this is new in my pull request?
> (OSX also has the long standing warning
> /Users/pm215/src/qemu-for-merges/qemu-doc.texi:7: warning:
> unrecognized encoding name `UTF-8'.
> but you can ignore that since it's been that way for years
> and is because osx's makeinfo is ancient.)
>
> thanks
> -- PMM
^ permalink raw reply related [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 8:31 ` Markus Armbruster
@ 2017-01-17 9:54 ` Marc-André Lureau
2017-01-17 10:13 ` Markus Armbruster
2017-01-17 11:08 ` Peter Maydell
1 sibling, 1 reply; 25+ messages in thread
From: Marc-André Lureau @ 2017-01-17 9:54 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell; +Cc: QEMU Developers
Hi
On Tue, Jan 17, 2017 at 12:34 PM Markus Armbruster <armbru@redhat.com>
wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > On 16 January 2017 at 09:33, Markus Armbruster <armbru@redhat.com>
> wrote:
> >> This is Marc-André's "[PATCH v8 00/21] qapi doc generation (whole
> >> version, squashed)" with a few commit messages tweaked, and "[PATCH v8
> >> 14/21] (SQUASHED) move doc to schema" unsquashed into 161 patches.
> >>
> >> We did all the respins with in this squashed form to reduce noise.
> >> However, since the unsquashed form is better suited for review, and
> >> probably nicer if we have to revisit this part of the work down the
> >> road, I'm proposing to merge this unsquashed.
> >>
> >> If you want me to post the unsquashed patches, I'm happy to redo this
> >> pull request.
> >>
> >> If you'd rather pull the squashed version, likewise.
> >>
> >> I'm afraid this is a bit of a doc conflict magnet. The sooner we can
> >> get it in, the easier for Marc-André and me.
> >>
> >> v2:
> >> * Rebased (v1 conflicts with commit e1ff3c6)
> >> * test-qapi.py tweaked to avoid trailing empty lines in .out
> >>
> >> The following changes since commit
> b6af8ea60282df514f87d32e36afd1c9aeee28c8:
> >>
> >> Merge remote-tracking branch
> 'remotes/ehabkost/tags/x86-and-machine-pull-request' into staging
> (2017-01-13 14:38:21 +0000)
> >>
> >> are available in the git repository at:
> >>
> >> git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2017-01-16
> >>
> >> for you to fetch changes up to 56e8bdd46a8a42d89b0afea9da83ae7679cc0439:
> >>
> >> build-sys: add qapi doc generation targets (2017-01-16 10:11:43 +0100)
> >>
> >> ----------------------------------------------------------------
> >> QAPI patches for 2017-01-16
> >
> > This seems to trigger some warnings from older makeinfo versions:
> >
> > On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
> > (Ubuntu: makeinfo (GNU texinfo) 5.2;
> > Fedora: makeinfo (GNU texinfo) 5.1)
>
> Nobody should be using F20 by now, but the Ubuntu LTS is still legit.
>
> > /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag:
> VERSION
> > /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag:
> VERSION
> > /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag:
> VERSION
> > /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag:
> VERSION
>
> This is supposed to be defined in Makefile:
>
> MAKEINFO=makeinfo -D 'VERSION $(VERSION)'
>
> Hrrm, Texinfo's NEWS file has for 6.0:
>
> * texi2any:
> [...]
> . -D'var val' on the command line works as intended again.
>
> I tried to find out more about this fix, but the Texinfo repository's
> commit log is useless.
>
> I can reproduce the warning with 6.2 by running makeinfo without -D.
> Curiously, output isn't affected. Looks like @subtitle is ignored by
> makeinfo.
>
> Possible work-around I could squash in:
>
> diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
> index 818e525..e0f2454 100644
> --- a/docs/qemu-qmp-ref.texi
> +++ b/docs/qemu-qmp-ref.texi
> @@ -38,7 +38,9 @@ along with this manual. If not, see
> http://www.gnu.org/licens
> es/ <http://www.gnu.org/licenses/>.
>
> @titlepage
> @title QMP Reference Manual
> +@iftex @c Work around bug in Texinfo prior to 6.0
> @subtitle QEMU version @value{VERSION}
> +@end iftex
> @page
> @vskip 0pt plus 1filll
> @insertcopying
>
> Marc-André, what do you think?
>
Since title @subtitle is being ignored by makeinfo, that looks fine.
However, I think I would prefer rather have the warning since it's a
makeinfo bug on old versions and it can be ignored. Hopefully, this thread
can easily be found for reference (update commit message too?). Either way,
I don't mind. Thanks
> > On OSX (makeinfo (GNU texinfo) 4.8):
>
> That's from 2004. Just sayin'.
>
> > ./qemu-options.texi:60: warning: unlikely character [ in @var.
> > ./qemu-options.texi:60: warning: unlikely character ] in @var.
> > ./qemu-options.texi:61: warning: unlikely character [ in @var.
> > ./qemu-options.texi:61: warning: unlikely character ] in @var.
>
> Generated qemu-options.texi did not change (I checked).
>
> The offending lines are
>
> @item -numa
> node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
> @itemx -numa
> node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
>
> which are generated from qemu-options.hx's
>
> DEF("numa", HAS_ARG, QEMU_OPTION_numa,
> "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
> "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n",
> QEMU_ARCH_ALL)
>
> by scripts/hxtool.
>
> This use of @var{} is perhaps questionable, but nothing changed around
> here for many moons. Are you sure this is new in my pull request?
>
> > (OSX also has the long standing warning
> > /Users/pm215/src/qemu-for-merges/qemu-doc.texi:7: warning:
> > unrecognized encoding name `UTF-8'.
> > but you can ignore that since it's been that way for years
> > and is because osx's makeinfo is ancient.)
> >
> > thanks
> > -- PMM
>
> --
Marc-André Lureau
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 9:54 ` Marc-André Lureau
@ 2017-01-17 10:13 ` Markus Armbruster
0 siblings, 0 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-17 10:13 UTC (permalink / raw)
To: Marc-André Lureau; +Cc: Peter Maydell, QEMU Developers
Marc-André Lureau <marcandre.lureau@gmail.com> writes:
> Hi
>
> On Tue, Jan 17, 2017 at 12:34 PM Markus Armbruster <armbru@redhat.com>
> wrote:
>
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > On 16 January 2017 at 09:33, Markus Armbruster <armbru@redhat.com>
>> wrote:
>> >> This is Marc-André's "[PATCH v8 00/21] qapi doc generation (whole
>> >> version, squashed)" with a few commit messages tweaked, and "[PATCH v8
>> >> 14/21] (SQUASHED) move doc to schema" unsquashed into 161 patches.
>> >>
>> >> We did all the respins with in this squashed form to reduce noise.
>> >> However, since the unsquashed form is better suited for review, and
>> >> probably nicer if we have to revisit this part of the work down the
>> >> road, I'm proposing to merge this unsquashed.
>> >>
>> >> If you want me to post the unsquashed patches, I'm happy to redo this
>> >> pull request.
>> >>
>> >> If you'd rather pull the squashed version, likewise.
>> >>
>> >> I'm afraid this is a bit of a doc conflict magnet. The sooner we can
>> >> get it in, the easier for Marc-André and me.
>> >>
>> >> v2:
>> >> * Rebased (v1 conflicts with commit e1ff3c6)
>> >> * test-qapi.py tweaked to avoid trailing empty lines in .out
>> >>
>> >> The following changes since commit
>> b6af8ea60282df514f87d32e36afd1c9aeee28c8:
>> >>
>> >> Merge remote-tracking branch
>> 'remotes/ehabkost/tags/x86-and-machine-pull-request' into staging
>> (2017-01-13 14:38:21 +0000)
>> >>
>> >> are available in the git repository at:
>> >>
>> >> git://repo.or.cz/qemu/armbru.git tags/pull-qapi-2017-01-16
>> >>
>> >> for you to fetch changes up to 56e8bdd46a8a42d89b0afea9da83ae7679cc0439:
>> >>
>> >> build-sys: add qapi doc generation targets (2017-01-16 10:11:43 +0100)
>> >>
>> >> ----------------------------------------------------------------
>> >> QAPI patches for 2017-01-16
>> >
>> > This seems to trigger some warnings from older makeinfo versions:
>> >
>> > On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
>> > (Ubuntu: makeinfo (GNU texinfo) 5.2;
>> > Fedora: makeinfo (GNU texinfo) 5.1)
>>
>> Nobody should be using F20 by now, but the Ubuntu LTS is still legit.
>>
>> > /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>> > /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>> > /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>> > /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>>
>> This is supposed to be defined in Makefile:
>>
>> MAKEINFO=makeinfo -D 'VERSION $(VERSION)'
>>
>> Hrrm, Texinfo's NEWS file has for 6.0:
>>
>> * texi2any:
>> [...]
>> . -D'var val' on the command line works as intended again.
>>
>> I tried to find out more about this fix, but the Texinfo repository's
>> commit log is useless.
>>
>> I can reproduce the warning with 6.2 by running makeinfo without -D.
>> Curiously, output isn't affected. Looks like @subtitle is ignored by
>> makeinfo.
>>
>> Possible work-around I could squash in:
>>
>> diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
>> index 818e525..e0f2454 100644
>> --- a/docs/qemu-qmp-ref.texi
>> +++ b/docs/qemu-qmp-ref.texi
>> @@ -38,7 +38,9 @@ along with this manual. If not, see
>> http://www.gnu.org/licens
>> es/ <http://www.gnu.org/licenses/>.
>>
>> @titlepage
>> @title QMP Reference Manual
>> +@iftex @c Work around bug in Texinfo prior to 6.0
>> @subtitle QEMU version @value{VERSION}
>> +@end iftex
>> @page
>> @vskip 0pt plus 1filll
>> @insertcopying
>>
>> Marc-André, what do you think?
>>
>
> Since title @subtitle is being ignored by makeinfo, that looks fine.
> However, I think I would prefer rather have the warning since it's a
> makeinfo bug on old versions and it can be ignored. Hopefully, this thread
> can easily be found for reference (update commit message too?). Either way,
> I don't mind. Thanks
My proposed work-around suppresses the warning we get from old versions
of makeinfo, but might degrade the title page with future versions of
makeinfo.
Peter, what's your preference?
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 8:31 ` Markus Armbruster
2017-01-17 9:54 ` Marc-André Lureau
@ 2017-01-17 11:08 ` Peter Maydell
2017-01-17 12:08 ` Markus Armbruster
1 sibling, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-17 11:08 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Marc-André Lureau, QEMU Developers
On 17 January 2017 at 08:31, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>> This seems to trigger some warnings from older makeinfo versions:
>>
>> On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
>> (Ubuntu: makeinfo (GNU texinfo) 5.2;
>> Fedora: makeinfo (GNU texinfo) 5.1)
>
> Nobody should be using F20 by now, but the Ubuntu LTS is still legit.
The F20 box is the GCC compile farm's ppc64be box, so I'm not going
to drop it from the build system list I'm afraid.
>> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>
> This is supposed to be defined in Makefile:
>
> MAKEINFO=makeinfo -D 'VERSION $(VERSION)'
>
> Hrrm, Texinfo's NEWS file has for 6.0:
>
> * texi2any:
> [...]
> . -D'var val' on the command line works as intended again.
>
> I tried to find out more about this fix, but the Texinfo repository's
> commit log is useless.
>
> I can reproduce the warning with 6.2 by running makeinfo without -D.
> Curiously, output isn't affected. Looks like @subtitle is ignored by
> makeinfo.
That suggests we should be putting the VERSION information
somewhere else so it actually appears in the output :-)
Maybe writing the VERSION info to a file as a @set command
(and then including that file in the texi) would work ?
> Possible work-around I could squash in:
>
> diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
> index 818e525..e0f2454 100644
> --- a/docs/qemu-qmp-ref.texi
> +++ b/docs/qemu-qmp-ref.texi
> @@ -38,7 +38,9 @@ along with this manual. If not, see http://www.gnu.org/licens
> es/.
>
> @titlepage
> @title QMP Reference Manual
> +@iftex @c Work around bug in Texinfo prior to 6.0
> @subtitle QEMU version @value{VERSION}
> +@end iftex
> @page
> @vskip 0pt plus 1filll
> @insertcopying
>
> Marc-André, what do you think?
>
>> On OSX (makeinfo (GNU texinfo) 4.8):
>
> That's from 2004. Just sayin'.
I assume it's the last GPLv2 version...
>> ./qemu-options.texi:60: warning: unlikely character [ in @var.
>> ./qemu-options.texi:60: warning: unlikely character ] in @var.
>> ./qemu-options.texi:61: warning: unlikely character [ in @var.
>> ./qemu-options.texi:61: warning: unlikely character ] in @var.
>
> Generated qemu-options.texi did not change (I checked).
>
> The offending lines are
>
> @item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
> @itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
>
> which are generated from qemu-options.hx's
>
> DEF("numa", HAS_ARG, QEMU_OPTION_numa,
> "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
> "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
>
> by scripts/hxtool.
>
> This use of @var{} is perhaps questionable, but nothing changed around
> here for many moons. Are you sure this is new in my pull request?
Yep, definitely new. With current master:
bash-3.2$ touch qemu-options.hx
bash-3.2$ make -C build/all
GEN qemu-options.def
GEN qemu-options.texi
GEN qemu-doc.html
/Users/pm215/src/qemu-for-merges/qemu-doc.texi:7: warning:
unrecognized encoding name `UTF-8'.
but no warnings about unlikely characters.
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 11:08 ` Peter Maydell
@ 2017-01-17 12:08 ` Markus Armbruster
2017-01-17 12:24 ` Peter Maydell
2017-01-17 17:05 ` Eric Blake
0 siblings, 2 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-17 12:08 UTC (permalink / raw)
To: Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 17 January 2017 at 08:31, Markus Armbruster <armbru@redhat.com> wrote:
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>> This seems to trigger some warnings from older makeinfo versions:
>>>
>>> On the Fedora 20 ppc64be box and Ubuntu 14.04.5 LTS aarch64 box
>>> (Ubuntu: makeinfo (GNU texinfo) 5.2;
>>> Fedora: makeinfo (GNU texinfo) 5.1)
>>
>> Nobody should be using F20 by now, but the Ubuntu LTS is still legit.
>
> The F20 box is the GCC compile farm's ppc64be box, so I'm not going
> to drop it from the build system list I'm afraid.
>
>>> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>>> /home/pm215/qemu/docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION
>>> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>>> /home/pm215/qemu/docs/qemu-qmp-ref.texi:41: warning: undefined flag: VERSION
>>
>> This is supposed to be defined in Makefile:
>>
>> MAKEINFO=makeinfo -D 'VERSION $(VERSION)'
>>
>> Hrrm, Texinfo's NEWS file has for 6.0:
>>
>> * texi2any:
>> [...]
>> . -D'var val' on the command line works as intended again.
>>
>> I tried to find out more about this fix, but the Texinfo repository's
>> commit log is useless.
>>
>> I can reproduce the warning with 6.2 by running makeinfo without -D.
>> Curiously, output isn't affected. Looks like @subtitle is ignored by
>> makeinfo.
>
> That suggests we should be putting the VERSION information
> somewhere else so it actually appears in the output :-)
>
> Maybe writing the VERSION info to a file as a @set command
> (and then including that file in the texi) would work ?
Right now, that'll make no difference whatsoever, because the programs
that choke on -D generate no output for the commands using the variable
defined with -D. All they do is gripe.
Three possible solutions, in increasing order of complexity:
1. Live with the warning from old versions. If a new version comes
around that does something with @subtitle, it'll just work.
2. Suppress the warning with @iftex-hammer. No change in output now.
If a new version comes around that does something with @subtitle, we
won't profit unless we take out the @iftex.
3. Replace -D by @set, either by preprocessing .texi, or by including a
generated snippet. No change in output now. If a new version comes
around that does something with @subtitle, it'll just work.
My order of preference is aligned with decreasing complexity, i.e. first
1., then 2., then 3.
Please tell me what you want.
If you want 3., I can certainly live with it, but I'd rather do 1. or
2. now, to get my rather conflict-prone pull request in, then do 3. as a
follow-up patch.
>> Possible work-around I could squash in:
>>
>> diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi
>> index 818e525..e0f2454 100644
>> --- a/docs/qemu-qmp-ref.texi
>> +++ b/docs/qemu-qmp-ref.texi
>> @@ -38,7 +38,9 @@ along with this manual. If not, see http://www.gnu.org/licens
>> es/.
>>
>> @titlepage
>> @title QMP Reference Manual
>> +@iftex @c Work around bug in Texinfo prior to 6.0
>> @subtitle QEMU version @value{VERSION}
>> +@end iftex
>> @page
>> @vskip 0pt plus 1filll
>> @insertcopying
>>
>> Marc-André, what do you think?
>>
>>> On OSX (makeinfo (GNU texinfo) 4.8):
>>
>> That's from 2004. Just sayin'.
>
> I assume it's the last GPLv2 version...
>
>>> ./qemu-options.texi:60: warning: unlikely character [ in @var.
>>> ./qemu-options.texi:60: warning: unlikely character ] in @var.
>>> ./qemu-options.texi:61: warning: unlikely character [ in @var.
>>> ./qemu-options.texi:61: warning: unlikely character ] in @var.
>>
>> Generated qemu-options.texi did not change (I checked).
>>
>> The offending lines are
>>
>> @item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
>> @itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
>>
>> which are generated from qemu-options.hx's
>>
>> DEF("numa", HAS_ARG, QEMU_OPTION_numa,
>> "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
>> "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
>>
>> by scripts/hxtool.
>>
>> This use of @var{} is perhaps questionable, but nothing changed around
>> here for many moons. Are you sure this is new in my pull request?
>
> Yep, definitely new. With current master:
>
> bash-3.2$ touch qemu-options.hx
> bash-3.2$ make -C build/all
> GEN qemu-options.def
> GEN qemu-options.texi
> GEN qemu-doc.html
> /Users/pm215/src/qemu-for-merges/qemu-doc.texi:7: warning:
> unrecognized encoding name `UTF-8'.
>
> but no warnings about unlikely characters.
The problem of having [] within @var certainly predates this series. I
can't see how the series brings it to the surface in the form of
warnings. I don't have access to OS-X myself. I tried to reproduce
with a locally compiled 4.8 I downloaded from gnu.org, no luck. Perhaps
I'm doing it wrong. Please send me a build log, preferably with V=1.
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 12:08 ` Markus Armbruster
@ 2017-01-17 12:24 ` Peter Maydell
2017-01-17 13:24 ` Markus Armbruster
2017-01-17 17:05 ` Eric Blake
1 sibling, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-17 12:24 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Marc-André Lureau, QEMU Developers
On 17 January 2017 at 12:08, Markus Armbruster <armbru@redhat.com> wrote:
> Right now, that'll make no difference whatsoever, because the programs
> that choke on -D generate no output for the commands using the variable
> defined with -D. All they do is gripe.
>
> Three possible solutions, in increasing order of complexity:
>
> 1. Live with the warning from old versions. If a new version comes
> around that does something with @subtitle, it'll just work.
>
> 2. Suppress the warning with @iftex-hammer. No change in output now.
> If a new version comes around that does something with @subtitle, we
> won't profit unless we take out the @iftex.
>
> 3. Replace -D by @set, either by preprocessing .texi, or by including a
> generated snippet. No change in output now. If a new version comes
> around that does something with @subtitle, it'll just work.
>
> My order of preference is aligned with decreasing complexity, i.e. first
> 1., then 2., then 3.
>
> Please tell me what you want.
>
> If you want 3., I can certainly live with it, but I'd rather do 1. or
> 2. now, to get my rather conflict-prone pull request in, then do 3. as a
> follow-up patch.
Yeah, I think it's reasonable to apply this now and then
fix up the warnings afterwards, since they don't break the
build. I'll do that.
In terms of what I'd like for the VERSION issue:
(1) if it doesn't actually cause a change in the output, we
should either just delete the use of VERSION entirely, or move
it to somewhere outside of @subtitle which does actually
appear somewhere. There's no point in putting in the version
info if it doesn't get into the final output, whether
it generates a warning or not.
(2) If we want to display VERSION then we need to use @set,
it looks like.
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 12:24 ` Peter Maydell
@ 2017-01-17 13:24 ` Markus Armbruster
2017-01-17 13:59 ` Peter Maydell
0 siblings, 1 reply; 25+ messages in thread
From: Markus Armbruster @ 2017-01-17 13:24 UTC (permalink / raw)
To: Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 17 January 2017 at 12:08, Markus Armbruster <armbru@redhat.com> wrote:
>> Right now, that'll make no difference whatsoever, because the programs
>> that choke on -D generate no output for the commands using the variable
>> defined with -D. All they do is gripe.
>>
>> Three possible solutions, in increasing order of complexity:
>>
>> 1. Live with the warning from old versions. If a new version comes
>> around that does something with @subtitle, it'll just work.
>>
>> 2. Suppress the warning with @iftex-hammer. No change in output now.
>> If a new version comes around that does something with @subtitle, we
>> won't profit unless we take out the @iftex.
>>
>> 3. Replace -D by @set, either by preprocessing .texi, or by including a
>> generated snippet. No change in output now. If a new version comes
>> around that does something with @subtitle, it'll just work.
>>
>> My order of preference is aligned with decreasing complexity, i.e. first
>> 1., then 2., then 3.
>>
>> Please tell me what you want.
>>
>> If you want 3., I can certainly live with it, but I'd rather do 1. or
>> 2. now, to get my rather conflict-prone pull request in, then do 3. as a
>> follow-up patch.
>
> Yeah, I think it's reasonable to apply this now and then
> fix up the warnings afterwards, since they don't break the
> build. I'll do that.
Thanks!
> In terms of what I'd like for the VERSION issue:
>
> (1) if it doesn't actually cause a change in the output, we
> should either just delete the use of VERSION entirely, or move
> it to somewhere outside of @subtitle which does actually
> appear somewhere. There's no point in putting in the version
> info if it doesn't get into the final output, whether
> it generates a warning or not.
It does affect PDF output. PDF is generated by texi2pdf, which uses
different command line options, and setting VERSION works fine there.
> (2) If we want to display VERSION then we need to use @set,
> it looks like.
We need to decide whether we want to display the information that is now
in @subtitle in makeinfo output in addition to PDF output. If yes, we
need to put it somewhere else than the subtitle, and find a
bug-compatible way to set VERSION. If no, we still might want to
silence the warning produced by old versions of makeinfo.
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 13:24 ` Markus Armbruster
@ 2017-01-17 13:59 ` Peter Maydell
2017-01-17 14:15 ` Marc-André Lureau
2017-01-17 14:23 ` Markus Armbruster
0 siblings, 2 replies; 25+ messages in thread
From: Peter Maydell @ 2017-01-17 13:59 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Marc-André Lureau, QEMU Developers
On 17 January 2017 at 13:24, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>> (1) if it doesn't actually cause a change in the output, we
>> should either just delete the use of VERSION entirely, or move
>> it to somewhere outside of @subtitle which does actually
>> appear somewhere. There's no point in putting in the version
>> info if it doesn't get into the final output, whether
>> it generates a warning or not.
>
> It does affect PDF output. PDF is generated by texi2pdf, which uses
> different command line options, and setting VERSION works fine there.
Mmm, but if it's useful information we should be displaying
it in all our documentation formats, not just tucking it
away in something that only appears in the PDF.
Conversely, if we're happy for some of our document formats
not to contain it we could save ourselves the grief of
having to work around this bug by dropping the @subtitle entirely.
As an aside, how useful is the PDF output anyway? In 2017
there seems to me quite a good argument for just creating
HTML...
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 13:59 ` Peter Maydell
@ 2017-01-17 14:15 ` Marc-André Lureau
2017-01-17 14:23 ` Markus Armbruster
1 sibling, 0 replies; 25+ messages in thread
From: Marc-André Lureau @ 2017-01-17 14:15 UTC (permalink / raw)
To: Peter Maydell; +Cc: Markus Armbruster, QEMU Developers
Hi
----- Original Message -----
> On 17 January 2017 at 13:24, Markus Armbruster <armbru@redhat.com> wrote:
> > Peter Maydell <peter.maydell@linaro.org> writes:
> >> (1) if it doesn't actually cause a change in the output, we
> >> should either just delete the use of VERSION entirely, or move
> >> it to somewhere outside of @subtitle which does actually
> >> appear somewhere. There's no point in putting in the version
> >> info if it doesn't get into the final output, whether
> >> it generates a warning or not.
> >
> > It does affect PDF output. PDF is generated by texi2pdf, which uses
> > different command line options, and setting VERSION works fine there.
>
> Mmm, but if it's useful information we should be displaying
> it in all our documentation formats, not just tucking it
> away in something that only appears in the PDF.
> Conversely, if we're happy for some of our document formats
> not to contain it we could save ourselves the grief of
> having to work around this bug by dropping the @subtitle entirely.
It would be quite easy to add to the rest of the docs, that can be added on top.
If its not useful enough in this current form (since it's only in the PDF, because tooling is lacking support), feel freel to remove it Markus.
> As an aside, how useful is the PDF output anyway? In 2017
> there seems to me quite a good argument for just creating
> HTML...
>
Afaik, most browsers support pdf nowadays.
pdf output is more pleasant to read, the html version would need significant styling to be comparable (I have played with the CSS, that would already help). I hope we get there once we have better doc tooling (sphinx, readthedocs etc)
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 13:59 ` Peter Maydell
2017-01-17 14:15 ` Marc-André Lureau
@ 2017-01-17 14:23 ` Markus Armbruster
2017-01-17 16:43 ` Peter Maydell
1 sibling, 1 reply; 25+ messages in thread
From: Markus Armbruster @ 2017-01-17 14:23 UTC (permalink / raw)
To: Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 17 January 2017 at 13:24, Markus Armbruster <armbru@redhat.com> wrote:
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>> (1) if it doesn't actually cause a change in the output, we
>>> should either just delete the use of VERSION entirely, or move
>>> it to somewhere outside of @subtitle which does actually
>>> appear somewhere. There's no point in putting in the version
>>> info if it doesn't get into the final output, whether
>>> it generates a warning or not.
>>
>> It does affect PDF output. PDF is generated by texi2pdf, which uses
>> different command line options, and setting VERSION works fine there.
>
> Mmm, but if it's useful information we should be displaying
> it in all our documentation formats, not just tucking it
> away in something that only appears in the PDF.
> Conversely, if we're happy for some of our document formats
> not to contain it we could save ourselves the grief of
> having to work around this bug by dropping the @subtitle entirely.
Yes, that's why I wrote we need to decide whether we want the
information that is now in @subtitle in the formats where @subtitle
currently doesn't appear.
> As an aside, how useful is the PDF output anyway? In 2017
> there seems to me quite a good argument for just creating
> HTML...
We do generate HTML. We also generate PDF. It's better for printing
(if you're so inclined), and it costs us next to nothing: a couple of
lines in the top-level Makefile. See commit 20cc999 "Documentation: Add
build support for documentation in pdf format" (January 2010) and also
commit ad23988 "build-sys: remove dvi doc generation" (in this series).
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 14:23 ` Markus Armbruster
@ 2017-01-17 16:43 ` Peter Maydell
2017-01-20 14:39 ` Peter Maydell
0 siblings, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-17 16:43 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Marc-André Lureau, QEMU Developers
On 17 January 2017 at 14:23, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>> As an aside, how useful is the PDF output anyway? In 2017
>> there seems to me quite a good argument for just creating
>> HTML...
>
> We do generate HTML. We also generate PDF. It's better for printing
> (if you're so inclined), and it costs us next to nothing: a couple of
> lines in the top-level Makefile.
Mmm, but in thinking about other possible document formats
it would be interesting to know whether not producing PDF
would be a dealbreaker or just dropping a feature that three
people use...
In any case, applied this pullreq to master. Interestingly
there were no signs of the "unlikely character" warnings
this time around.
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 12:08 ` Markus Armbruster
2017-01-17 12:24 ` Peter Maydell
@ 2017-01-17 17:05 ` Eric Blake
1 sibling, 0 replies; 25+ messages in thread
From: Eric Blake @ 2017-01-17 17:05 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
[-- Attachment #1: Type: text/plain, Size: 1335 bytes --]
On 01/17/2017 06:08 AM, Markus Armbruster wrote:
>
> Three possible solutions, in increasing order of complexity:
>
> 1. Live with the warning from old versions. If a new version comes
> around that does something with @subtitle, it'll just work.
>
> 2. Suppress the warning with @iftex-hammer. No change in output now.
> If a new version comes around that does something with @subtitle, we
> won't profit unless we take out the @iftex.
>
> 3. Replace -D by @set, either by preprocessing .texi, or by including a
> generated snippet. No change in output now. If a new version comes
> around that does something with @subtitle, it'll just work.
Automake projects use option 3 - they create version.texi with @set
commands, then @include that into the main file. Should be fairly easy
to crib the makefile magic from an autotooled project if you want to go
that option.
>
> My order of preference is aligned with decreasing complexity, i.e. first
> 1., then 2., then 3.
I'm fine with any of the options (3 is nicest, but also the most work).
I do agree, however, that if we are going to include version information
(which I find useful), then we want it in both pdf and html outputs.
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-17 16:43 ` Peter Maydell
@ 2017-01-20 14:39 ` Peter Maydell
2017-01-20 15:46 ` Markus Armbruster
2017-01-24 9:53 ` Markus Armbruster
0 siblings, 2 replies; 25+ messages in thread
From: Peter Maydell @ 2017-01-20 14:39 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Marc-André Lureau, QEMU Developers
On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
> In any case, applied this pullreq to master.
Although it works fine on my OSX box (with warnings) it seems
to have broken the Travis OSX builds:
https://travis-ci.org/qemu/qemu/jobs/192750574
GEN qemu-options.texi
GEN qemu-monitor.texi
GEN qemu-img-cmds.texi
GEN qemu-monitor-info.texi
GEN qemu-doc.txt
qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
GEN qemu-img.1
/Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
character [ in @var.
/Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
character ] in @var.
/Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
character [ in @var.
/Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
character ] in @var.
/Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
/Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
makeinfo: Removing output file `qemu-doc.txt' due to errors; use
--force to preserve.
make: *** [qemu-doc.txt] Error 1
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-20 14:39 ` Peter Maydell
@ 2017-01-20 15:46 ` Markus Armbruster
2017-01-20 15:48 ` Peter Maydell
2017-01-23 13:59 ` Daniel P. Berrange
2017-01-24 9:53 ` Markus Armbruster
1 sibling, 2 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-20 15:46 UTC (permalink / raw)
To: Peter Maydell; +Cc: Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>> In any case, applied this pullreq to master.
>
> Although it works fine on my OSX box (with warnings) it seems
> to have broken the Travis OSX builds:
> https://travis-ci.org/qemu/qemu/jobs/192750574
>
> GEN qemu-options.texi
> GEN qemu-monitor.texi
> GEN qemu-img-cmds.texi
> GEN qemu-monitor-info.texi
> GEN qemu-doc.txt
> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
> GEN qemu-img.1
> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> character [ in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> character ] in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> character [ in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> character ] in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
> --force to preserve.
> make: *** [qemu-doc.txt] Error 1
@table and @end table are nested correctly in my generated
qemu-options.texi, and @anchor{bt-hcis} is present. Can you grab the
offending qemu-options.texi for me?
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-20 15:46 ` Markus Armbruster
@ 2017-01-20 15:48 ` Peter Maydell
2017-01-23 12:48 ` Alex Bennée
2017-01-23 13:59 ` Daniel P. Berrange
1 sibling, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-20 15:48 UTC (permalink / raw)
To: Markus Armbruster
Cc: Marc-André Lureau, QEMU Developers, Alex Bennée
On 20 January 2017 at 15:46, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>>> In any case, applied this pullreq to master.
>>
>> Although it works fine on my OSX box (with warnings) it seems
>> to have broken the Travis OSX builds:
>> https://travis-ci.org/qemu/qemu/jobs/192750574
>>
>> GEN qemu-options.texi
>> GEN qemu-monitor.texi
>> GEN qemu-img-cmds.texi
>> GEN qemu-monitor-info.texi
>> GEN qemu-doc.txt
>> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>> GEN qemu-img.1
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>> --force to preserve.
>> make: *** [qemu-doc.txt] Error 1
>
> @table and @end table are nested correctly in my generated
> qemu-options.texi, and @anchor{bt-hcis} is present. Can you grab the
> offending qemu-options.texi for me?
Alex may know how to get objects out of a failed Travis build
(if it's possible at all).
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-20 15:48 ` Peter Maydell
@ 2017-01-23 12:48 ` Alex Bennée
0 siblings, 0 replies; 25+ messages in thread
From: Alex Bennée @ 2017-01-23 12:48 UTC (permalink / raw)
To: Peter Maydell; +Cc: Markus Armbruster, Marc-André Lureau, QEMU Developers
Peter Maydell <peter.maydell@linaro.org> writes:
> On 20 January 2017 at 15:46, Markus Armbruster <armbru@redhat.com> wrote:
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>>> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>>>> In any case, applied this pullreq to master.
>>>
>>> Although it works fine on my OSX box (with warnings) it seems
>>> to have broken the Travis OSX builds:
>>> https://travis-ci.org/qemu/qemu/jobs/192750574
>>>
>>> GEN qemu-options.texi
>>> GEN qemu-monitor.texi
>>> GEN qemu-img-cmds.texi
>>> GEN qemu-monitor-info.texi
>>> GEN qemu-doc.txt
>>> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>>> GEN qemu-img.1
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>>> character [ in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>>> character ] in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>>> character [ in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>>> character ] in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>>> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>>> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>>> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>>> --force to preserve.
>>> make: *** [qemu-doc.txt] Error 1
>>
>> @table and @end table are nested correctly in my generated
>> qemu-options.texi, and @anchor{bt-hcis} is present. Can you grab the
>> offending qemu-options.texi for me?
>
> Alex may know how to get objects out of a failed Travis build
> (if it's possible at all).
For the normal targets we can re-create builds at our leisure using the
travis docker image. Unfortunately I'm not clear on how this works for
the MacOSX build.
The best solution I can come up with is to tweak your build to dump the
.text into stdout and then look on the Travis web-page as the build
fails. I had a similar fall-back encoded when debugging the clang build,
something like:
before_script:
- ./configure ${CONFIG} --extra-cflags="-g3 -O0 -fsanitize=thread -fuse-ld=gold" || cat config.log
So change your local .travis.yml to:
- env: CONFIG=""
os: osx
compiler: clang
script: make -j3 || cat qemu-options.texi
and trigger a build with it.
--
Alex Bennée
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-20 15:46 ` Markus Armbruster
2017-01-20 15:48 ` Peter Maydell
@ 2017-01-23 13:59 ` Daniel P. Berrange
2017-01-23 14:49 ` Markus Armbruster
1 sibling, 1 reply; 25+ messages in thread
From: Daniel P. Berrange @ 2017-01-23 13:59 UTC (permalink / raw)
To: Markus Armbruster; +Cc: Peter Maydell, Marc-André Lureau, QEMU Developers
On Fri, Jan 20, 2017 at 04:46:05PM +0100, Markus Armbruster wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
> > On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
> >> In any case, applied this pullreq to master.
> >
> > Although it works fine on my OSX box (with warnings) it seems
> > to have broken the Travis OSX builds:
> > https://travis-ci.org/qemu/qemu/jobs/192750574
> >
> > GEN qemu-options.texi
> > GEN qemu-monitor.texi
> > GEN qemu-img-cmds.texi
> > GEN qemu-monitor-info.texi
> > GEN qemu-doc.txt
> > qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
> > GEN qemu-img.1
> > /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> > character [ in @var.
> > /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> > character ] in @var.
> > /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> > character [ in @var.
> > /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> > character ] in @var.
> > /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
> > /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
> > nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
> > makeinfo: Removing output file `qemu-doc.txt' due to errors; use
> > --force to preserve.
> > make: *** [qemu-doc.txt] Error 1
>
> @table and @end table are nested correctly in my generated
> qemu-options.texi, and @anchor{bt-hcis} is present. Can you grab the
> offending qemu-options.texi for me?
I hacked the travis.yml to add "|| cat qemu-options.texi" after the
build fails. The output is here:
https://travis-ci.org/berrange/qemu/jobs/194471961
Regards,
Daniel
--
|: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org -o- http://virt-manager.org :|
|: http://entangle-photo.org -o- http://search.cpan.org/~danberr/ :|
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-23 13:59 ` Daniel P. Berrange
@ 2017-01-23 14:49 ` Markus Armbruster
0 siblings, 0 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-23 14:49 UTC (permalink / raw)
To: Daniel P. Berrange; +Cc: Peter Maydell, Marc-André Lureau, QEMU Developers
"Daniel P. Berrange" <berrange@redhat.com> writes:
> On Fri, Jan 20, 2017 at 04:46:05PM +0100, Markus Armbruster wrote:
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>> > On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>> >> In any case, applied this pullreq to master.
>> >
>> > Although it works fine on my OSX box (with warnings) it seems
>> > to have broken the Travis OSX builds:
>> > https://travis-ci.org/qemu/qemu/jobs/192750574
>> >
>> > GEN qemu-options.texi
>> > GEN qemu-monitor.texi
>> > GEN qemu-img-cmds.texi
>> > GEN qemu-monitor-info.texi
>> > GEN qemu-doc.txt
>> > qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>> > GEN qemu-img.1
>> > /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> > character [ in @var.
>> > /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> > character ] in @var.
>> > /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> > character [ in @var.
>> > /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> > character ] in @var.
>> > /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>> > /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>> > nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>> > makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>> > --force to preserve.
>> > make: *** [qemu-doc.txt] Error 1
>>
>> @table and @end table are nested correctly in my generated
>> qemu-options.texi, and @anchor{bt-hcis} is present. Can you grab the
>> offending qemu-options.texi for me?
>
> I hacked the travis.yml to add "|| cat qemu-options.texi" after the
> build fails. The output is here:
>
> https://travis-ci.org/berrange/qemu/jobs/194471961
I fetched your branch (it's much more than just current master + the
hack), and my local build generates the exact same qemu-options.texi,
modulo line endings (I think; diff -w comes up empty).
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-20 14:39 ` Peter Maydell
2017-01-20 15:46 ` Markus Armbruster
@ 2017-01-24 9:53 ` Markus Armbruster
2017-01-24 10:03 ` Peter Maydell
2017-01-24 10:09 ` Markus Armbruster
1 sibling, 2 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-24 9:53 UTC (permalink / raw)
To: Peter Maydell
Cc: Marc-André Lureau, QEMU Developers, Alex Bennée, Paolo Bonzini
Peter Maydell <peter.maydell@linaro.org> writes:
> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>> In any case, applied this pullreq to master.
>
> Although it works fine on my OSX box (with warnings) it seems
> to have broken the Travis OSX builds:
> https://travis-ci.org/qemu/qemu/jobs/192750574
>
> GEN qemu-options.texi
> GEN qemu-monitor.texi
> GEN qemu-img-cmds.texi
> GEN qemu-monitor-info.texi
> GEN qemu-doc.txt
> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
> GEN qemu-img.1
> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> character [ in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
> character ] in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> character [ in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
> character ] in @var.
> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
> --force to preserve.
> make: *** [qemu-doc.txt] Error 1
Are you *sure* this series causes the failure?
I generated qemu-options.texi for every merge commit since v2.8.0, and
the only one that changes it is commit 598cf1c "Merge remote-tracking
branch 'remotes/bonzini/tags/for-upstream' into staging". I then
examined the commits in that merge, and the ones that affect
qemu-options.texi are:
* commit 43f187a hxtool: emit Texinfo headings as @subsection
* commit b0cb0a6 Plumb the HAXM-based hardware acceleration support
Could you kick off Travis builds to confirm or deny these commits cause
the OS X trouble?
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-24 9:53 ` Markus Armbruster
@ 2017-01-24 10:03 ` Peter Maydell
2017-01-24 11:08 ` Markus Armbruster
2017-01-24 10:09 ` Markus Armbruster
1 sibling, 1 reply; 25+ messages in thread
From: Peter Maydell @ 2017-01-24 10:03 UTC (permalink / raw)
To: Markus Armbruster
Cc: Marc-André Lureau, QEMU Developers, Alex Bennée, Paolo Bonzini
On 24 January 2017 at 09:53, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>>> In any case, applied this pullreq to master.
>>
>> Although it works fine on my OSX box (with warnings) it seems
>> to have broken the Travis OSX builds:
>> https://travis-ci.org/qemu/qemu/jobs/192750574
>>
>> GEN qemu-options.texi
>> GEN qemu-monitor.texi
>> GEN qemu-img-cmds.texi
>> GEN qemu-monitor-info.texi
>> GEN qemu-doc.txt
>> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>> GEN qemu-img.1
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>> --force to preserve.
>> make: *** [qemu-doc.txt] Error 1
>
> Are you *sure* this series causes the failure?
It's pretty solidly looking like it in travis: everything
passes up until this merge is applied, and then everything
fails...
> I generated qemu-options.texi for every merge commit since v2.8.0, and
> the only one that changes it is commit 598cf1c "Merge remote-tracking
> branch 'remotes/bonzini/tags/for-upstream' into staging".
Travis was already failing with this error before 598cf1c.
First build with this error was on commit 23eb9e6; the build on
the merge before that was fine.
https://travis-ci.org/qemu/qemu/jobs/192750574
is the build log for the first failure.
https://travis-ci.org/qemu/qemu/jobs/192689212
is the build log for the previous success.
I do note one difference: the successful build does not appear
to try to build qemu-doc.txt. Perhaps your merge enabled
an attempt to build some flavour of the docs that has
always been broken ?
thanks
-- PMM
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-24 9:53 ` Markus Armbruster
2017-01-24 10:03 ` Peter Maydell
@ 2017-01-24 10:09 ` Markus Armbruster
2017-01-24 10:49 ` Paolo Bonzini
1 sibling, 1 reply; 25+ messages in thread
From: Markus Armbruster @ 2017-01-24 10:09 UTC (permalink / raw)
To: Peter Maydell
Cc: Marc-André Lureau, QEMU Developers, Alex Bennée, Paolo Bonzini
Markus Armbruster <armbru@redhat.com> writes:
> Peter Maydell <peter.maydell@linaro.org> writes:
>
>> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>>> In any case, applied this pullreq to master.
>>
>> Although it works fine on my OSX box (with warnings) it seems
>> to have broken the Travis OSX builds:
>> https://travis-ci.org/qemu/qemu/jobs/192750574
>>
>> GEN qemu-options.texi
>> GEN qemu-monitor.texi
>> GEN qemu-img-cmds.texi
>> GEN qemu-monitor-info.texi
>> GEN qemu-doc.txt
>> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>> GEN qemu-img.1
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character [ in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>> character ] in @var.
>> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>> --force to preserve.
>> make: *** [qemu-doc.txt] Error 1
>
> Are you *sure* this series causes the failure?
>
> I generated qemu-options.texi for every merge commit since v2.8.0, and
> the only one that changes it is commit 598cf1c "Merge remote-tracking
> branch 'remotes/bonzini/tags/for-upstream' into staging". I then
> examined the commits in that merge, and the ones that affect
> qemu-options.texi are:
>
> * commit 43f187a hxtool: emit Texinfo headings as @subsection
> * commit b0cb0a6 Plumb the HAXM-based hardware acceleration support
>
> Could you kick off Travis builds to confirm or deny these commits cause
> the OS X trouble?
Different tack: perhaps it's the way we run makeinfo. Commits touching
that:
* commit 56e8bdd build-sys: add qapi doc generation targets
* commit f8bab10 build-sys: add txt documentation rules
* commit e9ee06b build-sys: use --no-split for info
Travis builds, please?
Of course, if you got a Mac outside Travis that also fails, trying there
would be quicker.
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-24 10:09 ` Markus Armbruster
@ 2017-01-24 10:49 ` Paolo Bonzini
0 siblings, 0 replies; 25+ messages in thread
From: Paolo Bonzini @ 2017-01-24 10:49 UTC (permalink / raw)
To: Markus Armbruster, Peter Maydell
Cc: Marc-André Lureau, QEMU Developers, Alex Bennée
On 24/01/2017 11:09, Markus Armbruster wrote:
> * commit f8bab10 build-sys: add txt documentation rules
This could be the culprit...
Paolo
^ permalink raw reply [flat|nested] 25+ messages in thread
* Re: [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16
2017-01-24 10:03 ` Peter Maydell
@ 2017-01-24 11:08 ` Markus Armbruster
0 siblings, 0 replies; 25+ messages in thread
From: Markus Armbruster @ 2017-01-24 11:08 UTC (permalink / raw)
To: Peter Maydell
Cc: Alex Bennée, Marc-André Lureau, QEMU Developers, Paolo Bonzini
Peter Maydell <peter.maydell@linaro.org> writes:
> On 24 January 2017 at 09:53, Markus Armbruster <armbru@redhat.com> wrote:
>> Peter Maydell <peter.maydell@linaro.org> writes:
>>
>>> On 17 January 2017 at 16:43, Peter Maydell <peter.maydell@linaro.org> wrote:
>>>> In any case, applied this pullreq to master.
>>>
>>> Although it works fine on my OSX box (with warnings) it seems
>>> to have broken the Travis OSX builds:
>>> https://travis-ci.org/qemu/qemu/jobs/192750574
>>>
>>> GEN qemu-options.texi
>>> GEN qemu-monitor.texi
>>> GEN qemu-img-cmds.texi
>>> GEN qemu-monitor-info.texi
>>> GEN qemu-doc.txt
>>> qemu-doc.texi:7: warning: unrecognized encoding name `UTF-8'.
>>> GEN qemu-img.1
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>>> character [ in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:60: warning: unlikely
>>> character ] in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>>> character [ in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:61: warning: unlikely
>>> character ] in @var.
>>> /Users/travis/build/qemu/qemu//qemu-options.texi:630: No matching `@end table'.
>>> /Users/travis/build/qemu/qemu//qemu-doc.texi:1419: Cross reference to
>>> nonexistent node `bt-hcis' (perhaps incorrect sectioning?).
>>> makeinfo: Removing output file `qemu-doc.txt' due to errors; use
>>> --force to preserve.
>>> make: *** [qemu-doc.txt] Error 1
>>
>> Are you *sure* this series causes the failure?
>
> It's pretty solidly looking like it in travis: everything
> passes up until this merge is applied, and then everything
> fails...
>
>> I generated qemu-options.texi for every merge commit since v2.8.0, and
>> the only one that changes it is commit 598cf1c "Merge remote-tracking
>> branch 'remotes/bonzini/tags/for-upstream' into staging".
>
> Travis was already failing with this error before 598cf1c.
> First build with this error was on commit 23eb9e6; the build on
> the merge before that was fine.
> https://travis-ci.org/qemu/qemu/jobs/192750574
> is the build log for the first failure.
> https://travis-ci.org/qemu/qemu/jobs/192689212
> is the build log for the previous success.
Yeah, that's conclusive.
> I do note one difference: the successful build does not appear
> to try to build qemu-doc.txt. Perhaps your merge enabled
> an attempt to build some flavour of the docs that has
> always been broken ?
Since .texi doesn't change, the way we process it is the most likely
suspect. In my other message, I list three commits that affect
processing. I need help with testing them on OS X.
^ permalink raw reply [flat|nested] 25+ messages in thread
end of thread, other threads:[~2017-01-24 11:08 UTC | newest]
Thread overview: 25+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-01-16 9:33 [Qemu-devel] [PULL v2 000/180] QAPI patches for 2017-01-16 Markus Armbruster
2017-01-16 15:58 ` Peter Maydell
2017-01-17 8:31 ` Markus Armbruster
2017-01-17 9:54 ` Marc-André Lureau
2017-01-17 10:13 ` Markus Armbruster
2017-01-17 11:08 ` Peter Maydell
2017-01-17 12:08 ` Markus Armbruster
2017-01-17 12:24 ` Peter Maydell
2017-01-17 13:24 ` Markus Armbruster
2017-01-17 13:59 ` Peter Maydell
2017-01-17 14:15 ` Marc-André Lureau
2017-01-17 14:23 ` Markus Armbruster
2017-01-17 16:43 ` Peter Maydell
2017-01-20 14:39 ` Peter Maydell
2017-01-20 15:46 ` Markus Armbruster
2017-01-20 15:48 ` Peter Maydell
2017-01-23 12:48 ` Alex Bennée
2017-01-23 13:59 ` Daniel P. Berrange
2017-01-23 14:49 ` Markus Armbruster
2017-01-24 9:53 ` Markus Armbruster
2017-01-24 10:03 ` Peter Maydell
2017-01-24 11:08 ` Markus Armbruster
2017-01-24 10:09 ` Markus Armbruster
2017-01-24 10:49 ` Paolo Bonzini
2017-01-17 17:05 ` Eric Blake
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.