From: Liam R. Howlett <Liam.Howlett@Oracle.com>
Date: Thu, 27 Feb 2020 03:39:36 +0000 (-0500)
Subject: maple_tree: Initial documentation straw man.
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=17bfacd727102dcd7eda1495f58c6b284a987aca;p=users%2Fjedix%2Flinux-maple.git

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 <Liam.Howlett@Oracle.com>
---

diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 69171b1799f21..63fe6e742dc02 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 0000000000000..6d71d4b1f1456
--- /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
+