Commit 23a425aa authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton
Browse files

Docs/damon: use damonitor GitHub organization instead of awslabs 

Patch series "Docs/damon: update GitHub repo URLs and maintainer-profile".

Replace GitHub URLS on DAMON documents for none-kernel parts DAMON repos
with new ones[1] via the first patch.  With following two patches,
wordsmith maitnainer-profile for better readability, and document the
Google clendsar for bi-weekly meetups, respectively.

[1] https://lore.kernel.org/20240813232158.83903-1-sj@kernel.org


This patch (of 3):

GitHub repos for non-kernel parts of DAMON project including 'damo',
'damon-tests' and 'damoos' will be moved[1] from 'awslabs' org to
'damonitor', by 2024-09-05.  Update related URLs in kernel tree.

[1] https://lore.kernel.org/20240813232158.83903-1-sj@kernel.org

Link: https://lkml.kernel.org/r/20240826015741.80707-1-sj@kernel.org
Link: https://lkml.kernel.org/r/20240826015741.80707-2-sj@kernel.org


Signed-off-by: default avatarSeongJae 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: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 29868464

Documentation/admin-guide/mm/damon/start.rst

+2 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ Getting Started 
This document briefly describes how you can use DAMON by demonstrating its

default user space tool.  Please note that this document describes only a part

of its features for brevity.  Please refer to the usage `doc

<https://github.com/awslabs/damo/blob/next/USAGE.md>`_ of the tool for more

<https://github.com/damonitor/damo/blob/next/USAGE.md>`_ of the tool for more

details.
@@ -26,7 +26,7 @@ User Space Tool 


For the demonstration, we will use the default user space tool for DAMON,

called DAMON Operator (DAMO).  It is available at

https://github.com/awslabs/damo.  The examples below assume that ``damo`` is on

https://github.com/damonitor/damo.  The examples below assume that ``damo`` is on

your ``$PATH``.  It's not mandatory, though.



Because DAMO is using the sysfs interface (refer to :doc:`usage` for the

Documentation/admin-guide/mm/damon/usage.rst

+4 −4
Original line number Diff line number Diff line
@@ -7,19 +7,19 @@ Detailed Usages 
DAMON provides below interfaces for different users.



- *DAMON user space tool.*

  `This <https://github.com/awslabs/damo>`_ is for privileged people such as

  `This <https://github.com/damonitor/damo>`_ is for privileged people such as

  system administrators who want a just-working human-friendly interface.

  Using this, users can use the DAMON’s major features in a human-friendly way.

  It may not be highly tuned for special cases, though.  For more detail,

  please refer to its `usage document

  <https://github.com/awslabs/damo/blob/next/USAGE.md>`_.

  <https://github.com/damonitor/damo/blob/next/USAGE.md>`_.

- *sysfs interface.*

  :ref:`This <sysfs_interface>` is for privileged user space programmers who

  want more optimized use of DAMON.  Using this, users can use DAMON’s major

  features by reading from and writing to special sysfs files.  Therefore,

  you can write and use your personalized DAMON sysfs wrapper programs that

  reads/writes the sysfs files instead of you.  The `DAMON user space tool

  <https://github.com/awslabs/damo>`_ is one example of such programs.

  <https://github.com/damonitor/damo>`_ is one example of such programs.

- *Kernel Space Programming Interface.*

  :doc:`This </mm/damon/api>` is for kernel space programmers.  Using this,

  users can utilize every feature of DAMON most flexibly and efficiently by
@@ -543,7 +543,7 @@ memory rate becomes larger than 60%, or lower than 30%". :: 
    # echo 300 > watermarks/low



Please note that it's highly recommended to use user space tools like `damo

<https://github.com/awslabs/damo>`_ rather than manually reading and writing

<https://github.com/damonitor/damo>`_ rather than manually reading and writing

the files as above.  Above is only for an example.



.. _tracepoint:

Documentation/mm/damon/design.rst

+1 −1
Original line number Diff line number Diff line
@@ -586,7 +586,7 @@ API, and return the results to the user-space. 
The ABIs are designed to be used for user space applications development,

rather than human beings' fingers.  Human users are recommended to use such

user space tools.  One such Python-written user space tool is available at

Github (https://github.com/awslabs/damo), Pypi

Github (https://github.com/damonitor/damo), Pypi

(https://pypistats.org/packages/damo), and Fedora

(https://packages.fedoraproject.org/pkgs/python-damo/damo/).

Documentation/mm/damon/maintainer-profile.rst

+4 −4
Original line number Diff line number Diff line
@@ -91,9 +91,9 @@ 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/awslabs/damon-tests/blob/master/corr/run.sh#L49

.. [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

.. [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

Documentation/translations/zh_CN/admin-guide/mm/damon/start.rst

+2 −2
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ 


本文通过演示DAMON的默认用户空间工具，简要地介绍了如何使用DAMON。请注意，为了简洁

起见，本文档只描述了它的部分功能。更多细节请参考该工具的使用文档。

`doc <https://github.com/awslabs/damo/blob/next/USAGE.md>`_ .

`doc <https://github.com/damonitor/damo/blob/next/USAGE.md>`_ .





前提条件
@@ -31,7 +31,7 @@ 
------------



在演示中，我们将使用DAMON的默认用户空间工具，称为DAMON Operator（DAMO）。它可以在

https://github.com/awslabs/damo找到。下面的例子假设DAMO在你的$PATH上。当然，但

https://github.com/damonitor/damo找到。下面的例子假设DAMO在你的$PATH上。当然，但

这并不是强制性的。



因为DAMO使用了DAMON的sysfs接口（详情请参考:doc:`usage`），你应该确保