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