Re: [PATCH] README: add a reST version with clickable documentation links

[Jonathan Corbet <corbet@lwn.net>]

Osman Ahmadzai <osmanahmadxai@gmail.com> writes:

> 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.
>
> Add README.rst with the same content, wrapping each path in an anonymous
> reST reference.  The link text is the path itself, so the file reads the
> same as it does now.  Anonymous because a handful of the paths are listed
> twice and named targets would collide.
>
> README itself is left alone - checkpatch.pl and get_maintainer.pl both
> look for a file called README to find the top of the tree, and the
> Makefile points at it too, so renaming would mean touching all three.
>
> Signed-off-by: Osman Ahmadzai <osmanahmadxai@gmail.com>

Creating a second file with duplicated content isn't really going to
help...they'll be out of sync within one release cycle.  Better to have
a single file and use a symlink (or else to simply rename it and fix the
other files as well).  Or, perhaps best yet, see if it can be integrated
with Documentation/index.rst.

Thanks,

jon