From: "Rito Rhymes" <rito@ritovision.com>
To: "Jonathan Corbet" <corbet@lwn.net>,
"Rito Rhymes" <rito@ritovision.com>, <linux-doc@vger.kernel.org>
Cc: "Shuah Khan" <skhan@linuxfoundation.org>,
<linux-kernel@vger.kernel.org>, <rdunlap@infradead.org>
Subject: Re: [PATCH v3] docs: contain horizontal overflow in C API descriptions
Date: Thu, 26 Mar 2026 15:10:56 -0400 [thread overview]
Message-ID: <DHCY9W9YCEO3.VIOD40U407AC@ritovision.com> (raw)
In-Reply-To: <87jyuzehmi.fsf@trenco.lwn.net>
> It should wrap so that the entire prototype is visible, but the
> way that happens on small screens is definitely ugly. The trick
> would be to have it wrap the way it would for an overly long line
> in the source.
I re-rolled it again to match those specs.
FWIW:
I tackled basically the same issue in Public Inbox; Eric wanted
it the way you described, but he was married to his highly efficent
custom blob rendering system where the approach caused regressions
with no reasonable workaround. And no alternative systems I tried
came close to his system's efficiency even though they fixed the
issue. At the end of the day, page-wide horizontal scroll overflow
turned out to be the best fit solution there.
I think the preserved whitespace wrapping approach should work fine
here though.
I rerolled so you can choose whichever you think is best, though
personally, I think contained horizontal scroll overflow is the
way to go since it provides a more straight-forward awareness of
the code shape without needing to be aware of wrapping distortions.
I leave it to you.
Rito
next prev parent reply other threads:[~2026-03-26 19:11 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-21 14:25 [PATCH 0/1] docs: examples of pages affected by C API signature overflow Rito Rhymes
2026-03-21 14:25 ` [PATCH 1/1] docs: contain horizontal overflow in C API descriptions Rito Rhymes
2026-03-21 21:12 ` Randy Dunlap
2026-03-22 19:37 ` [PATCH v2 0/1] docs: examples of pages affected by C API signature overflow Rito Rhymes
2026-03-22 19:37 ` [PATCH v2 1/1] docs: contain horizontal overflow in C API descriptions Rito Rhymes
2026-03-22 20:35 ` [PATCH v2 0/1] docs: examples of pages affected by C API signature overflow Jonathan Corbet
2026-03-23 9:57 ` Rito Rhymes
2026-03-23 13:42 ` Jonathan Corbet
2026-03-23 15:33 ` [PATCH v3] docs: contain horizontal overflow in C API descriptions Rito Rhymes
2026-03-25 19:00 ` Jonathan Corbet
2026-03-25 20:50 ` Rito Rhymes
2026-03-25 21:14 ` Jonathan Corbet
2026-03-26 19:10 ` Rito Rhymes [this message]
2026-03-26 18:43 ` [PATCH v4] docs: wrap long C API signatures to prevent page overflow Rito Rhymes
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=DHCY9W9YCEO3.VIOD40U407AC@ritovision.com \
--to=rito@ritovision.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.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