Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs
@ 2021-03-16  5:47 Fox Chen
  2021-03-16  5:47 ` [PATCH v2 01/12] docs: path-lookup: update follow_managed() part Fox Chen
                   ` (12 more replies)
  0 siblings, 13 replies; 34+ messages in thread
From: Fox Chen @ 2021-03-16  5:47 UTC (permalink / raw)
  To: neilb
  Cc: Fox Chen, corbet, vegard.nossum, viro, rdunlap, grandmaster,
	linux-doc, linux-kernel, gregkh

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


^ permalink raw reply	[flat|nested] 34+ messages in thread

end of thread, back to index

Thread overview: 34+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-16  5:47 [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs Fox Chen
2021-03-16  5:47 ` [PATCH v2 01/12] docs: path-lookup: update follow_managed() part Fox Chen
2021-04-19  0:52   ` NeilBrown
2021-04-19  2:17   ` Matthew Wilcox
2021-04-19  2:33     ` Fox Chen
2021-04-19  3:25       ` Matthew Wilcox
2021-04-19  3:33         ` Fox Chen
2021-04-19 19:22           ` Jonathan Corbet
2021-04-20  1:12             ` Fox Chen
2021-03-16  5:47 ` [PATCH v2 02/12] docs: path-lookup: update path_to_nameidata() part Fox Chen
2021-04-19  1:00   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 03/12] docs: path-lookup: update path_mountpoint() part Fox Chen
2021-04-19  1:03   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 04/12] docs: path-lookup: update do_last() part Fox Chen
2021-04-19  1:17   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 05/12] docs: path-lookup: remove filename_mountpoint Fox Chen
2021-04-19  1:20   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 06/12] docs: path-lookup: Add macro name to symlink limit description Fox Chen
2021-04-19  1:22   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 07/12] docs: path-lookup: i_op->follow_link replaced with i_op->get_link Fox Chen
2021-04-19  1:28   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 08/12] docs: path-lookup: update i_op->put_link and cookie description Fox Chen
2021-04-19  1:37   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 09/12] docs: path-lookup: no get_link() Fox Chen
2021-04-19  1:41   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 10/12] docs: path-lookup: update WALK_GET, WALK_PUT desc Fox Chen
2021-04-19  1:47   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 11/12] docs: path-lookup: update get_link() ->follow_link description Fox Chen
2021-04-19  1:54   ` NeilBrown
2021-03-16  5:47 ` [PATCH v2 12/12] docs: path-lookup: update symlink description Fox Chen
2021-04-19  1:59   ` NeilBrown
2021-04-19  2:34     ` Fox Chen
2021-04-13 21:18 ` [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs Jonathan Corbet
2021-04-13 22:26   ` NeilBrown

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git