Re: [PATCH v2] README: rename to README.rst and make the doc references links

[Randy Dunlap]

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