From cfd559299e8053fde4b024f7a10933870af511bd Mon Sep 17 00:00:00 2001 From: "Liam R. Howlett" Date: Wed, 26 Feb 2020 22:39:36 -0500 Subject: [PATCH] maple_tree: Initial documentation straw man. Just add the file and some headers. Details need to come from Thoughts. Signed-off-by: Liam R. Howlett --- Documentation/core-api/index.rst | 1 + Documentation/core-api/maple-tree.rst | 36 +++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 Documentation/core-api/maple-tree.rst diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index 69171b1799f2..63fe6e742dc0 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -41,6 +41,7 @@ Library functionality that is used throughout the kernel. packing bus-virt-phys-mapping this_cpu_ops + maple-tree timekeeping errseq diff --git a/Documentation/core-api/maple-tree.rst b/Documentation/core-api/maple-tree.rst new file mode 100644 index 000000000000..6d71d4b1f145 --- /dev/null +++ b/Documentation/core-api/maple-tree.rst @@ -0,0 +1,36 @@ +.. SPDX-License-Identifier: GPL-2.0+ + + +========== +Maple Tree +========== + +:Author: Liam R. Howlett + +Overview +======== + +The Maple Tree is an RCU safe Range tree based on the B-Tree. + +Normal API +========== + +Allocating Nodes +---------------- + +Locking +------- + +Advanced API +============ + + +Internal Entries +---------------- + +Functions and structures +======================== + +.. kernel-doc:: include/linux/maple_tree.c +.. kernel-doc:: lib/maple_tree.c + -- 2.50.1