xref: /linux/Documentation/mm/damon/maintainer-profile.rst (revision 8e1bb4a41aa78d6105e59186af3dcd545fc66e70)
1.. SPDX-License-Identifier: GPL-2.0
2
3DAMON Maintainer Entry Profile
4==============================
5
6The DAMON subsystem covers the files that are listed in 'DATA ACCESS MONITOR'
7section of 'MAINTAINERS' file.
8
9The mailing lists for the subsystem are damon@lists.linux.dev and
10linux-mm@kvack.org.  Patches should be made against the mm-unstable tree [1]_
11whenever possible and posted to the mailing lists.
12
13SCM Trees
14---------
15
16There are multiple Linux trees for DAMON development.  Patches under
17development or testing are queued in damon/next [2]_ by the DAMON maintainer.
18Sufficiently reviewed patches will be queued in mm-unstable [1]_ by the memory
19management subsystem maintainer.  After more sufficient tests, the patches will
20be queued in mm-stable [3]_ , and finally pull-requested to the mainline by the
21memory management subsystem maintainer.
22
23Note again the patches for mm-unstable tree [1]_ are queued by the memory
24management subsystem maintainer.  If the patches requires some patches in
25damon/next tree [2]_ which not yet merged in mm-unstable, please make sure the
26requirement is clearly specified.
27
28Submit checklist addendum
29-------------------------
30
31When making DAMON changes, you should do below.
32
33- Build changes related outputs including kernel and documents.
34- Ensure the builds introduce no new errors or warnings.
35- Run and ensure no new failures for DAMON selftests [4]_ and kunittests [5]_ .
36
37Further doing below and putting the results will be helpful.
38
39- Run damon-tests/corr [6]_ for normal changes.
40- Run damon-tests/perf [7]_ for performance changes.
41
42Key cycle dates
43---------------
44
45Patches can be sent anytime.  Key cycle dates of the mm-unstable [1]_ and
46mm-stable [3]_ trees depend on the memory management subsystem maintainer.
47
48Review cadence
49--------------
50
51The DAMON maintainer does the work on the usual work hour (09:00 to 17:00,
52Mon-Fri) in PT (Pacific Time).  The response to patches will occasionally be
53slow.  Do not hesitate to send a ping if you have not heard back within a week
54of sending a patch.
55
56Mailing tool
57------------
58
59Like many other Linux kernel subsystems, DAMON uses the mailing lists
60(damon@lists.linux.dev and linux-mm@kvack.org) as the major communication
61channel.  There is a simple tool called HacKerMaiL (``hkml``) [8]_ , which is
62for people who are not very familiar with the mailing lists based
63communication.  The tool could be particularly helpful for DAMON community
64members since it is developed and maintained by DAMON maintainer.  The tool is
65also officially announced to support DAMON and general Linux kernel development
66workflow.
67
68In other words, ``hkml`` [8]_ is a mailing tool for DAMON community, which
69DAMON maintainer is committed to support.  Please feel free to try and report
70issues or feature requests for the tool to the maintainer.
71
72Community meetup
73----------------
74
75DAMON community is maintaining two bi-weekly meetup series for community
76members who prefer synchronous conversations over mails.
77
78The first one is for any discussion between every community member.  No
79reservation is needed.
80
81The seconds one is for discussions on specific topics between restricted
82members including the maintainer.  The maintainer shares the available time
83slots, and attendees should reserve one of those at least 24 hours before the
84time slot, by reaching out to the maintainer.
85
86Schedules and available reservation time slots are available at the Google doc
87[9]_ .  DAMON maintainer will also provide periodic reminder to the mailing
88list (damon@lists.linux.dev).
89
90
91.. [1] https://git.kernel.org/akpm/mm/h/mm-unstable
92.. [2] https://git.kernel.org/sj/h/damon/next
93.. [3] https://git.kernel.org/akpm/mm/h/mm-stable
94.. [4] https://github.com/awslabs/damon-tests/blob/master/corr/run.sh#L49
95.. [5] https://github.com/awslabs/damon-tests/blob/master/corr/tests/kunit.sh
96.. [6] https://github.com/awslabs/damon-tests/tree/master/corr
97.. [7] https://github.com/awslabs/damon-tests/tree/master/perf
98.. [8] https://github.com/damonitor/hackermail
99.. [9] https://docs.google.com/document/d/1v43Kcj3ly4CYqmAkMaZzLiM2GEnWfgdGbZAH3mi2vpM/edit?usp=sharing
100