aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsjpark <sjpark@amazon.com>2022-12-30 16:44:44 -0800
committersjpark <sjpark@amazon.com>2022-12-30 16:44:44 -0800
commit495fd2129c8ad479b8d1144cd55fc6a5fd0498c8 (patch)
treeedf8cf29d9a408b72bd6ea6e9e8fc7bbee441d55
parent259380f679907a4bcf34d47b33291c45b330ad4c (diff)
downloaddamon-hack-495fd2129c8ad479b8d1144cd55fc6a5fd0498c8.tar.gz
damon_doc: Remove the patch and add the index.rst
The patch for damon-only doc generation fails to be applied frequently. Add the patch applied index.rst instead. Signed-off-by: sjpark <sjpark@amazon.com>
-rw-r--r--damon_doc_index/index.rst35
-rw-r--r--patch_for_damon_doc/0001-Docs-Modify-for-DAMON-only.patch197
2 files changed, 35 insertions, 197 deletions
diff --git a/damon_doc_index/index.rst b/damon_doc_index/index.rst
new file mode 100644
index 0000000..7d627d3
--- /dev/null
+++ b/damon_doc_index/index.rst
@@ -0,0 +1,35 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. _linux_doc:
+
+The Linux Kernel documentation
+==============================
+
+This is the top level of the kernel's documentation tree modified for DAMON.
+
+User-oriented documentation
+---------------------------
+
+The following manuals are written for *users* of DAMON - those who are trying
+to get it to work optimally on a given system.
+
+.. toctree::
+ :maxdepth: 3
+
+ admin-guide/mm/damon/index
+
+
+Kernel API documentation
+------------------------
+
+Manuals for use by developers working to interface with DAMON.
+
+.. toctree::
+ :maxdepth: 3
+
+ mm/damon/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
diff --git a/patch_for_damon_doc/0001-Docs-Modify-for-DAMON-only.patch b/patch_for_damon_doc/0001-Docs-Modify-for-DAMON-only.patch
deleted file mode 100644
index d27c9e9..0000000
--- a/patch_for_damon_doc/0001-Docs-Modify-for-DAMON-only.patch
+++ /dev/null
@@ -1,197 +0,0 @@
-From 536a60b16fb46d07f1e1da6a18d67b9d1731a37f Mon Sep 17 00:00:00 2001
-From: SeongJae Park <sjpark@amazon.de>
-Date: Thu, 9 Jul 2020 12:00:02 +0200
-Subject: [PATCH] Docs: Modify for DAMON only
-
-Signed-off-by: SeongJae Park <sjpark@amazon.de>
----
- Documentation/index.rst | 156 +++-------------------------------------
- 1 file changed, 8 insertions(+), 148 deletions(-)
-
-diff --git a/Documentation/index.rst b/Documentation/index.rst
-index 4737c18c97ff..f397348b280a 100644
---- a/Documentation/index.rst
-+++ b/Documentation/index.rst
-@@ -11,171 +11,31 @@
- The Linux Kernel documentation
- ==============================
-
--This is the top level of the kernel's documentation tree. Kernel
--documentation, like the kernel itself, is very much a work in progress;
--that is especially true as we work to integrate our many scattered
--documents into a coherent whole. Please note that improvements to the
--documentation are welcome; join the linux-doc list at vger.kernel.org if
--you want to help out.
--
--Licensing documentation
-------------------------
--
--The following describes the license of the Linux kernel source code
--(GPLv2), how to properly mark the license of individual files in the source
--tree, as well as links to the full license text.
--
--* :ref:`kernel_licensing`
-+This is the top level of the kernel's documentation tree modified for DAMON.
-
- User-oriented documentation
- ---------------------------
-
--The following manuals are written for *users* of the kernel — those who are
-+The following manuals are written for *users* of DAMON — those who are
- trying to get it to work optimally on a given system.
-
- .. toctree::
-- :maxdepth: 2
--
-- admin-guide/index
-- kbuild/index
--
--Firmware-related documentation
--------------------------------
--The following holds information on the kernel's expectations regarding the
--platform firmwares.
--
--.. toctree::
-- :maxdepth: 2
--
-- firmware-guide/index
-- devicetree/index
--
--Application-developer documentation
-------------------------------------
--
--The user-space API manual gathers together documents describing aspects of
--the kernel interface as seen by application developers.
--
--.. toctree::
-- :maxdepth: 2
--
-- userspace-api/index
--
--
--Introduction to kernel development
------------------------------------
--
--These manuals contain overall information about how to develop the kernel.
--The kernel community is quite large, with thousands of developers
--contributing over the course of a year. As with any large community,
--knowing how things are done will make the process of getting your changes
--merged much easier.
--
--.. toctree::
-- :maxdepth: 2
-+ :maxdepth: 3
-
-- process/index
-- dev-tools/index
-- doc-guide/index
-- kernel-hacking/index
-- trace/index
-- maintainer/index
-- fault-injection/index
-- livepatch/index
-+ admin-guide/mm/damon/index
-
-
- Kernel API documentation
- ------------------------
-
--These books get into the details of how specific kernel subsystems work
--from the point of view of a kernel developer. Much of the information here
--is taken directly from the kernel source, with supplemental material added
--as needed (or at least as we managed to add it — probably *not* all that is
--needed).
--
--.. toctree::
-- :maxdepth: 2
--
-- driver-api/index
-- core-api/index
-- locking/index
-- accounting/index
-- block/index
-- cdrom/index
-- cpu-freq/index
-- fb/index
-- fpga/index
-- hid/index
-- i2c/index
-- iio/index
-- isdn/index
-- infiniband/index
-- leds/index
-- netlabel/index
-- networking/index
-- pcmcia/index
-- power/index
-- target/index
-- timers/index
-- spi/index
-- w1/index
-- watchdog/index
-- virt/index
-- input/index
-- hwmon/index
-- gpu/index
-- security/index
-- sound/index
-- crypto/index
-- filesystems/index
-- mm/index
-- bpf/index
-- usb/index
-- PCI/index
-- scsi/index
-- misc-devices/index
-- scheduler/index
-- mhi/index
-- peci/index
--
--Architecture-agnostic documentation
-------------------------------------
-+These books get into the details of how DAMON work from the point of view of a
-+kernel developer.
-
- .. toctree::
-- :maxdepth: 2
--
-- asm-annotations
--
--Architecture-specific documentation
-------------------------------------
--
--.. toctree::
-- :maxdepth: 2
--
-- arch
--
-+ :maxdepth: 3
-
--Other documentation
---------------------
--
--There are several unsorted documents that don't seem to fit on other parts
--of the documentation body, or may require some adjustments and/or conversion
--to ReStructured Text format, or are simply too old.
--
--.. toctree::
-- :maxdepth: 2
--
-- tools/index
-- staging/index
--
--
--Translations
--------------
--
--.. toctree::
-- :maxdepth: 2
-+ mm/damon/index
-
-- translations/index
-
- Indices and tables
- ==================
---
-2.25.1
-