106 lines · plain
1.. SPDX-License-Identifier: GPL-2.02 3DAMON Maintainer Entry Profile4==============================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 and10linux-mm@kvack.org. Patches should be made against the `mm-unstable tree11<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ whenever possible and posted12to the mailing lists.13 14SCM Trees15---------16 17There are multiple Linux trees for DAMON development. Patches under18development or testing are queued in `damon/next19<https://git.kernel.org/sj/h/damon/next>`_ by the DAMON maintainer.20Sufficiently reviewed patches will be queued in `mm-unstable21<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ by the memory management22subsystem maintainer. After more sufficient tests, the patches will be queued23in `mm-stable <https://git.kernel.org/akpm/mm/h/mm-stable>`_, and finally24pull-requested to the mainline by the memory management subsystem maintainer.25 26Note again the patches for `mm-unstable tree27<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ are queued by the memory28management subsystem maintainer. If the patches requires some patches in29`damon/next tree <https://git.kernel.org/sj/h/damon/next>`_ which not yet merged30in mm-unstable, please make sure the requirement is clearly specified.31 32Submit checklist addendum33-------------------------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 `selftests40 <https://github.com/damonitor/damon-tests/blob/master/corr/run.sh#L49>`_ and41 `kunittests42 <https://github.com/damonitor/damon-tests/blob/master/corr/tests/kunit.sh>`_.43 44Further doing below and putting the results will be helpful.45 46- Run `damon-tests/corr47 <https://github.com/damonitor/damon-tests/tree/master/corr>`_ for normal48 changes.49- Run `damon-tests/perf50 <https://github.com/damonitor/damon-tests/tree/master/perf>`_ for performance51 changes.52 53Key cycle dates54---------------55 56Patches can be sent anytime. Key cycle dates of the `mm-unstable57<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ and `mm-stable58<https://git.kernel.org/akpm/mm/h/mm-stable>`_ trees depend on the memory59management subsystem maintainer.60 61Review cadence62--------------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 be66slow. Do not hesitate to send a ping if you have not heard back within a week67of sending a patch.68 69Mailing tool70------------71 72Like many other Linux kernel subsystems, DAMON uses the mailing lists73(damon@lists.linux.dev and linux-mm@kvack.org) as the major communication74channel. There is a simple tool called `HacKerMaiL75<https://github.com/damonitor/hackermail>`_ (``hkml``), which is for people who76are not very familiar with the mailing lists based communication. The tool77could be particularly helpful for DAMON community members since it is developed78and maintained by DAMON maintainer. The tool is also officially announced to79support DAMON and general Linux kernel development workflow.80 81In other words, `hkml <https://github.com/damonitor/hackermail>`_ is a mailing82tool for DAMON community, which DAMON maintainer is committed to support.83Please feel free to try and report issues or feature requests for the tool to84the maintainer.85 86Community meetup87----------------88 89DAMON community is maintaining two bi-weekly meetup series for community90members who prefer synchronous conversations over mails.91 92The first one is for any discussion between every community member. No93reservation is needed.94 95The seconds one is for discussions on specific topics between restricted96members including the maintainer. The maintainer shares the available time97slots, and attendees should reserve one of those at least 24 hours before the98time slot, by reaching out to the maintainer.99 100Schedules and available reservation time slots are available at the Google `doc101<https://docs.google.com/document/d/1v43Kcj3ly4CYqmAkMaZzLiM2GEnWfgdGbZAH3mi2vpM/edit?usp=sharing>`_.102There is also a public Google `calendar103<https://calendar.google.com/calendar/u/0?cid=ZDIwOTA4YTMxNjc2MDQ3NTIyMmUzYTM5ZmQyM2U4NDA0ZGIwZjBiYmJlZGQxNDM0MmY4ZTRjOTE0NjdhZDRiY0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t>`_104that has the events. Anyone can subscribe it. DAMON maintainer will also105provide periodic reminder to the mailing list (damon@lists.linux.dev).106