linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: NeilBrown <neilb@suse.de>
To: Fox Chen <foxhlchen@gmail.com>,
	corbet@lwn.net, vegard.nossum@oracle.com,
	viro@zeniv.linux.org.uk, rdunlap@infradead.org,
	grandmaster@al2klimov.de
Cc: Fox Chen <foxhlchen@gmail.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 00/12] docs: path-lookup: Update pathlookup docs
Date: Thu, 28 Jan 2021 14:58:04 +1100	[thread overview]
Message-ID: <87zh0tg1bn.fsf@notabene.neil.brown.name> (raw)
In-Reply-To: <20210126072443.33066-1-foxhlchen@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1818 bytes --]

On Tue, Jan 26 2021, Fox Chen wrote:

> 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 was outdated. This patchset is intended to update
> the document to make it more relevant to current codebase.
>
>
> Fox Chen (12):
>   docs: path-lookup: update follow_managed() part
>   docs: path-lookup: update path_to_nameidata() parth
>   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
>

Thanks for doing this.  I've responded individually to several of the
patches.  As you can see from my comments, there is often more to it
than just changing function names.  In some places you have capture the
more general nature of the change fairly well.  In other places the
result is incoherent or confusion.
Making small updates to this sort of documentation is not easy.  You
need to step have and see the "big picture", to overall story-arc.
Sometimes you can fit changes into that arc, sometimes you might need to
restructure or re-tell the story.

This is part of why I haven't put much effort into the document -
re-telling a story can be a lot of work.

NeilBrown

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 853 bytes --]

  parent reply	other threads:[~2021-01-28  4:14 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-26  7:24 [PATCH 00/12] docs: path-lookup: Update pathlookup docs Fox Chen
2021-01-26  7:24 ` [PATCH 01/12] docs: path-lookup: update follow_managed() part Fox Chen
2021-01-26 14:03   ` Greg KH
2021-01-27  1:11     ` Fox Chen
2021-01-28  3:20   ` NeilBrown
2021-01-26  7:24 ` [PATCH 02/12] docs: path-lookup: update path_to_nameidata() parth Fox Chen
2021-01-28  3:24   ` NeilBrown
2021-01-26  7:24 ` [PATCH 03/12] docs: path-lookup: update path_mountpoint() part Fox Chen
2021-01-28  3:28   ` NeilBrown
2021-01-26  7:24 ` [PATCH 04/12] docs: path-lookup: update do_last() part Fox Chen
2021-01-28  3:50   ` NeilBrown
2021-01-26  7:24 ` [PATCH 05/12] docs: path-lookup: remove filename_mountpoint Fox Chen
2021-01-26  7:24 ` [PATCH 06/12] docs: path-lookup: Add macro name to symlink limit description Fox Chen
2021-01-26  7:24 ` [PATCH 07/12] docs: path-lookup: i_op->follow_link replaced with i_op->get_link Fox Chen
2021-01-28  3:53   ` NeilBrown
2021-01-26  7:24 ` [PATCH 08/12] docs: path-lookup: update i_op->put_link and cookie description Fox Chen
2021-01-28  3:50   ` NeilBrown
2021-01-26  7:24 ` [PATCH 09/12] docs: path-lookup: no get_link() Fox Chen
2021-01-26  7:24 ` [PATCH 10/12] docs: path-lookup: update WALK_GET, WALK_PUT desc Fox Chen
2021-01-26  7:24 ` [PATCH 11/12] docs: path-lookup: update get_link() ->follow_link description Fox Chen
2021-01-26  7:24 ` [PATCH 12/12] docs: path-lookup: update symlink description Fox Chen
2021-01-26  7:30 ` [PATCH 00/12] docs: path-lookup: Update pathlookup docs Fox Chen
2021-01-26 20:31 ` Jonathan Corbet
2021-01-28  1:23   ` Fox Chen
2021-01-28  3:58 ` NeilBrown [this message]
2021-01-29  1:29   ` Fox Chen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87zh0tg1bn.fsf@notabene.neil.brown.name \
    --to=neilb@suse.de \
    --cc=corbet@lwn.net \
    --cc=foxhlchen@gmail.com \
    --cc=grandmaster@al2klimov.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=vegard.nossum@oracle.com \
    --cc=viro@zeniv.linux.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).