mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Matthew Wilcox <willy@infradead.org>
Cc: Osman Ahmadzai <osmanahmadxai@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	nathan@kernel.org, nsc@kernel.org, apw@canonical.com,
	joe@perches.com, tglx@kernel.org, gregkh@linuxfoundation.org,
	linux-kbuild@vger.kernel.org, linux-spdx@vger.kernel.org
Subject: Re: [PATCH v2] README: rename to README.rst and make the doc references links
Date: Mon, 21 Sep 2026 13:14:11 -0700	[thread overview]
Message-ID: <4acccfc3-d934-46fd-88b5-e5660dd0ce65@infradead.org> (raw)
In-Reply-To: <arGHSsj96C3C3C4x@casper.infradead.org>



On 9/21/26 12:36 PM, Matthew Wilcox wrote:
> On Mon, Sep 21, 2026 at 12:24:08PM -0700, Randy Dunlap wrote:
>> Hi,
>>
>> On 9/21/26 12:05 AM, Osman Ahmadzai wrote:
>>> The README points at some sixty files in the tree, but it has no
>>> extension, so it shows up as plain text and none of those paths can be
>>> followed.  You have to go and find each one by hand.
>>>
>>> The content has always been reStructuredText - it uses reST section
>>> syntax for its headings - so give it the extension to match, and wrap
>>> each in-tree reference in an anonymous hyperlink whose link text is the
>>> path itself.  The rendered text is byte-for-byte what it was before; only
>>
>> What causes README.rst to be rendered? Is it named README.html?
>> I don't see it being rendered on a clean 'make htmldocs' build.
> 
> I believe this is some github thing.

Oh, that makes some sense (although they generally use markdown).

> There's something very strange about the diff being sent.  For some
> reason it shows as a delete + create rather than as a rename + changes.
> That makes it hard to review.  Please investigate and fix.
> 
> Also the commit message was not revised to match what v2 actually does.

My next comment to Osman is why do we need hyperlinks at all?
Any decent editor that has the README file open can be told to
open the file at the editor's cursor location -- no links needed. :)

-- 
~Randy


      reply	other threads:[~2026-09-21 20:14 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-21  5:00 [PATCH] README: add a reST version with clickable documentation links Osman Ahmadzai
2026-09-21  5:47 ` Jonathan Corbet
2026-09-21  7:05 ` [PATCH v2] README: rename to README.rst and make the doc references links Osman Ahmadzai
2026-09-21 19:24   ` Randy Dunlap
2026-09-21 19:36     ` Matthew Wilcox
2026-09-21 20:14       ` Randy Dunlap [this message]

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=4acccfc3-d934-46fd-88b5-e5660dd0ce65@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=apw@canonical.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=joe@perches.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-spdx@vger.kernel.org \
    --cc=nathan@kernel.org \
    --cc=nsc@kernel.org \
    --cc=osmanahmadxai@gmail.com \
    --cc=tglx@kernel.org \
    --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

all inboxes | Powered by JetHome®