Re: [Qemu-devel] [PULL 12/12] qemu-ga: Convert invocation documentation to rST

[Peter Maydell <peter.maydell@linaro.org>]

On Thu, 19 Sep 2019 at 14:54, Eric Blake <eblake@redhat.com> wrote:
>
> On 9/19/19 8:35 AM, Peter Maydell wrote:
> > On Thu, 19 Sep 2019 at 14:27, Eric Blake <eblake@redhat.com> wrote:
> >>
> >> On 9/19/19 7:00 AM, Peter Maydell wrote:
> >>
> >>>> In an incremental build on Fedora 30, I'm now seeing:
> >>>>
> >>>>         CHK version_gen.h
> >>>>   GEN     docs/interop/qemu-ga.8
> >>>> No filename or title
> >>>> make: *** [/home/eblake/qemu/rules.mak:394: docs/interop/qemu-ga.8]
> >>>> Error 255
> >>>>
> >>>> and suspect this patch introduced it.  It may be that I just need to
> >>>> nuke intermediate artifacts rather than an actual problem with the
> >>>> patch, but I'd welcome help in identifying the problem.
> >>>
> >>> If you build with V=1 what does it say it's doing?
> >>
> >> make[1]: Leaving directory '/home/eblake/qemu/dtc'
> >> perl -Ww -- /home/eblake/qemu/scripts/texi2pod.pl -I docs -I scripts -I
> >> docs/interop -DVERSION="4.1.50" -DCONFDIR="/usr/local/etc/qemu"
> >> scripts/texi2pod.pl docs/interop/qemu-ga.8.pod && pod2man --utf8
> >> --section=8 --center=" " --release=" " docs/interop/qemu-ga.8.pod >
> >> docs/interop/qemu-ga.8
> >> No filename or title
> >> make: *** [/home/eblake/qemu/rules.mak:394: docs/interop/qemu-ga.8]
> >> Error 255
> >
> > Do you have sphinx installed on this machine?
>
> Not yet.
>
> /me goes and installs sphinx-2.2.11-12.fc30.x86_64
>
> Nope, problem is still happening even after rerunning ./configure

Alex looked at this and suggests the problem is probably because
you're doing an in-tree build. Sphinx insists that it can't build
output files into the source tree, so we have a thing where we
set MANUAL_BUILDDIR to docs/built if we're doing an in-tree build.
But the filename we add to DOCS is just "docs/interop/qemu-ga.8"
so for an in-tree build the sphinx rule won't match it, and
the install rune won't find it either.

If that's the cause I think this untested fix should help:

diff --git a/Makefile b/Makefile
index 111082ce545..8d9dcb3aa4a 100644
--- a/Makefile
+++ b/Makefile
@@ -325,7 +325,7 @@ endif
 endif

 ifdef BUILD_DOCS
-DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8
docs/interop/qemu-ga.8
+DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8
$(MANUAL_BUILDDIR)/interop/qemu-ga.8
 DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt
docs/interop/qemu-qmp-ref.7
 DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt
docs/interop/qemu-ga-ref.7
 DOCS+=docs/qemu-block-drivers.7
@@ -819,7 +819,7 @@ ifdef CONFIG_TRACE_SYSTEMTAP
        $(INSTALL_DATA) scripts/qemu-trace-stap.1 "$(DESTDIR)$(mandir)/man1"
 endif
 ifneq (,$(findstring qemu-ga,$(TOOLS)))
-       $(INSTALL_DATA) docs/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
+       $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8
"$(DESTDIR)$(mandir)/man8"
        $(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)"
        $(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)"
        $(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"


thanks
-- PMM