mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Matthew Wilcox <willy@infradead.org>
To: Randy Dunlap <rdunlap@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 20:36:42 +0100	[thread overview]
Message-ID: <arGHSsj96C3C3C4x@casper.infradead.org> (raw)
In-Reply-To: <e08514b5-87f6-4a2b-8080-7d7d8e802f99@infradead.org>

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.

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.

  reply	other threads:[~2026-09-21 19:36 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 [this message]
2026-09-21 20:14       ` Randy Dunlap

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=arGHSsj96C3C3C4x@casper.infradead.org \
    --to=willy@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=rdunlap@infradead.org \
    --cc=tglx@kernel.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®