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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Tue, 2 Apr 2019 21:13:17 +0200
From:   Jonathan Neuschäfer <j.neuschaefer@....net>
To:     Jonathan Corbet <corbet@....net>
Cc:     Jonathan Neuschäfer <j.neuschaefer@....net>,
        linux-doc@...r.kernel.org, Martin Kepplinger <martink@...teo.de>,
        Federico Vaga <federico.vaga@...a.pv.it>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: kernel-docs: Move vfs.txt under "Docs at
 the Linux Kernel tree"

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@....net> 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@....net>
> > ---
> > 
> > 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

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)