[PATCH v2 00/12] docs: path-lookup: Update pathlookup docs

Fox Chen
2021-03-16T05:48:25Z

The Path lookup is a very complex subject in VFS. The path-lookup
document provides a very detailed guidance to help people understand
how path lookup works in the kernel. This document was originally
written based on three lwn articles five years ago. As times goes by,
some of the content is outdated. This patchset is intended to update
the document to make it more relevant to current codebase.

---
v1: https://lore.kernel.org/lkml/20210126072443.33066-1-foxhlchen@gmail.com/
v2:
- Fix problems in v1 reviewed by Neil:
1. In Patch 01 and 02 rewrite a new paragrah to describe step_into()
2. In Patch 01 instead of changing it to traverse_mounts, remove follow_managed()
3. In Patch 03 re-telling the story rather than adding notes
4. In Patch 04 do_open() should be outside of loop, fix it and fix other problems
in following paragrah
5. In Patch 07 use "drop out of RCU-walk"
6. In Patch 08 "latter" should be "later", fix it and restructure the next paragrah
removing "Finally"

To help review, I've put a compiled html version here:
http://linux-docs.54fox.com/linux_docs/filesystems/path-lookup-v2.html

Fox Chen (12):
docs: path-lookup: update follow_managed() part
docs: path-lookup: update path_to_nameidata() part
docs: path-lookup: update path_mountpoint() part
docs: path-lookup: update do_last() part
docs: path-lookup: remove filename_mountpoint
docs: path-lookup: Add macro name to symlink limit description
docs: path-lookup: i_op->follow_link replaced with i_op->get_link
docs: path-lookup: update i_op->put_link and cookie description
docs: path-lookup: no get_link()
docs: path-lookup: update WALK_GET, WALK_PUT desc
docs: path-lookup: update get_link() ->follow_link description
docs: path-lookup: update symlink description

Documentation/filesystems/path-lookup.rst | 164 ++++++++++------------
1 file changed, 71 insertions(+), 93 deletions(-)

--
2.30.2