2022-03-26 18:50:42

by Akira Yokosawa

Subject: [PATCH] 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: 8ccd05697a9d ("docs: sphinx/kfigure.py: Use inkscape(1) for SVG -> PDF conversion")
Signed-off-by: Akira Yokosawa <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Mauro Carvalho Chehab <[email protected]>
Cc: [email protected]
---
Documentation/sphinx/kfigure.py | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/sphinx/kfigure.py b/Documentation/sphinx/kfigure.py
index 24d2b2addcce..cefdbb7e7523 100644
--- a/Documentation/sphinx/kfigure.py
+++ b/Documentation/sphinx/kfigure.py
@@ -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')

base-commit: 8d6451b9a51b555be2c9a6c326a980b2de00741a
--
2.25.1

2022-03-28 13:21:35

by Mauro Carvalho Chehab

Subject: Re: [PATCH] docs: kfigure.py: Don't warn of missing PDF converter in 'make htmldocs'

Em Sat, 26 Mar 2022 16:48:39 +0900
Akira Yokosawa <[email protected]> escreveu:

> 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: 8ccd05697a9d ("docs: sphinx/kfigure.py: Use inkscape(1) for SVG -> PDF conversion")
> Signed-off-by: Akira Yokosawa <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: Mauro Carvalho Chehab <[email protected]>
> Cc: [email protected]

Makes sense to me.

Acked-by: Mauro Carvalho Chehab <[email protected]>

> ---
> Documentation/sphinx/kfigure.py | 8 +++++---
> 1 file changed, 5 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/sphinx/kfigure.py b/Documentation/sphinx/kfigure.py
> index 24d2b2addcce..cefdbb7e7523 100644
> --- a/Documentation/sphinx/kfigure.py
> +++ b/Documentation/sphinx/kfigure.py
> @@ -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')
>
> base-commit: 8d6451b9a51b555be2c9a6c326a980b2de00741a



Thanks,
Mauro

2022-03-28 21:04:42

by Jonathan Corbet

Subject: Re: [PATCH] docs: kfigure.py: Don't warn of missing PDF converter in 'make htmldocs'

Akira Yokosawa <[email protected]> writes:

> 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: 8ccd05697a9d ("docs: sphinx/kfigure.py: Use inkscape(1) for SVG -> PDF conversion")
> Signed-off-by: Akira Yokosawa <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: Mauro Carvalho Chehab <[email protected]>
> Cc: [email protected]
> ---
> Documentation/sphinx/kfigure.py | 8 +++++---
> 1 file changed, 5 insertions(+), 3 deletions(-)

Applied, thanks.

jon