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