Received: by 2002:a05:7412:b995:b0:f9:9502:5bb8 with SMTP id it21csp7819580rdb; Thu, 4 Jan 2024 08:37:24 -0800 (PST) X-Google-Smtp-Source: AGHT+IHaUmLvMivB9u2+NLgfqnj2rWcn6JMkVM6LJSdrpVuHVIee+6ZNxFPLePQ7KiXG5rpA3AyC X-Received: by 2002:a05:6122:308d:b0:4b7:6fa9:1166 with SMTP id cd13-20020a056122308d00b004b76fa91166mr794942vkb.0.1704386243924; Thu, 04 Jan 2024 08:37:23 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1704386243; cv=none; d=google.com; s=arc-20160816; b=M+4SpfcJxGvvHxoEMxfhBSQFTTTcc74Nu/Ix1e8WpKMBSyFASxCrwxNYSvxZLVkcmH gmcywCOe0wBPGWOYrO9XiKvwU0XWT+rpqTC2CJ2Y5N5HLqVdGipJfVy5JLyGYQf/usLa HrNxtwqJJfWDanSOTcDMcPw344fLdj2uYkXUV+TsTY2vtljcqaXXp4+PLPJ4eS63hBXk 3eck5Sosn7l49Lg/9HR0RmrYyErpTTIeulHUJPSM4Z9OeQkOEyvwDDL54B/uT0+8HC7K cSd9FkTFvmQlkthJS6Asw6dENGfyDowPAYPH6e80JaU/AxT/0AuaGqTpzd2+Ww+TTNZ8 cJkQ== 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=PRb/Y6BB88izDA56LXWJLD7BSeD1+ZRIJAfMp12jSH4=; fh=C1THyYX8mZv7/wM+MHV1ZUcnQSQiZbUrxk0HRhdecS4=; b=aBNLaisZ8QTyLnwOiYsznM5v2TEgD0x6gIRjgv0bv3Uc/9JyfEu0/4MALwn7kWkIpF YYTcL/WHosF1Ufc5M+6ZyFSbv27t/4Nf/9rAOTnwRcyLXfHKDIMDLkW2sSb4hQr5LCxp omICiFB2LvMoD3jhbjCl1Y/+PMQnq2QtYAOKaw/23to4D/CcyNqrn+NUzgyD8rEhYgYF /bG3ldh1GfdguIVz6npNRZhR9kcc3cilLtV/bRMCuh35dKYT7YPD9q4Nm/lMVwxBTDSZ WDQ3aelpke6TolNATiAv5mOqy31fyaI+hkz9cdYRtiCxnwdsPPxOEeW/zwYhgH2wF/hp rxWg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=bdsQoe71; spf=pass (google.com: domain of linux-kernel+bounces-16942-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-16942-linux.lists.archive=gmail.com@vger.kernel.org" Return-Path: Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id i184-20020a1feac1000000b004b6e77b2c37si3816416vkh.21.2024.01.04.08.37.23 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 04 Jan 2024 08:37:23 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-16942-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=bdsQoe71; spf=pass (google.com: domain of linux-kernel+bounces-16942-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-16942-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 ny.mirrors.kernel.org (Postfix) with ESMTPS id A4E141C22393 for ; Thu, 4 Jan 2024 16:37:23 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 483CE25567; Thu, 4 Jan 2024 16:37:01 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="bdsQoe71" X-Original-To: linux-kernel@vger.kernel.org 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 D4BE7250FB; Thu, 4 Jan 2024 16:36:58 +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=PRb/Y6BB88izDA56LXWJLD7BSeD1+ZRIJAfMp12jSH4=; b=bdsQoe71FgfOKWWZVt6VUC44f2 C2ivpE25Jt7gwEgEQVB6/ZSDqQm0aQOFUuUwOfOIEX6wrpRUvxmEwRxrx4ebBH7icK2HPL78BH/5A tiLro3AmH0zesSYDr69YCKKRBr1p/bWmByNBzCx/KRLXj5nFZH+XWc2C51gb+kzdfD2qJpc3L4fbF Juvaa4Q9oAQ0XlfzT0FSmBNkvK/6qtGmdKx8UnYXkCu5/2/rk/wHBJTko5gatvmefcHcfXCzB9czW gHmsiXtqRyR6BbQUsDoiHXOyy8njpj39tpi7tBdBmEjLTQKHQELpHSaajKU91Nig/wLII24kwQuoD IMI+DiiQ==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1rLQiD-00FY2P-Ux; Thu, 04 Jan 2024 16:36:54 +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 0/5] Improve buffer head documentation Date: Thu, 4 Jan 2024 16:36:47 +0000 Message-Id: <20240104163652.3705753-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 Having started improving the kernel-doc for __folio_mark_dirty(), I then started noticing other improvements that could be made, and this is as far as I got before deciding I'd made enough for now. Tested with make htmldocs. Matthew Wilcox (Oracle) (5): 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() kernel-doc doc: Split buffer.rst out of api-summary.rst Documentation/filesystems/api-summary.rst | 3 - Documentation/filesystems/index.rst | 1 + fs/buffer.c | 98 +++++++++++++---------- include/linux/buffer_head.h | 17 ++-- mm/page-writeback.c | 14 ++-- 5 files changed, 74 insertions(+), 59 deletions(-) -- 2.43.0