linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: mchehab+huawei@kernel.org
Cc: bigeasy@linutronix.de, corbet@lwn.net, jiangshanlai@gmail.com,
	joel@joelfernandes.org, josh@joshtriplett.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	mathieu.desnoyers@efficios.com, nfraprado@protonmail.com,
	paulmck@kernel.org, rcu@vger.kernel.org, rdunlap@infradead.org,
	rostedt@goodmis.org, tiwai@suse.de, will@kernel.org,
	Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v3 16/16] docs: RCU: replace some characters
Date: Mon, 17 May 2021 19:53:00 +0900	[thread overview]
Message-ID: <57bb2653-8754-707f-6d54-9a64dccd3c50@gmail.com> (raw)
In-Reply-To: <909f3108e85895828bf3633f183e8f364cb4d752.1621159997.git.mchehab+huawei@kernel.org>

On Sun, 16 May 2021 12:18:33 +0200, Mauro Carvalho Chehab wrote:
> The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
> conversion and some cut-and-pasted text contain some characters that
> aren't easily reachable on standard keyboards and/or could cause
> troubles when parsed by the documentation build system.
> 
> Replace the occurences of the following characters:
> 
> 	- U+00a0 (' '): NO-BREAK SPACE
> 	  as it can cause lines being truncated on PDF output

These NO-BREAK SPACEs originate from "&nbsp;"s in html docs converted by
commit ccc9971e2147 ("docs: rcu: convert some articles from html to ReST").

I think the patterns found in these files ("~" denotes NO-BREAK SPACE):

    CPU~0
    Tasks~T1, T2, and~T3
    line~n
    lines~m and~n
    ...

are quite appropriate and nice-to-have contextual markers.

Despite the claim above, I don't believe these NO-BREAK SPACEs can cause
any truncation in the PDF output, because they combine short numbers or
symbols with terms such as "CPU", "Task", and "line". 

So I'd like you all to keep these NO-BREAK SPACEs.

If there ever emerges such truncations, they can be taken care of
case-by-case bases.

        Thanks, Akira

> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  .../Data-Structures/Data-Structures.rst       | 46 ++++++------
>  .../Expedited-Grace-Periods.rst               | 36 +++++-----
>  .../Tree-RCU-Memory-Ordering.rst              |  2 +-
>  .../RCU/Design/Requirements/Requirements.rst  | 70 +++++++++----------
>  4 files changed, 77 insertions(+), 77 deletions(-)


  reply	other threads:[~2021-05-17 10:53 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-16 10:18 [PATCH v3 00/16] Replace some bad characters on documents Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 01/16] docs: hwmon: ir36021.rst: replace some characters Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 02/16] docs: admin-guide: reporting-issues.rst: " Mauro Carvalho Chehab
2021-05-16 10:28   ` Thorsten Leemhuis
2021-05-16 11:13     ` Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 03/16] docs: trace: coresight: coresight-etm4x-reference.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 04/16] docs: driver-api: ioctl.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 05/16] docs: driver-api: media: drivers: zoran.rst: " Mauro Carvalho Chehab
2021-05-16 18:32   ` LABBE Corentin
2021-05-16 10:18 ` [PATCH v3 06/16] docs: usb: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 07/16] docs: userspace-api: media: v4l: dev-decoder.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 08/16] docs: userspace-api: media: dvb: intro.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 09/16] docs: vm: zswap.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 10/16] docs: filesystems: ext4: blockgroup.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 11/16] docs: networking: device_drivers: " Mauro Carvalho Chehab
2021-05-17 16:11   ` Jesse Brandeburg
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: " Mauro Carvalho Chehab
2021-05-19 21:47   ` Bjorn Helgaas
2021-06-16  6:51     ` Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 13/16] docs: sound: kernel-api: writing-an-alsa-driver.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 14/16] docs: firmware-guide: acpi: dsd: graph.rst: " Mauro Carvalho Chehab
2021-05-17 14:20   ` Rafael J. Wysocki
2021-05-16 10:18 ` [PATCH v3 15/16] docs: virt: kvm: api.rst: " Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 16/16] docs: RCU: " Mauro Carvalho Chehab
2021-05-17 10:53   ` Akira Yokosawa [this message]
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
2021-05-17 11:24   ` 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=57bb2653-8754-707f-6d54-9a64dccd3c50@gmail.com \
    --to=akiyks@gmail.com \
    --cc=bigeasy@linutronix.de \
    --cc=corbet@lwn.net \
    --cc=jiangshanlai@gmail.com \
    --cc=joel@joelfernandes.org \
    --cc=josh@joshtriplett.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mchehab+huawei@kernel.org \
    --cc=nfraprado@protonmail.com \
    --cc=paulmck@kernel.org \
    --cc=rcu@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=tiwai@suse.de \
    --cc=will@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 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).