Re: [Qemu-devel] [PATCH for-2.9 07/47] qapi: Clean up build of generated documentation

[Markus Armbruster]

Eric Blake <address@hidden> writes:

> On 03/13/2017 01:18 AM, Markus Armbruster wrote:
>> Rename intermediate qemu-qapi.texi to qemu-qmp-qapi.texi to match its
>> user qemu-qmp-ref.texi, just like qemu-ga-qapi.texi matches
>> qemu-ga-ref.texi.
>> 
>> Build the intermediate .texi next to the sources and the final output
>> in docs/ instead of dumping them into the build root.
>> 
>> Fix version.texi dependencies so that only the targets that actually
>> need it depend on it.
>> 
>> Signed-off-by: Markus Armbruster <address@hidden>
>> ---
>>  .gitignore             | 10 +++++-----
>>  Makefile               | 27 +++++++++++++++------------
>>  docs/qemu-qmp-ref.texi |  2 +-
>>  rules.mak              |  2 +-
>>  4 files changed, 22 insertions(+), 19 deletions(-)
>> 
>> diff --git a/.gitignore b/.gitignore
>> index 2849d75..0e99e6a 100644
>> --- a/.gitignore
>> +++ b/.gitignore
>> @@ -103,11 +103,11 @@
>>  /docs/qemu-ga-ref.txt
>
> [1]
>
>>  /docs/qemu-qmp-ref.html
>>  /docs/qemu-qmp-ref.txt
>> -docs/qemu-ga-ref.info*
>> -docs/qemu-qmp-ref.info*
>> -/qemu-ga-qapi.texi
>> -/qemu-qapi.texi
>> -/version.texi
>> +/docs/qemu-ga-ref.info*
>
> worth sorting this line up by [1]?

Fine with me, except I think we should either not mess with the order,
or go all the way, i.e. ...

>> +/docs/qemu-qmp-ref.info*
>> +/docs/qemu-ga-qapi.texi

... move this one, too.  Feeding to sort leads to this incremental
patch:

@@ -99,14 +99,14 @@
 /pc-bios/optionrom/kvmvapic.img
 /pc-bios/s390-ccw/s390-ccw.elf
 /pc-bios/s390-ccw/s390-ccw.img
+/docs/qemu-ga-qapi.texi
 /docs/qemu-ga-ref.html
+/docs/qemu-ga-ref.info*
 /docs/qemu-ga-ref.txt
+/docs/qemu-qmp-qapi.texi
 /docs/qemu-qmp-ref.html
-/docs/qemu-qmp-ref.txt
-/docs/qemu-ga-ref.info*
 /docs/qemu-qmp-ref.info*
-/docs/qemu-ga-qapi.texi
-/docs/qemu-qmp-qapi.texi
+/docs/qemu-qmp-ref.txt
 /docs/version.texi
 *.tps
 .stgit-*

>> +/docs/qemu-qmp-qapi.texi
>> +/docs/version.texi
>>  *.tps
>>  .stgit-*
>>  cscope.*
>> @@ -663,25 +663,28 @@ ui/console-gl.o: $(SRC_PATH)/ui/console-gl.c \
>>  
>>  # documentation
>>  MAKEINFO=makeinfo
>> -MAKEINFOFLAGS=--no-split --number-sections
>> +MAKEINFOFLAGS=--no-split --number-sections -I docs
>
> Will this cause grief on any older makinfo versions (such as RHEL 6)?  I
> didn't test myself on those setups.  I guess if a buildbot doesn't flag
> you, it's okay.

RHEL-6 has texinfo 4.13, and its manual page documents -I.  No mention
in NEWS, which goes back to 2.2.

> The sorting issue is worth fixing, but trivial, so you can add:
>
> Reviewed-by: Eric Blake <address@hidden>

Thanks!