Commit d987d5ae authored by Akira Yokosawa's avatar Akira Yokosawa Committed by Jonathan Corbet
Browse files

docs: kfigure.py: Don't warn of missing PDF converter in 'make htmldocs' 



SVG -> PDF conversion is not required in "make htmldocs".
It is pointless to always warn of a missing converter.
Demote the log message in setupTools() to verbose.

For "make pdfdocs" (or "make latexdocs"), promote the dynamic
message of "include SVG raw" to a warn.
Expand the message and recommend installing Inkscape or
ImageMagick.

Fixes: 8ccd0569 ("docs: sphinx/kfigure.py: Use inkscape(1) for SVG -> PDF conversion")
Signed-off-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org
Acked-by: default avatarMauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/c80e1481-10d4-7151-fe59-e846259eb0d4@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 8d6451b9

Documentation/sphinx/kfigure.py

+5 −3
Original line number Diff line number Diff line
@@ -212,7 +212,7 @@ def setupTools(app): 
        if convert_cmd:

            kernellog.verbose(app, "use convert(1) from: " + convert_cmd)

        else:

            kernellog.warn(app,

            kernellog.verbose(app,

                "Neither inkscape(1) nor convert(1) found.\n"

                "For SVG to PDF conversion, "

                "install either Inkscape (https://inkscape.org/) (preferred) or\n"
@@ -296,8 +296,10 @@ def convert_image(img_node, translator, src_fname=None): 


        if translator.builder.format == 'latex':

            if not inkscape_cmd and convert_cmd is None:

                kernellog.verbose(app,

                                  "no SVG to PDF conversion available / include SVG raw.")

                kernellog.warn(app,

                                  "no SVG to PDF conversion available / include SVG raw."

                                  "\nIncluding large raw SVGs can cause xelatex error."

                                  "\nInstall Inkscape (preferred) or ImageMagick.")

                img_node.replace_self(file2literal(src_fname))

            else:

                dst_fname = path.join(translator.builder.outdir, fname + '.pdf')