Re: [PATCH] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree"

From: Jonathan NeuschÃfer
Date: Tue Apr 02 2019 - 15:13:27 EST


On Tue, Apr 02, 2019 at 09:43:58AM -0600, Jonathan Corbet wrote:
> On Mon, 1 Apr 2019 00:14:37 +0200
> Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx> wrote:
>
> > It's unnecessary to point to an external mirror of the Documentation
> > directory. Also, drop the date field, because in-kernel documentation is
> > continually updated.
>
> So I had to ponder on this one a bit...saying "continually updated" is
> pretty amusing for a document that leads off with:
>
> Last updated on June 24, 2007.

Ok, I should have been more explicit with what I meant and written "(in
principle) continually update"; compared to journal articles or sections
of a specific edition of a book, that's what files in Git are.

However, looking at the Git history for vfs.txt, it has indeed been
updated multiple times per year, and not just with typo fixes, so I
think this line should simply be removed to avoid further confusion.

>
> > Signed-off-by: Jonathan NeuschÃfer <j.neuschaefer@xxxxxxx>
> > ---
> >
> > Alternatively, we might drop this entry of the list entirely, because
> > Documentation/ is already covered.
>
> In the end, I think this alternative option is the better one. We don't
> want to turn kernel-docs.rst into yet another out-of-date index for the
> rest of Documentation/, and the removal of the external URL takes away the
> only bit of additional information that this entry offers.

Good points, I'll do that for v2.


Jonathan NeuschÃfer

Attachment: signature.asc
Description: PGP signature