summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRito Rhymes <rito@ritovision.com>2026-03-23 11:33:42 -0400
committerJonathan Corbet <corbet@lwn.net>2026-03-25 13:17:13 -0600
commit3aff388bc4e8d64583d144f3be9c0aff9a54f14d (patch)
tree1410c31418ed479b61ce3a43692376e9fe10c5d3
parentf2679ac773899f5fdea0b68d5077eef5f88dfd42 (diff)
downloadlinux-3aff388bc4e8d64583d144f3be9c0aff9a54f14d.tar.gz
linux-3aff388bc4e8d64583d144f3be9c0aff9a54f14d.zip
docs: contain horizontal overflow in C API descriptions
Some documentation pages contain long C API signatures that can exceed the content width and cause page-wide horizontal scroll overflow. Apply contained horizontal scrolling to C API description blocks and keep their signature rows on one line. This preserves signature formatting while preventing them from breaking page layout. Contained horizontal scrolling is preferred over wrapping here because code fidelity is the priority. These blocks are intended to remain representative of the code itself. Wrapping distorts spacing and line structure, which affects fidelity, creates misleading renderings, and reduces readability. Examples: https://docs.kernel.org/6.15/driver-api/regulator.html https://docs.kernel.org/6.15/userspace-api/fwctl/fwctl-cxl.html Signed-off-by: Rito Rhymes <rito@ritovision.com> Assisted-by: Codex:GPT-5.4 Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260323153342.33447-1-rito@ritovision.com>
-rw-r--r--Documentation/sphinx-static/custom.css7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index dd69df2a7f57..72e08782dd05 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -40,6 +40,13 @@ li { text-indent: 0em; }
dl.function, dl.struct, dl.enum { margin-top: 2em; background-color: #ecf0f3; }
/* indent lines 2+ of multi-line function prototypes */
dl.function dt { margin-left: 10em; text-indent: -10em; }
+/*
+ * Preserve C API signatures on one line and apply contained horizontal
+ * scrolling to prevent them from exceeding their container width and
+ * breaking page layout.
+ */
+dl.c { overflow-x: auto; overflow-y: hidden; }
+dl.c > dt.sig.sig-object { white-space: nowrap; }
dt.sig-object { font-size: larger; }
div.kernelindent { margin-left: 2em; margin-right: 4em; }