Received: by 2002:a05:7412:e794:b0:fa:551:50a7 with SMTP id o20csp363251rdd; Tue, 9 Jan 2024 06:36:53 -0800 (PST) X-Google-Smtp-Source: AGHT+IHs4J+htQtHBav4b9pWNt9ptAQzx6DvUCxkslorRRuzY4Wu8O+Ugs57/3g+YZUnZqxrRHlj X-Received: by 2002:a17:903:2c5:b0:1d5:5af5:6feb with SMTP id s5-20020a17090302c500b001d55af56febmr1067072plk.114.1704811013225; Tue, 09 Jan 2024 06:36:53 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704811013; cv=none; d=google.com; s=arc-20160816; b=y3NA6c6K2PIUAyoigJXN06NbZW4CNzLP6wMPhtmyam0u1KE/Tm/gheGdFnM07Hs7fV aRCFDSlTIxZu1BqAGlhMAvq3Rtb4upCR3z4uD9GRIz17xrzHaSIWmQcpVh4Kfv6VcvQa GPqyKD1Apc3a6guMTpflwP/UbKN3wpO5Sm/h53my6uJ5op5avvToC4iWe16ZEsuDupO7 3D1M8h0XtpgpI2tyL48abGTMR2NS3SkpXilbTSVhyIcXfaVuquLtOMOymjxSlBypWy7L 64B7UvxG6W164Fp0PMCVz2atOPypgm5hbASlGXO0EMGWX8bcWgfkMXApANMK1oCTX90c T/EA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=BXc+4WKC8+eb9zNRohZjAGSMHA28vjIGn5u2I+5gdTw=; fh=C1THyYX8mZv7/wM+MHV1ZUcnQSQiZbUrxk0HRhdecS4=; b=nV9ubMlmlCVVNvX9c6T6+14eMvc8bG+NsqkOvxLVFWdbCNV77PvjbTwcXJ6asyXKt+ vlMqxFZG8E5c+a+qJciIXSeH0CBr+tJc+9VBZqNEC/juFgpNwTB196tVvTRPO17qdvOP B4AknLUNkUJd6gbfhoJY6uEDLh3arosp2+MgyFcqTFZwkDXTDy4nPTzmvPTvlQ87EDwY TO6XqPzc+yiaBWtMYdH207ZTMQZmt5Nqw9h4vwwtbR1xK/E+xqygPuuK97kD4tphLC60 rZ5LFZhoZBl2T+A7JVRhilZzmEbgCJZ1vKRQK8J+P521PpGLskh4+Uzhn0okNw2Teg6Z xe+Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=Ziv+kSTd; spf=pass (google.com: domain of linux-kernel+bounces-20997-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-20997-linux.lists.archive=gmail.com@vger.kernel.org" Return-Path: Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id o7-20020a170902778700b001d42ee2a4f0si1534115pll.424.2024.01.09.06.36.53 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jan 2024 06:36:53 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-20997-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=Ziv+kSTd; spf=pass (google.com: domain of linux-kernel+bounces-20997-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-20997-linux.lists.archive=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sv.mirrors.kernel.org (Postfix) with ESMTPS id DE110281C72 for ; Tue, 9 Jan 2024 14:36:52 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id DF45F3BB4D; Tue, 9 Jan 2024 14:34:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="Ziv+kSTd" Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E1EFC3BB26; Tue, 9 Jan 2024 14:34:19 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=BXc+4WKC8+eb9zNRohZjAGSMHA28vjIGn5u2I+5gdTw=; b=Ziv+kSTd8e4knFsf+cZ4FhSgIg U9pzgaaTvSfxy9LbNi4iN9eaV7kk0SCSH4a9+ukAso1FUS4dPAzlMCz1Lx50nWwL0EKgv1T8LuyV+ 4AWy423Jd3yuguBwNDUUp5ffII1/mH8tkvvc4IMeS3MLW3ptkF2mGEnUEAB0UtuZqgu6A8TNYuhoW SBu5o8PccwH8QsxCW7CySkGVly2rIndLhiauUKbVVpiMvcvXzORh0hq+bTn6cuXlZLiYH/dYoMOsa vcqVdltFfkgRr9BSJzsTF9KdZjSuxnMbB08s2cQCQwDb7ovAQjvYdJeblntnp2O/VKD3Hu1laZ9hy 8q02evYg==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1rNDB0-009xrO-Nf; Tue, 09 Jan 2024 14:33:58 +0000 From: "Matthew Wilcox (Oracle)" To: Jonathan Corbet Cc: "Matthew Wilcox (Oracle)" , linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 0/8] Improve buffer head documentation Date: Tue, 9 Jan 2024 14:33:49 +0000 Message-Id: <20240109143357.2375046-1-willy@infradead.org> X-Mailer: git-send-email 2.37.1 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Turn buffer head documentation into its own document, and make many general improvements to the docs. Obviously there is much more that could be done. Tested with make htmldocs. v2: - Incorporate feedback from Randy & Pankaj - Add docs for brelse() and bforget() - Improve bdev_getblk() docs Matthew Wilcox (Oracle) (8): doc: Improve the description of __folio_mark_dirty buffer: Add kernel-doc for block_dirty_folio() buffer: Add kernel-doc for try_to_free_buffers() buffer: Fix __bread and __bread_gfp kernel-doc buffer: Add kernel-doc for brelse() and __brelse() buffer: Add kernel-doc for bforget() and __bforget() buffer: Improve bdev_getblk documentation doc: Split buffer.rst out of api-summary.rst Documentation/filesystems/api-summary.rst | 3 - Documentation/filesystems/index.rst | 1 + fs/buffer.c | 165 +++++++++++++--------- include/linux/buffer_head.h | 48 +++++-- mm/page-writeback.c | 14 +- 5 files changed, 145 insertions(+), 86 deletions(-) -- 2.43.0