public-mirrors/linux
1
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-05-14 19:53:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs/damon/maintainer-profile: add links in place

Browse source 
maintainer-profile.rst for DAMON separates the links and target
definitions.  It is not really necessary, and only makes the readability
worse.  At least the definitions need the section title (say,
"References").  Just add the links in place on the doc.

Link: https://lkml.kernel.org/r/20240826015741.80707-3-sj@kernel.org
Signed-off-by: SeongJae Park <sj@kernel.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Hu Haowen <2023002089@link.tyut.edu.cn>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Yanteng Si <siyanteng@loongson.cn>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
SeongJae Park 2024-08-25 18:57:40 -07:00 • committed by Andrew Morton
parent 23a425aab0
commit 2e9b3d6e2e
1 changed files with 42 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
Documentation/mm/damon/maintainer-profile.rst
View file

@ -7,23 +7,27 @@ The DAMON subsystem covers the files that are listed in 'DATA ACCESS MONITOR'
section of 'MAINTAINERS' file. section of 'MAINTAINERS' file.
The mailing lists for the subsystem are damon@lists.linux.dev and 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 [1]_ linux-mm@kvack.org. Patches should be made against the mm-unstable `tree
whenever possible and posted to the mailing lists. <https://git.kernel.org/akpm/mm/h/mm-unstable>` whenever possible and posted to
the mailing lists.
SCM Trees SCM Trees
--------- ---------
There are multiple Linux trees for DAMON development. Patches under There are multiple Linux trees for DAMON development. Patches under
development or testing are queued in damon/next [2]_ by the DAMON maintainer. development or testing are queued in `damon/next
Sufficiently reviewed patches will be queued in mm-unstable [1]_ by the memory <https://git.kernel.org/sj/h/damon/next>` by the DAMON maintainer.
management subsystem maintainer. After more sufficient tests, the patches will Sufficiently reviewed patches will be queued in `mm-unstable
be queued in mm-stable [3]_ , and finally pull-requested to the mainline by the <https://git.kernel.org/akpm/mm/h/mm-unstable>` by the memory management
memory management subsystem maintainer. 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 [1]_ are queued by the memory 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 management subsystem maintainer. If the patches requires some patches in
damon/next tree [2]_ which not yet merged in mm-unstable, please make sure the damon/next `tree <https://git.kernel.org/sj/h/damon/next>` which not yet merged
requirement is clearly specified. in mm-unstable, please make sure the requirement is clearly specified.
Submit checklist addendum Submit checklist addendum
------------------------- -------------------------
@ -32,18 +36,27 @@ When making DAMON changes, you should do below.
- Build changes related outputs including kernel and documents. - Build changes related outputs including kernel and documents.
- Ensure the builds introduce no new errors or warnings. - Ensure the builds introduce no new errors or warnings.
- Run and ensure no new failures for DAMON selftests [4]_ and kunittests [5]_ . - Run and ensure no new failures for DAMON `selftests
<https://github.com/awslabs/damon-tests/blob/master/corr/run.sh#L49>` and
`kunittests
<https://github.com/awslabs/damon-tests/blob/master/corr/tests/kunit.sh>`.
Further doing below and putting the results will be helpful. Further doing below and putting the results will be helpful.
- Run damon-tests/corr [6]_ for normal changes. - Run `damon-tests/corr
- Run damon-tests/perf [7]_ for performance changes. <https://github.com/awslabs/damon-tests/tree/master/corr>` for normal
changes.
- Run `damon-tests/perf
<https://github.com/awslabs/damon-tests/tree/master/perf>` for performance
changes.
Key cycle dates Key cycle dates
--------------- ---------------
Patches can be sent anytime. Key cycle dates of the mm-unstable [1]_ and Patches can be sent anytime. Key cycle dates of the `mm-unstable
mm-stable [3]_ trees depend on the memory management subsystem maintainer. <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 Review cadence
-------------- --------------
@ -58,16 +71,17 @@ Mailing tool
Like many other Linux kernel subsystems, DAMON uses the mailing lists Like many other Linux kernel subsystems, DAMON uses the mailing lists
(damon@lists.linux.dev and linux-mm@kvack.org) as the major communication (damon@lists.linux.dev and linux-mm@kvack.org) as the major communication
channel. There is a simple tool called HacKerMaiL (``hkml``) [8]_ , which is channel. There is a simple tool called `HacKerMaiL
for people who are not very familiar with the mailing lists based <https://github.com/damonitor/hackermail>` (``hkml``), which is for people who
communication. The tool could be particularly helpful for DAMON community are not very familiar with the mailing lists based communication. The tool
members since it is developed and maintained by DAMON maintainer. The tool is could be particularly helpful for DAMON community members since it is developed
also officially announced to support DAMON and general Linux kernel development and maintained by DAMON maintainer. The tool is also officially announced to
workflow. support DAMON and general Linux kernel development workflow.
In other words, ``hkml`` [8]_ is a mailing tool for DAMON community, which In other words, `hkml <https://github.com/damonitor/hackermail>` is a mailing
DAMON maintainer is committed to support. Please feel free to try and report tool for DAMON community, which DAMON maintainer is committed to support.
issues or feature requests for the tool to the maintainer. Please feel free to try and report issues or feature requests for the tool to
the maintainer.
Community meetup Community meetup
---------------- ----------------
@ -83,17 +97,7 @@ members including the maintainer. The maintainer shares the available time
slots, and attendees should reserve one of those at least 24 hours before the slots, and attendees should reserve one of those at least 24 hours before the
time slot, by reaching out to the maintainer. time slot, by reaching out to the maintainer.
Schedules and available reservation time slots are available at the Google doc Schedules and available reservation time slots are available at the Google `doc
[9]_ . DAMON maintainer will also provide periodic reminder to the mailing <https://docs.google.com/document/d/1v43Kcj3ly4CYqmAkMaZzLiM2GEnWfgdGbZAH3mi2vpM/edit?usp=sharing>`.
list (damon@lists.linux.dev). DAMON maintainer will also provide periodic reminder to the mailing list
(damon@lists.linux.dev).
.. [1] https://git.kernel.org/akpm/mm/h/mm-unstable
.. [2] https://git.kernel.org/sj/h/damon/next
.. [3] https://git.kernel.org/akpm/mm/h/mm-stable
.. [4] https://github.com/damonitor/damon-tests/blob/master/corr/run.sh#L49
.. [5] https://github.com/damonitor/damon-tests/blob/master/corr/tests/kunit.sh
.. [6] https://github.com/damonitor/damon-tests/tree/master/corr
.. [7] https://github.com/damonitor/damon-tests/tree/master/perf
.. [8] https://github.com/damonitor/hackermail
.. [9] https://docs.google.com/document/d/1v43Kcj3ly4CYqmAkMaZzLiM2GEnWfgdGbZAH3mi2vpM/edit?usp=sharing