From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 423CFC433E6 for ; Tue, 16 Mar 2021 05:48:25 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 16CCC651B2 for ; Tue, 16 Mar 2021 05:48:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235568AbhCPFrx (ORCPT ); Tue, 16 Mar 2021 01:47:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52040 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233064AbhCPFrr (ORCPT ); Tue, 16 Mar 2021 01:47:47 -0400 Received: from mail-pf1-x42c.google.com (mail-pf1-x42c.google.com [IPv6:2607:f8b0:4864:20::42c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 78F6BC06174A; Mon, 15 Mar 2021 22:47:47 -0700 (PDT) Received: by mail-pf1-x42c.google.com with SMTP id 18so8069425pfo.6; Mon, 15 Mar 2021 22:47:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=+kjXRUyRx/w7Y8GaJq7eCfF5pid4PKqWc6tkkujLoCo=; b=GOtQLLzKYgSfUtq5WLIWXNJSK0unMMDwpKZvYGLRLdlXUKEUi1ApC9ipDYEdPiZkNv FbxUUp9CdHFBPSebPXM1Ojj/eVFMoYcilQl5r4TOCdUVire12/dV/OUlKJsZJCvE7qaA jUjcuj8MNtedi/XvZxOfWPGcXrBpm6A97jw+sf7W0J39dTrQ3zjGA+rIIQ9ap5pUBe+B NLSP0ArKnJevbfmDr2mSj/G8MNRImqrQqI9FRHYYVim/tdbSigMhO5K3xodfcWS4BX/Q E4NL4SrtYQJ9i11CxieSghuwMpCG/e6tXj4C8rrGEkysN4FX2HW6do/oSCc95Iw4vsA6 gEQw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=+kjXRUyRx/w7Y8GaJq7eCfF5pid4PKqWc6tkkujLoCo=; b=TUa/1LTHssp0upHEhVeTU7Ma4TUKg3guuORHS0quem7t92Z28Fs1DfaQXpRIWHExOV cDrLUVr2b7rmME2+tYKI5yrYi6mWZZQiPNbvKyd727EYi5jRQX0ob8Mjwa9mU6LqmAUQ jbPlBk7e+0iXmXB2XFtSaWDPvebDmZCVeymDqEJYFnrT5ZH3d9gzFYdlYuYdGgwBoKHE 8xv/HpYWjaMWTcYpd+veIlJOYKK8PoRRhuyDkLmFyqsV8usNBiimJLLchg1RdNrVF8dz 6yw187V/C8azijxiLCWia0fdPJHYh+Wd2kp60Q94Xbw55abivYI1cVbnX/Hkj6iLejiV Dkqw== X-Gm-Message-State: AOAM533/2zA1twmBJFVawyYHh2u3xl7dn7kO30CYmxfKWoqdxEAgwYOZ FquIhqxXz9FSDI6Ykr6mwiA= X-Google-Smtp-Source: ABdhPJyryS3L9fRf5yllrbFMfwZeFbTAV2mAViIl/f+8AKQAzR+1NqwMUvywyH1/gZxiXxXfUAwDTQ== X-Received: by 2002:aa7:8e8f:0:b029:1f1:5a1a:7f82 with SMTP id a15-20020aa78e8f0000b02901f15a1a7f82mr13686329pfr.52.1615873666781; Mon, 15 Mar 2021 22:47:46 -0700 (PDT) Received: from cl-arch-kdev.. (cl-arch-kdev.xen.prgmr.com. [2605:2700:0:2:a800:ff:fed6:fc0d]) by smtp.gmail.com with ESMTPSA id l22sm15096513pfd.145.2021.03.15.22.47.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Mar 2021 22:47:46 -0700 (PDT) From: Fox Chen To: neilb@suse.de Cc: Fox Chen , corbet@lwn.net, vegard.nossum@oracle.com, viro@zeniv.linux.org.uk, rdunlap@infradead.org, grandmaster@al2klimov.de, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, gregkh@linuxfoundation.org Subject: [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs Date: Tue, 16 Mar 2021 13:47:15 +0800 Message-Id: <20210316054727.25655-1-foxhlchen@gmail.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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