tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Docs/mm/damon: add a maintainer-profile for DAMON
Document the basic policies and expectations for DAMON development.
Link: https://lkml.kernel.org/r/20230110190400.119388-6-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <shuah@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
authored by
SeongJae Park
and committed by
Andrew Morton
e7366f3a
9a47c411
+63
+62
Documentation/mm/damon/maintainer-profile.rst
+62
Documentation/mm/damon/maintainer-profile.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
DAMON Maintainer Entry Profile
4
+
==============================
5
+
6
+
The DAMON subsystem covers the files that listed in 'DATA ACCESS MONITOR'
7
+
section of 'MAINTAINERS' file.
8
+
9
+
The mailing lists for the subsystem are damon@lists.linux.dev and
10
+
linux-mm@kvack.org. Patches should be made against the mm-unstable tree [1]_
11
+
whenever possible and posted to the mailing lists.
12
+
13
+
SCM Trees
14
+
---------
15
+
16
+
There are multiple Linux trees for DAMON development. Patches under
17
+
development or testing are queued in damon/next [2]_ by the DAMON maintainer.
18
+
Suffieicntly reviewed patches will be queued in mm-unstable [1]_ by the memory
19
+
management subsystem maintainer. After more sufficient tests, the patches will
20
+
be queued in mm-stable [3]_ , and finally pull-requested to the mainline by the
21
+
memory management subsystem maintainer.
22
+
23
+
Note again the patches for review should be made against the mm-unstable
24
+
tree[1] whenever possible. damon/next is only for preview of others' works in
25
+
progress.
26
+
27
+
Submit checklist addendum
28
+
-------------------------
29
+
30
+
When making DAMON changes, you should do below.
31
+
32
+
- Build changes related outputs including kernel and documents.
33
+
- Ensure the builds introduce no new errors or warnings.
34
+
- Run and ensure no new failures for DAMON selftests [4]_ and kunittests [5]_ .
35
+
36
+
Further doing below and putting the results will be helpful.
37
+
38
+
- Run damon-tests/corr [6]_ for normal changes.
39
+
- Run damon-tests/perf [7]_ for performance changes.
40
+
41
+
Key cycle dates
42
+
---------------
43
+
44
+
Patches can be sent anytime. Key cycle dates of the mm-unstable[1] and
45
+
mm-stable[3] trees depend on the memory management subsystem maintainer.
46
+
47
+
Review cadence
48
+
--------------
49
+
50
+
The DAMON maintainer does the work on the usual work hour (09:00 to 17:00,
51
+
Mon-Fri) in PST. The response to patches will occasionally be slow. Do not
52
+
hesitate to send a ping if you have not heard back within a week of sending a
53
+
patch.
54
+
55
+
56
+
.. [1] https://git.kernel.org/akpm/mm/h/mm-unstable
57
+
.. [2] https://git.kernel.org/sj/h/damon/next
58
+
.. [3] https://git.kernel.org/akpm/mm/h/mm-stable
59
+
.. [4] https://github.com/awslabs/damon-tests/blob/master/corr/run.sh#L49
60
+
.. [5] https://github.com/awslabs/damon-tests/blob/master/corr/tests/kunit.sh
61
+
.. [6] https://github.com/awslabs/damon-tests/tree/master/corr
62
+
.. [7] https://github.com/awslabs/damon-tests/tree/master/perf