From 1ede77dfd2220074c5ec3a1d1a25a5ec1ccbc17d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 17 Feb 2017 13:34:16 +0400 Subject: [PATCH 1/2] qapi2texi: replace quotation by bold section name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit When we build qemu-qmp-ref.txt this causes texinfo to complain several times: "Negative repeat count does nothing at /usr/share/texinfo/Texinfo/Convert/Line.pm line 124." It also doesn't display correctly, because the "Notes" text disappears entirely in the HTML version because it thinks there's no actual quotation text. The text file output formatting is also not good. To solve those problems, remove usage of @quotation, and simply use bold face for the section name. Reported-by: Peter Maydell Signed-off-by: Marc-André Lureau Message-Id: <20170217093416.27688-1-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- scripts/qapi2texi.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 83ded95c2d..c1071c62c6 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -159,12 +159,10 @@ def texi_body(doc): func = texi_example if name: - # FIXME the indentation produced by @quotation in .txt and - # .html output is confusing - body += "\n@quotation %s\n%s\n@end quotation" % \ - (name, func(doc)) - else: - body += func(doc) + # prefer @b over @strong, so txt doesn't translate it to *Foo:* + body += "\n\n@b{%s:}\n" % name + + body += func(doc) return body From fea346f569d4132296f7c26367374fcace80e096 Mon Sep 17 00:00:00 2001 From: Peter Maydell Date: Fri, 17 Feb 2017 18:59:28 +0000 Subject: [PATCH 2/2] Makefile: Put VERSION info into version.texi rather than using -D MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Unfortunately some older versions of makeinfo don't correctly handle the -D command line option and fail to set the variable. This then causes them to complain docs/qemu-ga-ref.texi:41: warning: undefined flag: VERSION Work around this by doing as the autotools do, and writing the information into a version.texi file which we then include from the .texi files that need it. Signed-off-by: Peter Maydell Reviewed-by: Eric Blake Message-Id: <1487357968-31000-1-git-send-email-peter.maydell@linaro.org> Reviewed-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- .gitignore | 1 + Makefile | 17 ++++++++++------- docs/qemu-ga-ref.texi | 2 ++ docs/qemu-qmp-ref.texi | 2 ++ 4 files changed, 15 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index c563dc175f..2849d756cc 100644 --- a/.gitignore +++ b/.gitignore @@ -107,6 +107,7 @@ docs/qemu-ga-ref.info* docs/qemu-qmp-ref.info* /qemu-ga-qapi.texi /qemu-qapi.texi +/version.texi *.tps .stgit-* cscope.* diff --git a/Makefile b/Makefile index 830fa5a234..1c4c04f6f2 100644 --- a/Makefile +++ b/Makefile @@ -516,7 +516,7 @@ distclean: clean rm -f qemu-doc.vr qemu-doc.txt rm -f config.log rm -f linux-headers/asm - rm -f qemu-ga-qapi.texi qemu-qapi.texi + rm -f qemu-ga-qapi.texi qemu-qapi.texi version.texi rm -f docs/qemu-qmp-ref.7 docs/qemu-ga-ref.7 rm -f docs/qemu-qmp-ref.txt docs/qemu-ga-ref.txt rm -f docs/qemu-qmp-ref.pdf docs/qemu-ga-ref.pdf @@ -663,21 +663,24 @@ ui/console-gl.o: $(SRC_PATH)/ui/console-gl.c \ # documentation MAKEINFO=makeinfo -MAKEINFOFLAGS=--no-split --number-sections -D 'VERSION $(VERSION)' -TEXIFLAG=$(if $(V),,--quiet) --command='@set VERSION $(VERSION)' +MAKEINFOFLAGS=--no-split --number-sections +TEXIFLAG=$(if $(V),,--quiet) -%.html: %.texi +version.texi: $(SRC_PATH)/VERSION + $(call quiet-command,echo "@set VERSION $(VERSION)" > $@,"GEN","$@") + +%.html: %.texi version.texi $(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \ --html $< -o $@,"GEN","$@") -%.info: %.texi +%.info: %.texi version.texi $(call quiet-command,$(MAKEINFO) $(MAKEINFOFLAGS) $< -o $@,"GEN","$@") -%.txt: %.texi +%.txt: %.texi version.texi $(call quiet-command,LC_ALL=C $(MAKEINFO) $(MAKEINFOFLAGS) --no-headers \ --plaintext $< -o $@,"GEN","$@") -%.pdf: %.texi +%.pdf: %.texi version.texi $(call quiet-command,texi2pdf $(TEXIFLAG) -I $(SRC_PATH) -I . $< -o $@,"GEN","$@") qemu-options.texi: $(SRC_PATH)/qemu-options.hx $(SRC_PATH)/scripts/hxtool diff --git a/docs/qemu-ga-ref.texi b/docs/qemu-ga-ref.texi index 87cc8d01a5..ddb76ce1c2 100644 --- a/docs/qemu-ga-ref.texi +++ b/docs/qemu-ga-ref.texi @@ -1,6 +1,8 @@ \input texinfo @setfilename qemu-ga-ref.info +@include version.texi + @exampleindent 0 @paragraphindent 0 diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi index 818e52573b..0a0056930a 100644 --- a/docs/qemu-qmp-ref.texi +++ b/docs/qemu-qmp-ref.texi @@ -1,6 +1,8 @@ \input texinfo @setfilename qemu-qmp-ref.info +@include version.texi + @exampleindent 0 @paragraphindent 0