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] [thread-next>] [day] [month] [year] [list]

Message-ID: <423faa6a06fee4e1106f8b0c83bcd78d@posteo.de>
Date:   Mon, 01 Apr 2019 07:19:02 +0200
From:   Martin Kepplinger <martink@...teo.de>
To:     Jonathan Neuschäfer <j.neuschaefer@....net>
Cc:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        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"

Am 01.04.2019 00:14 schrieb Jonathan Neuschäfer:
> 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.
> 
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@....net>
> ---
> 
> Alternatively, we might drop this entry of the list entirely, because
> Documentation/ is already covered.
> ---
>  Documentation/process/kernel-docs.rst | 23 +++++++++++------------
>  1 file changed, 11 insertions(+), 12 deletions(-)
> 
> diff --git a/Documentation/process/kernel-docs.rst
> b/Documentation/process/kernel-docs.rst
> index ab12dddc773e..92488e59943d 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -52,6 +52,17 @@ The Sphinx books should be built with ``make
> {htmldocs | pdfdocs | epubdocs}``.
>          (including this document itself) have been moved there, and 
> might
>          be more up to date than the web version.
> 
> +    * Title: **Overview of the Virtual File System**
> +
> +      :Author: Richard Gooch.
> +      :Location: Documentation/filesystems/vfs.txt
> +      :Keywords: VFS, File System, mounting filesystems, opening 
> files,
> +        dentries, dcache.
> +      :Description: Brief introduction to the Linux Virtual File 
> System.
> +        What is it, how it works, operations taken when opening a file 
> or
> +        mounting a file system and description of important data
> +        structures explaining the purpose of each of their entries.
> +
>  On-line docs
>  ------------
> 
> @@ -95,18 +106,6 @@ On-line docs
>          [...]. This paper examines some common problems for
>          submitting larger changes and some strategies to avoid 
> problems.
> 
> -    * Title: **Overview of the Virtual File System**
> -
> -      :Author: Richard Gooch.
> -      :URL: 
> http://www.mjmwired.net/kernel/Documentation/filesystems/vfs.txt
> -      :Date: 2007
> -      :Keywords: VFS, File System, mounting filesystems, opening 
> files,
> -        dentries, dcache.
> -      :Description: Brief introduction to the Linux Virtual File 
> System.
> -        What is it, how it works, operations taken when opening a file 
> or
> -        mounting a file system and description of important data
> -        structures explaining the purpose of each of their entries.
> -
>      * Title: **Linux Device Drivers, Third Edition**
> 
>        :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman
> --
> 2.20.1

Reviewed-by: Martin Kepplinger <martink@...teo.de>

thanks