public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH 0/1] docs: examples of pages affected by inline literal overflow
@ 2026-03-21 14:11 Rito Rhymes
  2026-03-21 14:11 ` [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
                   ` (2 more replies)
  0 siblings, 3 replies; 7+ messages in thread
From: Rito Rhymes @ 2026-03-21 14:11 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel, Rito Rhymes

Examples of affected pages on docs.kernel.org this patch improves:
  userspace-api/futex2.html
  userspace-api/seccomp_filter.html
  hid/intel-ish-hid.html
  hid/hid-bpf.html
  userspace-api/media/v4l/ext-ctrls-codec.html
  core-api/dma-api-howto.html
  security/IMA-templates.html
  virt/kvm/arm/hypercalls.html
  hwmon/hp-wmi-sensors.html
  bpf/map_devmap.html

Rito Rhymes (1):
  docs: allow inline literals in paragraphs to wrap to prevent overflow

 Documentation/sphinx-static/custom.css | 9 +++++++++
 1 file changed, 9 insertions(+)

-- 
2.51.0

^ permalink raw reply	[flat|nested] 7+ messages in thread

* [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow
  2026-03-21 14:11 [PATCH 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
@ 2026-03-21 14:11 ` Rito Rhymes
  2026-03-21 21:03   ` Randy Dunlap
  2026-03-22 18:32 ` [PATCH v2 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
  2026-03-23 15:14 ` [PATCH v3] " Rito Rhymes
  2 siblings, 1 reply; 7+ messages in thread
From: Rito Rhymes @ 2026-03-21 14:11 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel, Rito Rhymes

Some documentation pages contain long inline literals in paragraph
text that can force page-wide horizontal scroll overflow and break
layout on smaller screens.

Override the default `span.pre` white-space behavior for inline
literals and use `overflow-wrap: anywhere` so they can wrap when
needed. For code used as part of a paragraph, wrapping is appropriate
because it is stylistically part of the surrounding text. Code blocks,
by contrast, are meant to preserve formatting fidelity and are better
served by contained horizontal scrolling.

Signed-off-by: Rito Rhymes <rito@ritovision.com>
---
 Documentation/sphinx-static/custom.css | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index db24f4344..dd69df2a7 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -149,6 +149,15 @@ div.language-selection ul li:hover {
     background: #dddddd;
 }
 
+/*
+ * Let long inline literals in paragraph text wrap as needed to prevent
+ * overflow.
+ */
+code.docutils.literal span.pre {
+    white-space: normal;
+    overflow-wrap: anywhere;
+}
+
 /* Make xrefs more universally visible */
 a.reference, a.reference:hover {
     border-bottom: none;
-- 
2.51.0


^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow
  2026-03-21 14:11 ` [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
@ 2026-03-21 21:03   ` Randy Dunlap
  0 siblings, 0 replies; 7+ messages in thread
From: Randy Dunlap @ 2026-03-21 21:03 UTC (permalink / raw)
  To: Rito Rhymes, Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel



On 3/21/26 7:11 AM, Rito Rhymes wrote:
> Some documentation pages contain long inline literals in paragraph
> text that can force page-wide horizontal scroll overflow and break
> layout on smaller screens.
> 
> Override the default `span.pre` white-space behavior for inline
> literals and use `overflow-wrap: anywhere` so they can wrap when
> needed. For code used as part of a paragraph, wrapping is appropriate
> because it is stylistically part of the surrounding text. Code blocks,
> by contrast, are meant to preserve formatting fidelity and are better
> served by contained horizontal scrolling.
> 
> Signed-off-by: Rito Rhymes <rito@ritovision.com>

Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/sphinx-static/custom.css | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 

-- 
~Randy

^ permalink raw reply	[flat|nested] 7+ messages in thread

* [PATCH v2 0/1] docs: examples of pages affected by inline literal overflow
  2026-03-21 14:11 [PATCH 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
  2026-03-21 14:11 ` [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
@ 2026-03-22 18:32 ` Rito Rhymes
  2026-03-22 18:32   ` [PATCH v2 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
  2026-03-23 15:14 ` [PATCH v3] " Rito Rhymes
  2 siblings, 1 reply; 7+ messages in thread
From: Rito Rhymes @ 2026-03-22 18:32 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel, Rito Rhymes

Examples of affected pages on docs.kernel.org this patch improves:
  userspace-api/futex2.html
  userspace-api/seccomp_filter.html
  hid/intel-ish-hid.html
  hid/hid-bpf.html
  userspace-api/media/v4l/ext-ctrls-codec.html
  core-api/dma-api-howto.html
  security/IMA-templates.html
  virt/kvm/arm/hypercalls.html
  hwmon/hp-wmi-sensors.html
  bpf/map_devmap.html

Rito Rhymes (1):
  docs: allow inline literals in paragraphs to wrap to prevent overflow

 Documentation/sphinx-static/custom.css | 9 +++++++++
 1 file changed, 9 insertions(+)

-- 
2.51.0

^ permalink raw reply	[flat|nested] 7+ messages in thread

* [PATCH v2 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow
  2026-03-22 18:32 ` [PATCH v2 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
@ 2026-03-22 18:32   ` Rito Rhymes
  0 siblings, 0 replies; 7+ messages in thread
From: Rito Rhymes @ 2026-03-22 18:32 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel, Rito Rhymes

Some documentation pages contain long inline literals in paragraph
text that can force page-wide horizontal scroll overflow and break
layout on smaller screens.

Override the default `span.pre` white-space behavior for inline
literals and use `overflow-wrap: anywhere` so they can wrap when
needed. For code used as part of a paragraph, wrapping is appropriate
because it is stylistically part of the surrounding text. Code blocks,
by contrast, are meant to preserve formatting fidelity and are better
served by contained horizontal scrolling.

Signed-off-by: Rito Rhymes <rito@ritovision.com>
Assisted-by: Codex:GPT-5.4
---
v2: add Assisted-by attribution

 Documentation/sphinx-static/custom.css | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index db24f4344..dd69df2a7 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -149,6 +149,15 @@ div.language-selection ul li:hover {
     background: #dddddd;
 }
 
+/*
+ * Let long inline literals in paragraph text wrap as needed to prevent
+ * overflow.
+ */
+code.docutils.literal span.pre {
+    white-space: normal;
+    overflow-wrap: anywhere;
+}
+
 /* Make xrefs more universally visible */
 a.reference, a.reference:hover {
     border-bottom: none;
-- 
2.51.0

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [PATCH v3] docs: allow inline literals in paragraphs to wrap to prevent overflow
  2026-03-21 14:11 [PATCH 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
  2026-03-21 14:11 ` [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
  2026-03-22 18:32 ` [PATCH v2 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
@ 2026-03-23 15:14 ` Rito Rhymes
  2026-03-25 19:23   ` Jonathan Corbet
  2 siblings, 1 reply; 7+ messages in thread
From: Rito Rhymes @ 2026-03-23 15:14 UTC (permalink / raw)
  To: Jonathan Corbet, linux-doc; +Cc: Shuah Khan, linux-kernel, rdunlap, Rito Rhymes

Some documentation pages contain long inline literals in paragraph
text that can force page-wide horizontal scroll overflow and break
layout on smaller screens.

Override the default `span.pre` white-space behavior for inline
literals and use `overflow-wrap: anywhere` so they can wrap when
needed. For code used as part of a paragraph, wrapping is appropriate
because it is stylistically part of the surrounding text. Code blocks,
by contrast, are meant to preserve formatting fidelity and are better
served by contained horizontal scrolling.

Examples:
  https://docs.kernel.org/6.15/userspace-api/futex2.html
  https://docs.kernel.org/6.15/security/IMA-templates.html

Signed-off-by: Rito Rhymes <rito@ritovision.com>
Assisted-by: Codex:GPT-5.4
---
v3: add latest public versioned URL examples to the patchlog

 Documentation/sphinx-static/custom.css | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index db24f4344..dd69df2a7 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -149,6 +149,15 @@ div.language-selection ul li:hover {
     background: #dddddd;
 }
 
+/*
+ * Let long inline literals in paragraph text wrap as needed to prevent
+ * overflow.
+ */
+code.docutils.literal span.pre {
+    white-space: normal;
+    overflow-wrap: anywhere;
+}
+
 /* Make xrefs more universally visible */
 a.reference, a.reference:hover {
     border-bottom: none;
-- 
2.51.0

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH v3] docs: allow inline literals in paragraphs to wrap to prevent overflow
  2026-03-23 15:14 ` [PATCH v3] " Rito Rhymes
@ 2026-03-25 19:23   ` Jonathan Corbet
  0 siblings, 0 replies; 7+ messages in thread
From: Jonathan Corbet @ 2026-03-25 19:23 UTC (permalink / raw)
  To: Rito Rhymes, linux-doc; +Cc: Shuah Khan, linux-kernel, rdunlap, Rito Rhymes

Rito Rhymes <rito@ritovision.com> writes:

> Some documentation pages contain long inline literals in paragraph
> text that can force page-wide horizontal scroll overflow and break
> layout on smaller screens.
>
> Override the default `span.pre` white-space behavior for inline
> literals and use `overflow-wrap: anywhere` so they can wrap when
> needed. For code used as part of a paragraph, wrapping is appropriate
> because it is stylistically part of the surrounding text. Code blocks,
> by contrast, are meant to preserve formatting fidelity and are better
> served by contained horizontal scrolling.
>
> Examples:
>   https://docs.kernel.org/6.15/userspace-api/futex2.html
>   https://docs.kernel.org/6.15/security/IMA-templates.html
>
> Signed-off-by: Rito Rhymes <rito@ritovision.com>
> Assisted-by: Codex:GPT-5.4
> ---
> v3: add latest public versioned URL examples to the patchlog
>
>  Documentation/sphinx-static/custom.css | 9 +++++++++
>  1 file changed, 9 insertions(+)

I have applied this one as well.

Thanks,

jon

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2026-03-25 19:23 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-03-21 14:11 [PATCH 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
2026-03-21 14:11 ` [PATCH 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
2026-03-21 21:03   ` Randy Dunlap
2026-03-22 18:32 ` [PATCH v2 0/1] docs: examples of pages affected by inline literal overflow Rito Rhymes
2026-03-22 18:32   ` [PATCH v2 1/1] docs: allow inline literals in paragraphs to wrap to prevent overflow Rito Rhymes
2026-03-23 15:14 ` [PATCH v3] " Rito Rhymes
2026-03-25 19:23   ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox