From: Tamir Hadash <udbe3333@gmail.com>
To: dhowells@redhat.com, brauner@kernel.org
Cc: linux-kernel@vger.kernel.org, udbe3333@gmail.com
Subject: [PATCH] mm: Rename folioq_count to folioq_full in documentation to match function
Date: Wed, 2 Oct 2024 13:30:46 +0300 [thread overview]
Message-ID: <20241002103046.24847-1-udbe3333@gmail.com> (raw)
This patch updates the documentation to correctly reflect the function names in the memory management code.
Previously, both the folioq_count and folioq_full functions had documentation incorrectly referring to folioq_count. This caused confusion and warnings when building the Linux kernel's HTML documentation.
The documentation for folioq_full has been renamed to match the correct function name, resolving these issues and improving consistency between the function definitions and their respective documentation.
Signed-off-by: Tamir Hadash <udbe3333@gmail.com>
---
include/linux/folio_queue.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/folio_queue.h b/include/linux/folio_queue.h
index af871405ae55..3abe614ef5f0 100644
--- a/include/linux/folio_queue.h
+++ b/include/linux/folio_queue.h
@@ -81,7 +81,7 @@ static inline unsigned int folioq_count(struct folio_queue *folioq)
}
/**
- * folioq_count: Query if a folio queue segment is full
+ * folioq_full: Query if a folio queue segment is full
* @folioq: The segment to query
*
* Query if a folio queue segment is fully occupied. Note that this does not
--
2.46.2
reply other threads:[~2024-10-02 10:30 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20241002103046.24847-1-udbe3333@gmail.com \
--to=udbe3333@gmail.com \
--cc=brauner@kernel.org \
--cc=dhowells@redhat.com \
--cc=linux-kernel@vger.kernel.org \
/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