[Bug jit/102824] New: building pdf/dvi documentation for libgccjit fails on darwin

[Bug jit/102824] New: building pdf/dvi documentation for libgccjit fails on darwin

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

            Bug ID: 102824
           Summary: building pdf/dvi documentation for libgccjit fails on
                    darwin
           Product: gcc
           Version: 12.0
            Status: UNCONFIRMED
          Keywords: documentation
          Severity: normal
          Priority: P3
         Component: jit
          Assignee: dmalcolm at gcc dot gnu.org
          Reporter: egallager at gcc dot gnu.org
                CC: iains at gcc dot gnu.org
  Target Milestone: ---
             Build: darwin

Running `make pdf` fails in gcc/jit for me with the following error:

!pdfTeX error: pdfetex: cannot find image file libgccjit-figures/sum-of-squares
1.
 ==> Fatal error occurred, no output PDF file produced!
/opt/iains/x86_64-apple-darwin19/gcc-7-5-toolchain/bin/texi2dvi: pdfetex exited
with bad status, quitting.
make[2]: *** [../../gcc/jit/Make-lang.in:283: doc/libgccjit.pdf] Error 1
make[2]: Leaving directory
'/Users/ericgallager/gcc_newgit/abcdefghijklmnopqrstuvwxyz_01234567890.build/gcc'
make[1]: *** [Makefile:5361: pdf-gcc] Error 1
make[1]: Leaving directory
'/Users/ericgallager/gcc_newgit/abcdefghijklmnopqrstuvwxyz_01234567890.build'
make: *** [Makefile:1280: do-pdf] Error 2

I also got a similar error with `make dvi`, the full log for which can be found
here:
https://github.com/cooljeanius/gcc_bugs/blob/master/doc_logs/libgccjit.log

(I originally reported this on IRC while testing a patch for bug 102663)

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[iains at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

Iain Sandoe <iains at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|UNCONFIRMED                 |NEW
   Last reconfirmed|                            |2021-10-19
            Summary|building pdf/dvi            |building pdf/dvi
                   |documentation for libgccjit |documentation for libgccjit
                   |fails on darwin             |fails
     Ever confirmed|0                           |1
              Build|darwin                      |darwin, linux

--- Comment #1 from Iain Sandoe <iains at gcc dot gnu.org> ---


On linux the make html target succeeds - but it seems to run sphinx - is that
now a prerequisite? (running make dvi after make html did not seem to make any
difference)

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[dmalcolm at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #2 from David Malcolm <dmalcolm at gcc dot gnu.org> ---
make pdf is looking for the images in:
  gcc/jit/docs/_build/texinfo/libgccjit-figures
but they're in the source tree in:
  gcc/jit/docs/_build/texinfo

I just tried:
  git mv gcc/jit/docs/_build/texinfo/*.png
gcc/jit/docs/_build/texinfo/libgccjit-figures

and it seems to fix the "make pdf" for me.

Will test a bit more.

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[cvs-commit at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #3 from CVS Commits <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by David Malcolm <dmalcolm@gcc.gnu.org>:

https://gcc.gnu.org/g:790e9814454662b6cd51d2fce1aa022ef73fedb8

commit r12-8031-g790e9814454662b6cd51d2fce1aa022ef73fedb8
Author: David Malcolm <dmalcolm@redhat.com>
Date:   Wed Apr 6 16:20:10 2022 -0400

    jit: fix location of .png files for "make jit.pdf" [PR102824]

    "make jit.pdf" seems to be looking in
      gcc/jit/docs/_build/texinfo/libgccjit-figures
    for the .png files, but they were in the source tree in:
      gcc/jit/docs/_build/texinfo

    Fix "make jit.pdf" via:
      git mv \
        gcc/jit/docs/_build/texinfo/*.png \
        gcc/jit/docs/_build/texinfo/libgccjit-figures

    gcc/jit/ChangeLog:
            PR jit/102824
            * docs/_build/texinfo/factorial.png: Move to...
            * docs/_build/texinfo/libgccjit-figures/factorial.png: ...here.
            * docs/_build/texinfo/factorial1.png: Move to...
            * docs/_build/texinfo/libgccjit-figures/factorial1.png: ...here.
            * docs/_build/texinfo/sum-of-squares.png: Move to...
            * docs/_build/texinfo/libgccjit-figures/sum-of-squares.png:
...here.
            * docs/_build/texinfo/sum-of-squares1.png: Move to...
            * docs/_build/texinfo/libgccjit-figures/sum-of-squares1.png:
...here.

    Signed-off-by: David Malcolm <dmalcolm@redhat.com>

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[dmalcolm at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #4 from David Malcolm <dmalcolm at gcc dot gnu.org> ---
As noted in https://gcc.gnu.org/pipermail/gcc-patches/2022-April/592889.html
the above patch seems to fix "make jit.pdf", but doesn't fix "make jit.dvi"; it
seems to be looking for .eps files for the images.

I last used TeX roughly 3 decades ago, so help fixing this would be welcome :)

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #5 from Eric Gallager <egallager at gcc dot gnu.org> ---
(In reply to David Malcolm from comment #4)
> As noted in https://gcc.gnu.org/pipermail/gcc-patches/2022-April/592889.html
> the above patch seems to fix "make jit.pdf", but doesn't fix "make jit.dvi";
> it seems to be looking for .eps files for the images.
> 
> I last used TeX roughly 3 decades ago, so help fixing this would be welcome
> :)

yeah I'm not much of a TeX user myself, so... well, who around here *does*
understand TeX?

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #6 from Eric Gallager <egallager at gcc dot gnu.org> ---
@marxin is this something you checked during the sphinx conversion and
reversion at all?

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[marxin at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

Martin Liška <marxin at gcc dot gnu.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |WAITING

--- Comment #7 from Martin Liška <marxin at gcc dot gnu.org> ---
Well, running 'make latexpdf' works if you jump into gcc/jit/docs folder. Do I
miss something?

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[iains at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #8 from Iain Sandoe <iains at gcc dot gnu.org> ---
(In reply to Eric Gallager from comment #6)
> @marxin is this something you checked during the sphinx conversion and
> reversion at all?

(In reply to Martin Liška from comment #7)
> Well, running 'make latexpdf' works if you jump into gcc/jit/docs folder. Do
> I miss something?

last time I checked 'make dvi ' it was hanging in libgccjit ('make pdf' is OK -
but in-tree gmp fails there).

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #9 from Eric Gallager <egallager at gcc dot gnu.org> ---
I've been testing this on the compile farm, and there seems to be a wide amount
of variation between machines with regards to whether this fails or not; I
think it might have to do with different machines having different sphinx
versions... I'm wondering if the minimum sphinx version documented to work in
https://gcc.gnu.org/install/prerequisites.html needs to be updated?

--- Comment #10 from Eric Gallager <egallager at gcc dot gnu.org> ---
I've been testing this on the compile farm, and there seems to be a wide amount
of variation between machines with regards to whether this fails or not; I
think it might have to do with different machines having different sphinx
versions... I'm wondering if the minimum sphinx version documented to work in
https://gcc.gnu.org/install/prerequisites.html needs to be updated?

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #11 from Eric Gallager <egallager at gcc dot gnu.org> ---
I'm wondering if it'd be possible to insert a line like:

\batchmode

into the tex files? 
Ref:
https://tex.stackexchange.com/questions/25267/what-reasons-if-any-are-there-for-compiling-in-interactive-mode

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[iains at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #12 from Iain Sandoe <iains at gcc dot gnu.org> ---
what input is this waiting for at the moment?

[Bug jit/102824] building pdf/dvi documentation for libgccjit fails

[egallager at gcc dot gnu.org]

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102824

--- Comment #13 from Eric Gallager <egallager at gcc dot gnu.org> ---
(In reply to Iain Sandoe from comment #12)
> what input is this waiting for at the moment?

From checking the bug history, it looks like Martin Liška was the one to put
this in the WAITING status, which came along with this comment:

(In reply to Martin Liška from comment #7)
> Well, running 'make latexpdf' works if you jump into gcc/jit/docs folder. Do
> I miss something?

...which I thought we'd answered, but to make it a bit more clear: we shouldn't
have to do that to get the jit docs to build properly. They should build
properly when doing `make dvi` and/or `make pdf` from the top-level, rather
than requiring their own special procedures.