Skip to contentSkip to conversation

move_pages04: Fix the doc to fit RST format

PATCH In review Ma Xinjian via ltp 1 participant 3 messages Apr 1, 2025 – Apr 2, 2025 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 move_pages04: Fix the doc to fit RST format

---
 .../kernel/syscalls/move_pages/move_pages04.c | 28 +++++++++----------
 1 file changed, 14 insertions(+), 14 deletions(-)
testcases/kernel/syscalls/move_pages/move_pages04.c +14 -14
index e1ee733f0..3a56cdaca 100644
@@ -10,21 +10,21 @@
  *
  * [Algorithm]
  *
- *      1. Pass the address of a valid memory area where no page is
- *         mapped yet (not read/written), the address of a valid memory area
- *         where the shared zero page is mapped (read, but not written to)
- *         and the address of an invalid memory area as page addresses to
- *         move_pages().
- *      2. Check if the corresponding status for "no page mapped" is set to
- *         -ENOENT. Note that kernels >= 4.3 [1] and < 6.12 [2] wrongly returned
- *         -EFAULT by accident.
- *      3. Check if the corresponding status for "shared zero page" is set to:
- *         -EFAULT. Note that kernels < 4.3 [1] wrongly returned -ENOENT.
- *      4. Check if the corresponding status for "invalid memory area" is set
- *         to -EFAULT.
+ * #. Pass the address of a valid memory area where no page is
+ *    mapped yet (not read/written), the address of a valid memory area
+ *    where the shared zero page is mapped (read, but not written to)
+ *    and the address of an invalid memory area as page addresses to
+ *    move_pages().
+ * #. Check if the corresponding status for "no page mapped" is set to
+ *    -ENOENT. Note that kernels >= 4.3 [1] and < 6.12 [2] wrongly returned
+ *    -EFAULT by accident.
+ * #. Check if the corresponding status for "shared zero page" is set to:
+ *    -EFAULT. Note that kernels < 4.3 [1] wrongly returned -ENOENT.
+ * #. Check if the corresponding status for "invalid memory area" is set
+ *    to -EFAULT.
  *
- *   [1] d899844e9c98 "mm: fix status code which move_pages() returns for zero page"
- *   [2] 7dff875c9436 "mm/migrate: convert add_page_for_migration() from follow_page() to folio_walk"
+ * | [1] d899844e9c98 "mm: fix status code which move_pages() returns for zero page"
+ * | [2] 7dff875c9436 "mm/migrate: convert add_page_for_migration() from follow_page() to folio_walk"
  */
 
 #include <sys/mman.h>
Signature · 5 lines
2.47.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#1 lore raw

Hi!

Quoted 32 lines · Ma Xinjian via ltp
---
  .../kernel/syscalls/move_pages/move_pages04.c | 28 +++++++++----------
  1 file changed, 14 insertions(+), 14 deletions(-)
testcases/kernel/syscalls/move_pages/move_pages04.c +7 -12
index e1ee733f0..3a56cdaca 100644
@@ -10,21 +10,21 @@
   *
   * [Algorithm]
   *
- *      1. Pass the address of a valid memory area where no page is
- *         mapped yet (not read/written), the address of a valid memory area
- *         where the shared zero page is mapped (read, but not written to)
- *         and the address of an invalid memory area as page addresses to
- *         move_pages().
- *      2. Check if the corresponding status for "no page mapped" is set to
- *         -ENOENT. Note that kernels >= 4.3 [1] and < 6.12 [2] wrongly returned
- *         -EFAULT by accident.
- *      3. Check if the corresponding status for "shared zero page" is set to:
- *         -EFAULT. Note that kernels < 4.3 [1] wrongly returned -ENOENT.
- *      4. Check if the corresponding status for "invalid memory area" is set
- *         to -EFAULT.
+ * #. Pass the address of a valid memory area where no page is
+ *    mapped yet (not read/written), the address of a valid memory area
+ *    where the shared zero page is mapped (read, but not written to)
+ *    and the address of an invalid memory area as page addresses to
+ *    move_pages().
+ * #. Check if the corresponding status for "no page mapped" is set to
+ *    -ENOENT. Note that kernels >= 4.3 [1] and < 6.12 [2] wrongly returned

testcases/kernel/syscalls/move_pages/move_pages04.c line 27

Quoted 10 lines
testcases/kernel/syscalls/move_pages/move_pages04.c +7 -2
+ *    -EFAULT by accident.
+ * #. Check if the corresponding status for "shared zero page" is set to:
+ *    -EFAULT. Note that kernels < 4.3 [1] wrongly returned -ENOENT.
+ * #. Check if the corresponding status for "invalid memory area" is set
+ *    to -EFAULT.
   *
- *   [1] d899844e9c98 "mm: fix status code which move_pages() returns for zero page"
- *   [2] 7dff875c9436 "mm/migrate: convert add_page_for_migration() from follow_page() to folio_walk"
+ * | [1] d899844e9c98 "mm: fix status code which move_pages() returns for zero page"
+ * | [2] 7dff875c9436 "mm/migrate: convert add_page_for_migration() from follow_page() to folio_walk"

These two lines can be removed due to the presence of Tags table. If we want to keep it, then we should probably leave them inside a dotted list. Please take a look at:

https://linux-test-project.readthedocs.io/en/latest/users/test_catalog.html#move-pages04

Kind regards,
Andrea Cervesato

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp

A message that is not in the archive (sent off-list or not yet received): TY3PR01MB1207138B56801633191996B04E8AF2@TY3PR01MB12071.jpnprd01.prod.outlook.com

#3 lore raw

Hi Ma,

Quoted 4 lines · Xinjian Ma (Fujitsu)

Thanks for the review. IMO, It might be better to keep these two lines. This way, users can more intuitively match the kernel commits with the description.

Best regards
Ma

Sure. There's also an ongoing idea to integrate the commit comment in the table by fetching it automatically from the official kernel repository. I will implement that soon.

I will merge this patch as it is, thanks!

Andrea

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp