diff mbox series

[1/1] oom*: Turn docs to docparse

Message ID 20231220145047.422491-1-pvorel@suse.cz
State Superseded
Headers show
Series [1/1] oom*: Turn docs to docparse | expand

Commit Message

Petr Vorel Dec. 20, 2023, 2:50 p.m. UTC 
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
Hi,

I removed the paragraph which was the same for all tests, which is
generally good, but IMHO outdated (originates from 0db55077f in 2011,
e.g. 3 GB was in lib/oom.h #define LENGTH (3UL<<30), but the file was
removed in 4e217a398). Also tests differs, but the text is the same.

@Li If you have time, feel free to add more test description and push it
with yourself as the author.

Kind regards,
Petr

 testcases/kernel/mem/oom/oom01.c | 13 +++++--------
 testcases/kernel/mem/oom/oom02.c | 13 +++++--------
 testcases/kernel/mem/oom/oom03.c | 13 +++++--------
 testcases/kernel/mem/oom/oom04.c | 13 +++++--------
 testcases/kernel/mem/oom/oom05.c | 13 +++++--------
 5 files changed, 25 insertions(+), 40 deletions(-)

Comments

Li Wang Dec. 21, 2023, 8:52 a.m. UTC | #1 
Hi Petr,

On Wed, Dec 20, 2023 at 10:50 PM Petr Vorel <pvorel@suse.cz> wrote:

> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Hi,
>
> I removed the paragraph which was the same for all tests, which is
> generally good, but IMHO outdated (originates from 0db55077f in 2011,
> e.g. 3 GB was in lib/oom.h #define LENGTH (3UL<<30), but the file was
> removed in 4e217a398). Also tests differs, but the text is the same.
>
> @Li If you have time, feel free to add more test description and push it
> with yourself as the author.
>

Patch merged.

The OOM test code itself is easy to read and does not require excessive
comments.

Thank you and Merry Christmas!!!
Petr Vorel Dec. 21, 2023, 7:04 p.m. UTC | #2 
Hi Li,

> Hi Petr,

> On Wed, Dec 20, 2023 at 10:50 PM Petr Vorel <pvorel@suse.cz> wrote:

> > Signed-off-by: Petr Vorel <pvorel@suse.cz>
> > ---
> > Hi,

> > I removed the paragraph which was the same for all tests, which is
> > generally good, but IMHO outdated (originates from 0db55077f in 2011,
> > e.g. 3 GB was in lib/oom.h #define LENGTH (3UL<<30), but the file was
> > removed in 4e217a398). Also tests differs, but the text is the same.

> > @Li If you have time, feel free to add more test description and push it
> > with yourself as the author.


> Patch merged.

> The OOM test code itself is easy to read and does not require excessive
> comments.

> Thank you and Merry Christmas!!!

Thanks (not only for this patch, but for your hard work on LTP).

Enjoy upcoming Chinese New Year!

Kind regards,
Petr
diff mbox series

Patch

diff --git a/testcases/kernel/mem/oom/oom01.c b/testcases/kernel/mem/oom/oom01.c
index c30f2da0c..903785f93 100644
--- a/testcases/kernel/mem/oom/oom01.c
+++ b/testcases/kernel/mem/oom/oom01.c
@@ -1,16 +1,13 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Out Of Memory (OOM)
- *
- * The program is designed to cope with unpredictable like amount and
- * system physical memory, swap size and other VMM technology like KSM,
- * memcg, memory hotplug and so on which may affect the OOM
- * behaviours. It simply increase the memory consumption 3G each time
- * until all the available memory is consumed and OOM is triggered.
- *
  * Copyright (C) 2010-2017  Red Hat, Inc.
  * Copyright (c) Linux Test Project, 2011-2023
  */
+/*\
+ * [Description]
+ *
+ * Out Of Memory (OOM) test
+ */
 
 #include <sys/types.h>
 #include <sys/stat.h>
diff --git a/testcases/kernel/mem/oom/oom02.c b/testcases/kernel/mem/oom/oom02.c
index 7606260b5..087d61abe 100644
--- a/testcases/kernel/mem/oom/oom02.c
+++ b/testcases/kernel/mem/oom/oom02.c
@@ -1,16 +1,13 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Out Of Memory (OOM) for mempolicy - need NUMA system support
- *
- * The program is designed to cope with unpredictable like amount and
- * system physical memory, swap size and other VMM technology like KSM,
- * memcg, memory hotplug and so on which may affect the OOM
- * behaviours. It simply increase the memory consumption 3G each time
- * until all the available memory is consumed and OOM is triggered.
- *
  * Copyright (C) 2010-2017  Red Hat, Inc.
  * Copyright (c) Linux Test Project, 2011-2023
  */
+/*\
+ * [Description]
+ *
+ * Out Of Memory (OOM) test for mempolicy - need NUMA system support
+ */
 
 #include "config.h"
 #include <sys/types.h>
diff --git a/testcases/kernel/mem/oom/oom03.c b/testcases/kernel/mem/oom/oom03.c
index 6b9693359..1041a6a1d 100644
--- a/testcases/kernel/mem/oom/oom03.c
+++ b/testcases/kernel/mem/oom/oom03.c
@@ -1,16 +1,13 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Out Of Memory (OOM) for Memory Resource Controller
- *
- * The program is designed to cope with unpredictable like amount and
- * system physical memory, swap size and other VMM technology like KSM,
- * memcg, memory hotplug and so on which may affect the OOM
- * behaviours. It simply increase the memory consumption 3G each time
- * until all the available memory is consumed and OOM is triggered.
- *
  * Copyright (C) 2010-2017  Red Hat, Inc.
  * Copyright (c) Linux Test Project, 2011-2023
  */
+/*\
+ * [Description]
+ *
+ * Out Of Memory (OOM) test for Memory Resource Controller
+ */
 
 #include "config.h"
 #include <sys/types.h>
diff --git a/testcases/kernel/mem/oom/oom04.c b/testcases/kernel/mem/oom/oom04.c
index 418aa476d..3f0bcf7e2 100644
--- a/testcases/kernel/mem/oom/oom04.c
+++ b/testcases/kernel/mem/oom/oom04.c
@@ -1,16 +1,13 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Out Of Memory (OOM) for CPUSET
- *
- * The program is designed to cope with unpredictable like amount and
- * system physical memory, swap size and other VMM technology like KSM,
- * memcg, memory hotplug and so on which may affect the OOM
- * behaviours. It simply increase the memory consumption 3G each time
- * until all the available memory is consumed and OOM is triggered.
- *
  * Copyright (C) 2010-2017  Red Hat, Inc.
  * Copyright (c) Linux Test Project, 2011-2023
  */
+/*\
+ * [Description]
+ *
+ * Out Of Memory (OOM) test for CPUSET
+ */
 
 #include "config.h"
 #include <sys/types.h>
diff --git a/testcases/kernel/mem/oom/oom05.c b/testcases/kernel/mem/oom/oom05.c
index f360fa5a1..74f0f78b3 100644
--- a/testcases/kernel/mem/oom/oom05.c
+++ b/testcases/kernel/mem/oom/oom05.c
@@ -1,16 +1,13 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
- * Out Of Memory (OOM) for MEMCG and CPUSET
- *
- * The program is designed to cope with unpredictable like amount and
- * system physical memory, swap size and other VMM technology like KSM,
- * memcg, memory hotplug and so on which may affect the OOM
- * behaviours. It simply increase the memory consumption 3G each time
- * until all the available memory is consumed and OOM is triggered.
- *
  * Copyright (C) 2013-2017  Red Hat, Inc.
  * Copyright (c) Linux Test Project, 2014-2023
  */
+/*\
+ * [Description]
+ *
+ * Out Of Memory (OOM) test for MEMCG and CPUSET
+ */
 
 #include "config.h"
 #include <sys/types.h>