All of lore.kernel.org
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Maciej W. Rozycki" <macro@orcam.me.uk>,
	Miguel Ojeda <ojeda@kernel.org>,
	linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 1/5] docs/doc-guide: Add footnote on Inkscape for better images in PDF documents
Date: Thu, 9 Jun 2022 22:23:27 +0900	[thread overview]
Message-ID: <81cddbde-bc28-bec1-fca4-3c8fe2df502f@gmail.com> (raw)
In-Reply-To: <dccb5233-7f4f-1be6-d1f4-bbe9f42f88e0@gmail.com>

With kernel releases v5.18 and later, if you have Inkscape, images
embedded in PDF documents are of vector graphics, not the raster
images as are the case with pre-v5.18 releases.
Even with pre-5.18 releases, having Inkscape would improve images
converted from some of SVG files which are not fully covered by the
limited capability of rsvg-convert(1) [1].

Add a footnote mentioning the expected improvements of such images.

Link: https://gitlab.gnome.org/GNOME/librsvg#non-goals-of-librsvg [1]
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
 Documentation/doc-guide/sphinx.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
index 2ff1ab4158d4..edc4fa023986 100644
--- a/Documentation/doc-guide/sphinx.rst
+++ b/Documentation/doc-guide/sphinx.rst
@@ -132,7 +132,8 @@ format-specific subdirectories under ``Documentation/output``.
 To generate documentation, Sphinx (``sphinx-build``) must obviously be
 installed. For prettier HTML output, the Read the Docs Sphinx theme
 (``sphinx_rtd_theme``) is used if available. For PDF output you'll also need
-``XeLaTeX`` and ``convert(1)`` from ImageMagick (https://www.imagemagick.org).
+``XeLaTeX`` and ``convert(1)`` from ImageMagick
+(https://www.imagemagick.org).\ [#ink]_
 All of these are widely available and packaged in distributions.
 
 To pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make
@@ -152,6 +153,10 @@ The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
 
 To remove the generated documentation, run ``make cleandocs``.
 
+.. [#ink] Having ``inkscape(1)`` from Inkscape (https://inkscape.org)
+	  as well would improve the quality of images embedded in PDF
+	  documents, especially for kernel releases 5.18 and later.
+
 Writing Documentation
 =====================
 
-- 
2.25.1



  reply	other threads:[~2022-06-09 13:23 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-09 13:21 [PATCH 0/5] docs/doc-guide: Sphinx related updates Akira Yokosawa
2022-06-09 13:23 ` Akira Yokosawa [this message]
2022-06-09 13:24 ` [PATCH 2/5] docs/doc-guide: Mention make variable SPHINXDIRS Akira Yokosawa
2022-06-09 15:26   ` Jonathan Corbet
2022-06-10  1:58     ` Akira Yokosawa
2022-06-09 13:26 ` [RFC PATCH 3/5] docs/doc-guide: Update guidelines for title adornments Akira Yokosawa
2022-06-10  9:11   ` Jani Nikula
2022-06-10 16:08     ` Miguel Ojeda
2022-06-11  3:15       ` Akira Yokosawa
2022-06-11 23:25         ` Mauro Carvalho Chehab
2022-06-09 13:27 ` [RFC PATCH 4/5] docs/doc-guide: Pull guidelines for title adornments out into subsection Akira Yokosawa
2022-06-09 13:28 ` [PATCH 5/5] docs/doc-guide: Put meta title for kernel-doc HTML page Akira Yokosawa
2022-06-10 16:50 ` [PATCH 0/5] docs/doc-guide: Sphinx related updates Miguel Ojeda
2022-06-24 19:59 ` Jonathan Corbet
2022-06-24 21:48   ` Akira Yokosawa

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=81cddbde-bc28-bec1-fca4-3c8fe2df502f@gmail.com \
    --to=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=macro@orcam.me.uk \
    --cc=mchehab@kernel.org \
    --cc=ojeda@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.