linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Akira Yokosawa <akiyks@gmail.com>,
	Dongliang Mu <dzm91@hust.edu.cn>,
	Federico Vaga <federico.vaga@vaga.pv.it>,
	Randy Dunlap <rdunlap@infradead.org>,
	Yanteng Si <si.yanteng@linux.dev>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 04/19] scripts: sphinx-pre-install: move it to tools/docs
Date: Fri, 5 Sep 2025 09:39:08 +0200	[thread overview]
Message-ID: <20250905093908.12ac00d3@foz.lan> (raw)
In-Reply-To: <87ms7amanj.fsf@trenco.lwn.net>

Em Thu, 04 Sep 2025 10:42:56 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > As we're reorganizing the place where doc scripts are located,
> > move this one to tools/docs.
> >
> > No functional changes.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/Makefile                             | 14 +++++++-------
> >  Documentation/doc-guide/sphinx.rst                 |  4 ++--
> >  Documentation/sphinx/kerneldoc-preamble.sty        |  2 +-
> >  .../translations/it_IT/doc-guide/sphinx.rst        |  4 ++--
> >  .../translations/zh_CN/doc-guide/sphinx.rst        |  4 ++--
> >  Documentation/translations/zh_CN/how-to.rst        |  2 +-  
> 
> This one fails to apply to the translations - it looks like some sort of
> encoding problem...?

Yes. My new mailbomb script in Python mangled it.

I ended sending you a PR, as this way we know for sure that we won't
have any encoding issues on either side.

---

Checking encoding after the patch series:

    $ file Documentation/translations/zh_CN/how-to.rst
    Documentation/translations/zh_CN/how-to.rst: Unicode text, UTF-8 text

    $ python3
    Python 3.13.7 (main, Aug 14 2025, 00:00:00) [GCC 15.2.1 20250808 (Red Hat 15.2.1-1)] on linux
    Type "help", "copyright", "credits" or "license" for more information.
    >>> with open("Documentation/translations/zh_CN/how-to.rst", "r", encoding="utf-8") as fp: c=fp.read()
    ... 
   >>> 

And manually looking on its contents, the patch itself is OK.

Looking at the e-mail generated using Python EmailMessage class, however:   

    Content-Type: text/plain; charset="utf-8"
    MIME-Version: 1.0
    Content-Transfer-Encoding: 8bit

Python completely mangled it by replacing all UTF chars with �:

	--- a/Documentation/translations/zh_CN/doc-guide/sphinx.rst
	+++ b/Documentation/translations/zh_CN/doc-guide/sphinx.rst
	@@ -84,7 +84,7 @@ PDF���LaTeX������
	 ������������������������������������Sphinx������������������������������������������������������������������������
	 ������������������::
	 
	-	$ ./scripts/sphinx-pre-install
	+	$ ./tools/docs/sphinx-pre-install
	 	Checking if the needed tools for Fedora release 26 (Twenty Six) are available

When I have time, I'll try to fix it - or end giving up of the Python
version returning to the Perl one, even with the content set to
utf-8 at set_content() function call.

Thanks,
Mauro

  reply	other threads:[~2025-09-05  7:39 UTC|newest]

Thread overview: 67+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-04  7:33 [PATCH v4 00/19] Split sphinx call logic from docs Makefile Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 01/19] scripts/jobserver-exec: move the code to a class Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 02/19] scripts/jobserver-exec: move its class to the lib directory Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 03/19] scripts/jobserver-exec: add a help message Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 04/19] scripts: sphinx-pre-install: move it to tools/docs Mauro Carvalho Chehab
2025-09-04 16:42   ` Jonathan Corbet
2025-09-05  7:39     ` Mauro Carvalho Chehab [this message]
2025-09-05 12:25     ` Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 05/19] tools/docs: python_version: move version check from sphinx-pre-install Mauro Carvalho Chehab
2025-09-10 10:14   ` Jani Nikula
2025-09-10 12:24     ` Mauro Carvalho Chehab
2025-09-11 10:28       ` Jani Nikula
2025-09-11 10:45         ` Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 06/19] tools/docs: python_version: drop a debug print Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 07/19] tools/docs: python_version: allow check for alternatives and bail out Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 08/19] tools/docs: sphinx-build-wrapper: add a wrapper for sphinx-build Mauro Carvalho Chehab
2025-09-09 14:53   ` Jonathan Corbet
2025-09-09 15:59     ` Mauro Carvalho Chehab
2025-09-09 18:56       ` Jonathan Corbet
2025-09-09 20:53         ` Mauro Carvalho Chehab
2025-09-09 15:21   ` Jonathan Corbet
2025-09-09 16:06     ` Mauro Carvalho Chehab
2025-09-10 10:46   ` Jani Nikula
2025-09-10 12:59     ` Mauro Carvalho Chehab
2025-09-10 13:33       ` Mauro Carvalho Chehab
2025-09-12 10:15         ` Akira Yokosawa
2025-09-12 11:04           ` Mauro Carvalho Chehab
2025-09-12 14:03             ` Akira Yokosawa
2025-09-12 14:50               ` Mauro Carvalho Chehab
2025-09-15  8:27                 ` Akira Yokosawa
2025-09-15 10:58                   ` Mauro Carvalho Chehab
2025-09-15 12:54                     ` Jani Nikula
2025-09-15 13:50                       ` Mauro Carvalho Chehab
2025-09-15 14:33                         ` Jani Nikula
2025-09-15 15:05                           ` Mauro Carvalho Chehab
2025-09-11 10:23       ` Jani Nikula
2025-09-11 11:37         ` Mauro Carvalho Chehab
2025-09-11 13:38           ` Jonathan Corbet
2025-09-11 19:33             ` Jani Nikula
2025-09-11 19:47               ` Jonathan Corbet
2025-09-12  8:06                 ` Mauro Carvalho Chehab
2025-09-12 10:16                   ` Jani Nikula
2025-09-12 11:34                     ` Vegard Nossum
2025-09-13 10:18                       ` Mauro Carvalho Chehab
2025-09-12 11:41                     ` Mauro Carvalho Chehab
2025-09-12  8:28             ` Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 09/19] tools/docs: sphinx-build-wrapper: add comments and blank lines Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 10/19] tools/docs: sphinx-build-wrapper: add support to run inside venv Mauro Carvalho Chehab
2025-09-10 10:51   ` Jani Nikula
2025-09-12  8:46     ` Mauro Carvalho Chehab
2025-09-12  9:22       ` Jani Nikula
2025-09-12 12:34         ` Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 11/19] docs: parallel-wrapper.sh: remove script Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 12/19] docs: Makefile: document latex/PDF PAPER= parameter Mauro Carvalho Chehab
2025-09-10 10:54   ` Jani Nikula
2025-09-12  8:56     ` Mauro Carvalho Chehab
2025-09-12  9:23       ` Jani Nikula
2025-09-12 10:34         ` Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 13/19] tools/docs: sphinx-build-wrapper: add an argument for LaTeX interactive mode Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 14/19] tools/docs,scripts: sphinx-*: prevent sphinx-build crashes Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 15/19] tools/docs: sphinx-build-wrapper: allow building PDF files in parallel Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 16/19] docs: add support to build manpages from kerneldoc output Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 17/19] tools: kernel-doc: add a see also section at man pages Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 18/19] scripts: kdoc_parser.py: warn about Python version only once Mauro Carvalho Chehab
2025-09-04  7:33 ` [PATCH v4 19/19] tools/docs: sphinx-* break documentation bulds on openSUSE Mauro Carvalho Chehab
2025-09-05 16:07 ` [PATCH v4 00/19] Split sphinx call logic from docs Makefile Jonathan Corbet
2025-09-06  9:40   ` Mauro Carvalho Chehab

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=20250905093908.12ac00d3@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=federico.vaga@vaga.pv.it \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=si.yanteng@linux.dev \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).