aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorYunsheng Lin <linyunsheng@huawei.com>2023-08-04 20:05:24 +0200
committerJakub Kicinski <kuba@kernel.org>2023-08-07 13:05:19 -0700
commita9ca9f9ceff382b58b488248f0c0da9e157f5d06 (patch)
treeb57be21d5739459976064119079e37019184206b /Documentation/networking
parent96bc313783cbad7682f5f91f7483dc47296398bb (diff)
downloadlinux-a9ca9f9ceff382b58b488248f0c0da9e157f5d06.tar.gz
page_pool: split types and declarations from page_pool.h
Split types and pure function declarations from page_pool.h and add them in page_page/types.h, so that C sources can include page_pool.h and headers should generally only include page_pool/types.h as suggested by jakub. Rename page_pool.h to page_pool/helpers.h to have both in one place. Signed-off-by: Yunsheng Lin <linyunsheng@huawei.com> Suggested-by: Jakub Kicinski <kuba@kernel.org> Signed-off-by: Alexander Lobakin <aleksander.lobakin@intel.com> Reviewed-by: Alexander Duyck <alexanderduyck@fb.com> Link: https://lore.kernel.org/r/20230804180529.2483231-2-aleksander.lobakin@intel.com [Jakub: change microsoft/mana, fix kdoc paths in Documentation] Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/page_pool.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/networking/page_pool.rst b/Documentation/networking/page_pool.rst
index 53b5448cc0f11a..68b82cea13e438 100644
--- a/Documentation/networking/page_pool.rst
+++ b/Documentation/networking/page_pool.rst
@@ -67,10 +67,10 @@ a page will cause no race conditions is enough.
.. kernel-doc:: net/core/page_pool.c
:identifiers: page_pool_create
-.. kernel-doc:: include/net/page_pool.h
+.. kernel-doc:: include/net/page_pool/types.h
:identifiers: struct page_pool_params
-.. kernel-doc:: include/net/page_pool.h
+.. kernel-doc:: include/net/page_pool/helpers.h
:identifiers: page_pool_put_page page_pool_put_full_page
page_pool_recycle_direct page_pool_dev_alloc_pages
page_pool_get_dma_addr page_pool_get_dma_dir
@@ -122,7 +122,7 @@ page_pool_stats allocated by the caller.
The API will fill in the provided struct page_pool_stats with
statistics about the page_pool.
-.. kernel-doc:: include/net/page_pool.h
+.. kernel-doc:: include/net/page_pool/types.h
:identifiers: struct page_pool_recycle_stats
struct page_pool_alloc_stats
struct page_pool_stats