mbox series

[v2,0/2] docs/mm: remove useless markup

Message ID 20230131144220.822989-1-rppt@kernel.org
Headers
Series docs/mm: remove useless markup |

Message

Mike Rapoport Jan. 31, 2023, 2:42 p.m. UTC 
  From: "Mike Rapoport (IBM)" <rppt@kernel.org>

Hi,

Following Jon's gripe about top-of-file labels [1], I went ahead and
updated admin-guide/mm and mm docs to use file names instead of labels for
document cross-referencing.

[1] https://lore.kernel.org/all/87r0vh9n17.fsf@meer.lwn.net

v2:
* fix missed reference in zn_CH translation (kbuild)

v1: https://lore.kernel.org/all/20230129075018.207678-1-rppt@kernel.org

Mike Rapoport (IBM) (2):
  docs/admin-guide/mm: remove useless markup
  docs/mm: remove useless markup

 Documentation/admin-guide/mm/concepts.rst           | 13 +++++--------
 Documentation/admin-guide/mm/hugetlbpage.rst        |  4 +---
 Documentation/admin-guide/mm/idle_page_tracking.rst |  7 ++-----
 Documentation/admin-guide/mm/index.rst              |  3 +--
 Documentation/admin-guide/mm/ksm.rst                |  2 --
 Documentation/admin-guide/mm/memory-hotplug.rst     |  2 --
 Documentation/admin-guide/mm/numa_memory_policy.rst |  2 --
 Documentation/admin-guide/mm/numaperf.rst           |  2 --
 Documentation/admin-guide/mm/pagemap.rst            | 11 ++++-------
 Documentation/admin-guide/mm/shrinker_debugfs.rst   |  2 --
 Documentation/admin-guide/mm/soft-dirty.rst         |  2 --
 Documentation/admin-guide/mm/swap_numa.rst          |  2 --
 Documentation/admin-guide/mm/transhuge.rst          |  2 --
 Documentation/admin-guide/mm/userfaultfd.rst        |  2 --
 Documentation/admin-guide/mm/zswap.rst              |  2 --
 Documentation/mm/active_mm.rst                      |  2 --
 Documentation/mm/arch_pgtable_helpers.rst           |  2 --
 Documentation/mm/balance.rst                        |  2 --
 Documentation/mm/free_page_reporting.rst            |  2 --
 Documentation/mm/frontswap.rst                      |  2 --
 Documentation/mm/highmem.rst                        |  2 --
 Documentation/mm/hmm.rst                            |  4 +---
 Documentation/mm/hugetlbfs_reserv.rst               |  4 +---
 Documentation/mm/hwpoison.rst                       |  2 --
 Documentation/mm/ksm.rst                            |  4 +---
 Documentation/mm/memory-model.rst                   |  2 --
 Documentation/mm/mmu_notifier.rst                   |  2 --
 Documentation/mm/numa.rst                           |  4 +---
 Documentation/mm/page_frags.rst                     |  2 --
 Documentation/mm/page_migration.rst                 |  6 ++----
 Documentation/mm/page_owner.rst                     |  2 --
 Documentation/mm/page_table_check.rst               |  2 --
 Documentation/mm/remap_file_pages.rst               |  2 --
 Documentation/mm/slub.rst                           |  2 --
 Documentation/mm/split_page_table_lock.rst          |  2 --
 Documentation/mm/transhuge.rst                      |  2 --
 Documentation/mm/unevictable-lru.rst                |  2 --
 Documentation/mm/z3fold.rst                         |  2 --
 Documentation/mm/zsmalloc.rst                       |  2 --
 .../translations/zh_CN/admin-guide/mm/index.rst     |  2 +-
 40 files changed, 20 insertions(+), 100 deletions(-)


base-commit: b7bfaa761d760e72a969d116517eaa12e404c262

Comments

Jonathan Corbet Jan. 31, 2023, 8:29 p.m. UTC | #1 
Mike Rapoport <rppt@kernel.org> writes:

> From: "Mike Rapoport (IBM)" <rppt@kernel.org>
>
> Hi,
>
> Following Jon's gripe about top-of-file labels [1], I went ahead and
> updated admin-guide/mm and mm docs to use file names instead of labels for
> document cross-referencing.
>
> [1] https://lore.kernel.org/all/87r0vh9n17.fsf@meer.lwn.net

This is a nice cleanup and I want to apply it, but it adds some
warnings:

> Documentation/mm/physical_memory.rst:61: WARNING: undefined label: page_migration
> Documentation/mm/physical_memory.rst:61: WARNING: undefined label: admin_guide_memory_hotplug
> Documentation/translations/zh_CN/mm/hmm.rst:251: WARNING: undefined label: page_migration
> Documentation/translations/zh_CN/mm/hugetlbfs_reserv.rst:18: WARNING: undefined label: hugetlbpage
> Documentation/translations/zh_CN/mm/numa.rst:76: WARNING: undefined label: numa_memory_policy

It looks like a few references didn't get fixed?

Thanks,

jon