LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH 0/5] mm, mm/damon: Trivial fixes
@ 2021-09-17 12:39 SeongJae Park
  2021-09-17 12:39 ` [PATCH 1/5] Documentation/vm: Move user guides to admin-guide/mm/ SeongJae Park
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm; +Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel

This commit fixes trivial nits in mm documentation and DAMON.

SeongJae Park (5):
  Documentation/vm: Move user guides to admin-guide/mm/
  MAINTAINERS: Update SeongJae's email address
  docs/vm/damon: Remove broken reference
  include/linux/damon.h: Fix kernel-doc comments for 'damon_callback'
  mm/damon/core: Print kdamond start log in debug mode only

 Documentation/admin-guide/mm/index.rst        |  2 ++
 .../{vm => admin-guide/mm}/swap_numa.rst      |  0
 .../{vm => admin-guide/mm}/zswap.rst          |  0
 Documentation/vm/damon/index.rst              |  1 -
 Documentation/vm/index.rst                    | 26 ++++---------------
 MAINTAINERS                                   |  2 +-
 include/linux/damon.h                         |  6 ++---
 mm/damon/core.c                               |  2 +-
 8 files changed, 12 insertions(+), 27 deletions(-)
 rename Documentation/{vm => admin-guide/mm}/swap_numa.rst (100%)
 rename Documentation/{vm => admin-guide/mm}/zswap.rst (100%)

-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 1/5] Documentation/vm: Move user guides to admin-guide/mm/
  2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
@ 2021-09-17 12:39 ` SeongJae Park
  2021-09-17 12:39 ` [PATCH 2/5] MAINTAINERS: Update SeongJae's email address SeongJae Park
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm
  Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel,
	SeongJae Park

From: SeongJae Park <sjpark@amazon.de>

Most memory management user guide documents are in 'admin-guide/mm/',
but two of those are in 'vm/'.  This commit moves the two docs into
'admin-guide/mm' for easier documents finding.

Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
 Documentation/admin-guide/mm/index.rst        |  2 ++
 .../{vm => admin-guide/mm}/swap_numa.rst      |  0
 .../{vm => admin-guide/mm}/zswap.rst          |  0
 Documentation/vm/index.rst                    | 26 ++++---------------
 4 files changed, 7 insertions(+), 21 deletions(-)
 rename Documentation/{vm => admin-guide/mm}/swap_numa.rst (100%)
 rename Documentation/{vm => admin-guide/mm}/zswap.rst (100%)

diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst
index cbd19d5e625f..c21b5823f126 100644
--- a/Documentation/admin-guide/mm/index.rst
+++ b/Documentation/admin-guide/mm/index.rst
@@ -37,5 +37,7 @@ the Linux memory management.
    numaperf
    pagemap
    soft-dirty
+   swap_numa
    transhuge
    userfaultfd
+   zswap
diff --git a/Documentation/vm/swap_numa.rst b/Documentation/admin-guide/mm/swap_numa.rst
similarity index 100%
rename from Documentation/vm/swap_numa.rst
rename to Documentation/admin-guide/mm/swap_numa.rst
diff --git a/Documentation/vm/zswap.rst b/Documentation/admin-guide/mm/zswap.rst
similarity index 100%
rename from Documentation/vm/zswap.rst
rename to Documentation/admin-guide/mm/zswap.rst
diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
index b51f0d8992f8..6f5ffef4b716 100644
--- a/Documentation/vm/index.rst
+++ b/Documentation/vm/index.rst
@@ -3,27 +3,11 @@ Linux Memory Management Documentation
 =====================================
 
 This is a collection of documents about the Linux memory management (mm)
-subsystem.  If you are looking for advice on simply allocating memory,
-see the :ref:`memory_allocation`.
-
-User guides for MM features
-===========================
-
-The following documents provide guides for controlling and tuning
-various features of the Linux memory management
-
-.. toctree::
-   :maxdepth: 1
-
-   swap_numa
-   zswap
-
-Kernel developers MM documentation
-==================================
-
-The below documents describe MM internals with different level of
-details ranging from notes and mailing list responses to elaborate
-descriptions of data structures and algorithms.
+subsystem internals with different level of details ranging from notes and
+mailing list responses for elaborating descriptions of data structures and
+algorithms.  If you are looking for advice on simply allocating memory, see the
+:ref:`memory_allocation`.  For controlling and tuning guides, see the
+:doc:`admin guide <../admin-guide/mm/index>`.
 
 .. toctree::
    :maxdepth: 1
-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 2/5] MAINTAINERS: Update SeongJae's email address
  2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
  2021-09-17 12:39 ` [PATCH 1/5] Documentation/vm: Move user guides to admin-guide/mm/ SeongJae Park
@ 2021-09-17 12:39 ` SeongJae Park
  2021-09-17 12:39 ` [PATCH 3/5] docs/vm/damon: Remove broken reference SeongJae Park
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm; +Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel

This commit updates SeongJae's email address in MAINTAINERS file to his
preferred one.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index d05b4e35e63f..774b6aac16ef 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -5163,7 +5163,7 @@ F:	net/ax25/ax25_timer.c
 F:	net/ax25/sysctl_net_ax25.c
 
 DATA ACCESS MONITOR
-M:	SeongJae Park <sjpark@amazon.de>
+M:	SeongJae Park <sj@kernel.org>
 L:	linux-mm@kvack.org
 S:	Maintained
 F:	Documentation/admin-guide/mm/damon/
-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 3/5] docs/vm/damon: Remove broken reference
  2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
  2021-09-17 12:39 ` [PATCH 1/5] Documentation/vm: Move user guides to admin-guide/mm/ SeongJae Park
  2021-09-17 12:39 ` [PATCH 2/5] MAINTAINERS: Update SeongJae's email address SeongJae Park
@ 2021-09-17 12:39 ` SeongJae Park
  2021-09-17 12:39 ` [PATCH 4/5] include/linux/damon.h: Fix kernel-doc comments for 'damon_callback' SeongJae Park
  2021-09-17 12:39 ` [PATCH 5/5] mm/damon/core: Print kdamond start log in debug mode only SeongJae Park
  4 siblings, 0 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm
  Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel,
	SeongJae Park

From: SeongJae Park <sjpark@amazon.de>

Building DAMON documents warns for a reference to nonexisting doc, as
below:

    $ time make htmldocs
    [...]
    Documentation/vm/damon/index.rst:24: WARNING: toctree contains reference to nonexisting document 'vm/damon/plans'

This commit fixes the warning by removing the wrong reference.

Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
 Documentation/vm/damon/index.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/vm/damon/index.rst b/Documentation/vm/damon/index.rst
index a2858baf3bf1..48c0bbff98b2 100644
--- a/Documentation/vm/damon/index.rst
+++ b/Documentation/vm/damon/index.rst
@@ -27,4 +27,3 @@ workloads and systems.
    faq
    design
    api
-   plans
-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 4/5] include/linux/damon.h: Fix kernel-doc comments for 'damon_callback'
  2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
                   ` (2 preceding siblings ...)
  2021-09-17 12:39 ` [PATCH 3/5] docs/vm/damon: Remove broken reference SeongJae Park
@ 2021-09-17 12:39 ` SeongJae Park
  2021-09-17 12:39 ` [PATCH 5/5] mm/damon/core: Print kdamond start log in debug mode only SeongJae Park
  4 siblings, 0 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm
  Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel,
	SeongJae Park

From: SeongJae Park <sjpark@amazon.de>

A few Kernel-doc comments in 'damon.h' are broken.  This commit fixes
those.

Signed-off-by: SeongJae Park <sjpark@amazon.de>
---
 include/linux/damon.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/damon.h b/include/linux/damon.h
index d68b67b8d458..755d70804705 100644
--- a/include/linux/damon.h
+++ b/include/linux/damon.h
@@ -62,7 +62,7 @@ struct damon_target {
 struct damon_ctx;
 
 /**
- * struct damon_primitive	Monitoring primitives for given use cases.
+ * struct damon_primitive - Monitoring primitives for given use cases.
  *
  * @init:			Initialize primitive-internal data structures.
  * @update:			Update primitive-internal data structures.
@@ -108,8 +108,8 @@ struct damon_primitive {
 	void (*cleanup)(struct damon_ctx *context);
 };
 
-/*
- * struct damon_callback	Monitoring events notification callbacks.
+/**
+ * struct damon_callback - Monitoring events notification callbacks.
  *
  * @before_start:	Called before starting the monitoring.
  * @after_sampling:	Called after each sampling.
-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 5/5] mm/damon/core: Print kdamond start log in debug mode only
  2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
                   ` (3 preceding siblings ...)
  2021-09-17 12:39 ` [PATCH 4/5] include/linux/damon.h: Fix kernel-doc comments for 'damon_callback' SeongJae Park
@ 2021-09-17 12:39 ` SeongJae Park
  4 siblings, 0 replies; 6+ messages in thread
From: SeongJae Park @ 2021-09-17 12:39 UTC (permalink / raw)
  To: akpm; +Cc: corbet, sj, linux-damon, linux-mm, linux-doc, linux-kernel

Logging of kdamond startup is using 'pr_info()' unnecessarily.  This
commit makes it to use 'pr_debug()' instead.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 mm/damon/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/damon/core.c b/mm/damon/core.c
index 30e9211f494a..874558a790a0 100644
--- a/mm/damon/core.c
+++ b/mm/damon/core.c
@@ -653,7 +653,7 @@ static int kdamond_fn(void *data)
 	unsigned long sz_limit = 0;
 
 	mutex_lock(&ctx->kdamond_lock);
-	pr_info("kdamond (%d) starts\n", ctx->kdamond->pid);
+	pr_debug("kdamond (%d) starts\n", ctx->kdamond->pid);
 	mutex_unlock(&ctx->kdamond_lock);
 
 	if (ctx->primitive.init)
-- 
2.17.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-09-17 12:40 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-17 12:39 [PATCH 0/5] mm, mm/damon: Trivial fixes SeongJae Park
2021-09-17 12:39 ` [PATCH 1/5] Documentation/vm: Move user guides to admin-guide/mm/ SeongJae Park
2021-09-17 12:39 ` [PATCH 2/5] MAINTAINERS: Update SeongJae's email address SeongJae Park
2021-09-17 12:39 ` [PATCH 3/5] docs/vm/damon: Remove broken reference SeongJae Park
2021-09-17 12:39 ` [PATCH 4/5] include/linux/damon.h: Fix kernel-doc comments for 'damon_callback' SeongJae Park
2021-09-17 12:39 ` [PATCH 5/5] mm/damon/core: Print kdamond start log in debug mode only SeongJae Park

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).