From: Jonathan Corbet <corbet@lwn.net>
To: Matthew Wilcox <willy@infradead.org>
Cc: Nishanth Menon <nm@ti.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
bpf@vger.kernel.org,
Heinrich Schuchardt <heinrich.schuchardt@canonical.com>,
Mattijs Korpershoek <mkorpershoek@baylibre.com>,
Simon Glass <sjg@chromium.org>, Tom Rini <trini@konsulko.com>,
Neha Francis <n-francis@ti.com>
Subject: Re: [PATCH 1/2] Documentation: sphinx: Add sphinx-prompt
Date: Mon, 28 Aug 2023 09:12:07 -0600 [thread overview]
Message-ID: <87wmxf19rs.fsf@meer.lwn.net> (raw)
In-Reply-To: <ZOyqhL32tuiMlS23@casper.infradead.org>
Matthew Wilcox <willy@infradead.org> writes:
> On Mon, Aug 28, 2023 at 07:41:39AM -0600, Jonathan Corbet wrote:
>> I appreciate attempts to improve our documentation, and hope that you
>> will continue to do so. I am far from convinced, though, that this
>> change clears the bar for mainline inclusion.
>
> I'd ask that you reconsider. Looking at patch 2, I prefer what is
> written there. I don't think it adds cognitive load when reading the
> plain docs. I find the "copy and paste from html" argument not very
> convincing, but I do like "copy and paste from rst", which this enables.
Do you really think that the benefit from that justifies adding a build
dependency and breaking everybody's docs build until they install it? I
rather suspect I would hear back from people who feel otherwise if I did
that...
> I also have a certain fond memory of how the plan9 people set up 'rc'
> (their shell) so that ";" was both an empty statement, and the default
> prompt. So you could copy-paste lines starting with the ; prompt and
> they'd work. It's a small usabillity improvement, but it is there,
> and wow is it annoying when you don't have it any more.
Ah, OK, so what we really need is a bash patch :)
Thanks,
jon
next prev parent reply other threads:[~2023-08-28 15:13 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-24 18:21 [PATCH 0/2] Documentation: sphinx: Add sphinx-prompt Nishanth Menon
2023-08-24 18:21 ` [PATCH 1/2] " Nishanth Menon
2023-08-25 14:16 ` Daniel Borkmann
2023-08-25 22:46 ` Jonathan Corbet
2023-08-28 12:59 ` Nishanth Menon
2023-08-28 13:41 ` Jonathan Corbet
2023-08-28 13:51 ` Nishanth Menon
2023-08-28 14:09 ` Matthew Wilcox
2023-08-28 15:12 ` Jonathan Corbet [this message]
2023-08-28 17:25 ` Mauro Carvalho Chehab
2023-08-28 18:37 ` Jonathan Corbet
2023-08-24 18:21 ` [PATCH 2/2] Documentation: bpf: Use sphinx-prompt Nishanth Menon
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=87wmxf19rs.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=bpf@vger.kernel.org \
--cc=heinrich.schuchardt@canonical.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--cc=mkorpershoek@baylibre.com \
--cc=n-francis@ti.com \
--cc=nm@ti.com \
--cc=sjg@chromium.org \
--cc=trini@konsulko.com \
--cc=willy@infradead.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