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