summaryrefslogtreecommitdiff
path: root/Documentation/mm/damon/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/mm/damon/api.rst')
-rw-r--r--Documentation/mm/damon/api.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/mm/damon/api.rst b/Documentation/mm/damon/api.rst
new file mode 100644
index 000000000000..08f34df45523
--- /dev/null
+++ b/Documentation/mm/damon/api.rst
@@ -0,0 +1,20 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============
+API Reference
+=============
+
+Kernel space programs can use every feature of DAMON using below APIs. All you
+need to do is including ``damon.h``, which is located in ``include/linux/`` of
+the source tree.
+
+Structures
+==========
+
+.. kernel-doc:: include/linux/damon.h
+
+
+Functions
+=========
+
+.. kernel-doc:: mm/damon/core.c