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