diff mbox series

[1/2] Docs/mm/damon/maintainer-profile: introduce HacKerMaiL

Message ID 20240620220337.76942-2-sj@kernel.org (mailing list archive)
State New
Headers show
Series Docs/damon/maintaier-profile: document a mailing tool and community meetup series | expand

Commit Message

SeongJae Park June 20, 2024, 10:03 p.m. UTC
Since DAMON has merged into the mainline, I periodically received some
questions around DAMON's mailing lists based workflow.  The workflow is
not different from the normal ones that well documented, but it is also
true that it is not always easy and familiar for everyone.

I personally overcame it by developing and using a simple tool, named
HacKerMaiL (hkml)[1].  Based on my experience, I believe it is matured
enough to be used for simple workflows like that of DAMON.  Actually
some DAMON contributors and Linux kernel developers other than myself
told me they are using the tool.

As DAMON maintainer, I also believe helping new DAMON community members
onboarding to the worklow is one of the most important parts of my
responsibilities.  For the reason, the tool is announced[2] to support
DAMON community.  To further increasing the visibility of the fact,
document the tool and the support plan on DAMON maintainer's profile.

[1] https://github.com/damonitor/hackermail
[2] https://github.com/damonitor/hackermail/commit/3909dad91301

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/mm/damon/maintainer-profile.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Randy Dunlap June 21, 2024, 5 a.m. UTC | #1
Hi,

On 6/20/24 3:03 PM, SeongJae Park wrote:
> Since DAMON has merged into the mainline, I periodically received some
> questions around DAMON's mailing lists based workflow.  The workflow is
> not different from the normal ones that well documented, but it is also
> true that it is not always easy and familiar for everyone.
> 
> I personally overcame it by developing and using a simple tool, named
> HacKerMaiL (hkml)[1].  Based on my experience, I believe it is matured
> enough to be used for simple workflows like that of DAMON.  Actually
> some DAMON contributors and Linux kernel developers other than myself
> told me they are using the tool.
> 
> As DAMON maintainer, I also believe helping new DAMON community members
> onboarding to the worklow is one of the most important parts of my
> responsibilities.  For the reason, the tool is announced[2] to support
> DAMON community.  To further increasing the visibility of the fact,
> document the tool and the support plan on DAMON maintainer's profile.
> 
> [1] https://github.com/damonitor/hackermail
> [2] https://github.com/damonitor/hackermail/commit/3909dad91301
> 
> Signed-off-by: SeongJae Park <sj@kernel.org>
> ---
>  Documentation/mm/damon/maintainer-profile.rst | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/Documentation/mm/damon/maintainer-profile.rst b/Documentation/mm/damon/maintainer-profile.rst
> index 8213cf61d38a..aede61f2d6a8 100644
> --- a/Documentation/mm/damon/maintainer-profile.rst
> +++ b/Documentation/mm/damon/maintainer-profile.rst
> @@ -53,6 +53,22 @@ 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 (``hkml``) [8]_ , which is
> +for people who are not very faimiliar with the mailing lists based

                               familiar

> +communication.  The tool could particularly helpful for DAMON community members

                   The tool could be particularly helpful

> +since it is developed and maintained by DAMON maintainer.  The tool is also
> +officially announced to support DAMON and general Linux kernel developement

                                                                  development

> +workflow.
> +
> +In other words, ``hkml`` [8]_ 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.
> +
>  
>  .. [1] https://git.kernel.org/akpm/mm/h/mm-unstable
>  .. [2] https://git.kernel.org/sj/h/damon/next
> @@ -61,3 +77,4 @@ of sending a patch.
>  .. [5] https://github.com/awslabs/damon-tests/blob/master/corr/tests/kunit.sh
>  .. [6] https://github.com/awslabs/damon-tests/tree/master/corr
>  .. [7] https://github.com/awslabs/damon-tests/tree/master/perf
> +.. [8] https://github.com/damonitor/hackermail
SeongJae Park June 21, 2024, 5:23 a.m. UTC | #2
Hi Randy,

On Thu, 20 Jun 2024 22:00:05 -0700 Randy Dunlap <rdunlap@infradead.org> wrote:

> Hi,
> 
> On 6/20/24 3:03 PM, SeongJae Park wrote:
[...]
> > +channel.  There is a simple tool called HacKerMaiL (``hkml``) [8]_ , which is
> > +for people who are not very faimiliar with the mailing lists based
> 
>                                familiar
> 
> > +communication.  The tool could particularly helpful for DAMON community members
> 
>                    The tool could be particularly helpful
> 
> > +since it is developed and maintained by DAMON maintainer.  The tool is also
> > +officially announced to support DAMON and general Linux kernel developement
> 
>                                                                   development
> 
> > +workflow.

Thank you so much.  I will send a new version tomorrow with fixes for these.

[...]
> -- 
> ~Randy


Thanks,
SJ
diff mbox series

Patch

diff --git a/Documentation/mm/damon/maintainer-profile.rst b/Documentation/mm/damon/maintainer-profile.rst
index 8213cf61d38a..aede61f2d6a8 100644
--- a/Documentation/mm/damon/maintainer-profile.rst
+++ b/Documentation/mm/damon/maintainer-profile.rst
@@ -53,6 +53,22 @@  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 (``hkml``) [8]_ , which is
+for people who are not very faimiliar with the mailing lists based
+communication.  The tool could 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 developement
+workflow.
+
+In other words, ``hkml`` [8]_ 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.
+
 
 .. [1] https://git.kernel.org/akpm/mm/h/mm-unstable
 .. [2] https://git.kernel.org/sj/h/damon/next
@@ -61,3 +77,4 @@  of sending a patch.
 .. [5] https://github.com/awslabs/damon-tests/blob/master/corr/tests/kunit.sh
 .. [6] https://github.com/awslabs/damon-tests/tree/master/corr
 .. [7] https://github.com/awslabs/damon-tests/tree/master/perf
+.. [8] https://github.com/damonitor/hackermail