mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2024-12-29 09:13:38 +00:00
f4050ccab7
DAMON GitHub repos have moved from awslabs GitHub org to damonitor org[1]. Following the change, URLs on documents are also updated[2]. However, commit2e9b3d6e2e
("Docs/damon/maintainer-profile: add links in place"), which was added just after the update, was using the deprecated GitHub URLs. Update those to use damonitor GitHub URLs instead. [1] https://lore.kernel.org/20240813232158.83903-1-sj@kernel.org [2] https://lore.kernel.org/20240826015741.80707-2-sj@kernel.org Link: https://lkml.kernel.org/r/20241011170154.70651-3-sj@kernel.org Fixes:2e9b3d6e2e
("Docs/damon/maintainer-profile: add links in place") Signed-off-by: SeongJae Park <sj@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
106 lines
4.5 KiB
ReStructuredText
106 lines
4.5 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
DAMON Maintainer Entry Profile
|
|
==============================
|
|
|
|
The DAMON subsystem covers the files that are listed in 'DATA ACCESS MONITOR'
|
|
section of 'MAINTAINERS' file.
|
|
|
|
The mailing lists for the subsystem are damon@lists.linux.dev and
|
|
linux-mm@kvack.org. Patches should be made against the `mm-unstable tree
|
|
<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ whenever possible and posted
|
|
to the mailing lists.
|
|
|
|
SCM Trees
|
|
---------
|
|
|
|
There are multiple Linux trees for DAMON development. Patches under
|
|
development or testing are queued in `damon/next
|
|
<https://git.kernel.org/sj/h/damon/next>`_ by the DAMON maintainer.
|
|
Sufficiently reviewed patches will be queued in `mm-unstable
|
|
<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ by the memory management
|
|
subsystem maintainer. After more sufficient tests, the patches will be queued
|
|
in `mm-stable <https://git.kernel.org/akpm/mm/h/mm-stable>`_, and finally
|
|
pull-requested to the mainline by the memory management subsystem maintainer.
|
|
|
|
Note again the patches for `mm-unstable tree
|
|
<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ are queued by the memory
|
|
management subsystem maintainer. If the patches requires some patches in
|
|
`damon/next tree <https://git.kernel.org/sj/h/damon/next>`_ which not yet merged
|
|
in mm-unstable, please make sure the requirement is clearly specified.
|
|
|
|
Submit checklist addendum
|
|
-------------------------
|
|
|
|
When making DAMON changes, you should do below.
|
|
|
|
- Build changes related outputs including kernel and documents.
|
|
- Ensure the builds introduce no new errors or warnings.
|
|
- Run and ensure no new failures for DAMON `selftests
|
|
<https://github.com/damonitor/damon-tests/blob/master/corr/run.sh#L49>`_ and
|
|
`kunittests
|
|
<https://github.com/damonitor/damon-tests/blob/master/corr/tests/kunit.sh>`_.
|
|
|
|
Further doing below and putting the results will be helpful.
|
|
|
|
- Run `damon-tests/corr
|
|
<https://github.com/damonitor/damon-tests/tree/master/corr>`_ for normal
|
|
changes.
|
|
- Run `damon-tests/perf
|
|
<https://github.com/damonitor/damon-tests/tree/master/perf>`_ for performance
|
|
changes.
|
|
|
|
Key cycle dates
|
|
---------------
|
|
|
|
Patches can be sent anytime. Key cycle dates of the `mm-unstable
|
|
<https://git.kernel.org/akpm/mm/h/mm-unstable>`_ and `mm-stable
|
|
<https://git.kernel.org/akpm/mm/h/mm-stable>`_ trees depend on the memory
|
|
management subsystem maintainer.
|
|
|
|
Review cadence
|
|
--------------
|
|
|
|
The DAMON maintainer does the work on the usual work hour (09:00 to 17:00,
|
|
Mon-Fri) in PT (Pacific Time). The response to patches will occasionally be
|
|
slow. Do not hesitate to send a ping if you have not heard back within a week
|
|
of sending a patch.
|
|
|
|
Mailing tool
|
|
------------
|
|
|
|
Like many other Linux kernel subsystems, DAMON uses the mailing lists
|
|
(damon@lists.linux.dev and linux-mm@kvack.org) as the major communication
|
|
channel. There is a simple tool called `HacKerMaiL
|
|
<https://github.com/damonitor/hackermail>`_ (``hkml``), which is for people who
|
|
are not very familiar with the mailing lists based communication. The tool
|
|
could be particularly helpful for DAMON community members since it is developed
|
|
and maintained by DAMON maintainer. The tool is also officially announced to
|
|
support DAMON and general Linux kernel development workflow.
|
|
|
|
In other words, `hkml <https://github.com/damonitor/hackermail>`_ is a mailing
|
|
tool for DAMON community, which DAMON maintainer is committed to support.
|
|
Please feel free to try and report issues or feature requests for the tool to
|
|
the maintainer.
|
|
|
|
Community meetup
|
|
----------------
|
|
|
|
DAMON community is maintaining two bi-weekly meetup series for community
|
|
members who prefer synchronous conversations over mails.
|
|
|
|
The first one is for any discussion between every community member. No
|
|
reservation is needed.
|
|
|
|
The seconds one is for discussions on specific topics between restricted
|
|
members including the maintainer. The maintainer shares the available time
|
|
slots, and attendees should reserve one of those at least 24 hours before the
|
|
time slot, by reaching out to the maintainer.
|
|
|
|
Schedules and available reservation time slots are available at the Google `doc
|
|
<https://docs.google.com/document/d/1v43Kcj3ly4CYqmAkMaZzLiM2GEnWfgdGbZAH3mi2vpM/edit?usp=sharing>`_.
|
|
There is also a public Google `calendar
|
|
<https://calendar.google.com/calendar/u/0?cid=ZDIwOTA4YTMxNjc2MDQ3NTIyMmUzYTM5ZmQyM2U4NDA0ZGIwZjBiYmJlZGQxNDM0MmY4ZTRjOTE0NjdhZDRiY0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t>`_
|
|
that has the events. Anyone can subscribe it. DAMON maintainer will also
|
|
provide periodic reminder to the mailing list (damon@lists.linux.dev).
|