linux-kernel - Re: [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text

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]

Date:   Mon, 10 Dec 2018 09:58:37 +1100
From:   NeilBrown <neilb@...e.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text

On Thu, Dec 06 2018, Jonathan Corbet wrote:

> On Thu, 06 Dec 2018 08:00:58 +1100
> NeilBrown <neilb@...e.com> wrote:
>
>> > Is there a reason you used "include" rather than just adding it to the
>> > TOC tree with the rest?  
>> 
>> Simple.  I didn't know what I was doing, and so randomly made changes until
>> the result seemed acceptable - then I stopped.  If there is a better
>> way, feel free to tweak that when applying.
>
> OK, tweaked and applied, thanks.
>
> jon

Thanks...

However we now have a stub section "Pathname lookup" which serves only
to introduce another stub sectoin "Pathname lookup in Linux", which does
little more than introduce the rest of the section.
This seems inelegant, and is probably why I went for the "include"
approach.

What would you think of something more like the following?

Thanks,
NeilBrown


diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index ba921bdd5b06..605befab300b 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -363,8 +363,18 @@ encryption of files and directories.
 Pathname lookup
 ===============
 
-Pathname lookup in Linux is a complex beast; the document linked below
-provides a comprehensive summary for those looking for the details.
+
+This write-up is based on three articles published at lwn.net:
+
+- <https://lwn.net/Articles/649115/> Pathname lookup in Linux
+- <https://lwn.net/Articles/649729/> RCU-walk: faster pathname lookup in Linux
+- <https://lwn.net/Articles/650786/> A walk among the symlinks
+
+Written by Neil Brown with help from Al Viro and Jon Corbet.
+It has subsequently been updated to reflect changes in the kernel
+including:
+
+- per-directory parallel name lookup.
 
 .. toctree::
    :maxdepth: 2
diff --git a/Documentation/filesystems/path-lookup.rst b/Documentation/filesystems/path-lookup.rst
index 30a155736afe..9d6b68853f5b 100644
--- a/Documentation/filesystems/path-lookup.rst
+++ b/Documentation/filesystems/path-lookup.rst
@@ -1,18 +1,3 @@
-========================
-Pathname lookup in Linux
-========================
-
-This write-up is based on three articles published at lwn.net:
-
-- <https://lwn.net/Articles/649115/> Pathname lookup in Linux
-- <https://lwn.net/Articles/649729/> RCU-walk: faster pathname lookup in Linux
-- <https://lwn.net/Articles/650786/> A walk among the symlinks
-
-Written by Neil Brown with help from Al Viro and Jon Corbet.
-It has subsequently been updated to reflect changes in the kernel
-including:
-
-- per-directory parallel name lookup.
 
 Introduction to pathname lookup
 ===============================

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