Documentation/arm64: Add ptdump documentation
authorChaitanya S Prakash <chaitanyas.prakash@arm.com>
Mon, 19 Jun 2023 08:38:02 +0000 (14:08 +0530)
committerCatalin Marinas <catalin.marinas@arm.com>
Wed, 21 Jun 2023 13:30:42 +0000 (14:30 +0100)
commita0238ada560fce7fa1b5fb3ace60c0a575d3131a
treeac7061d44f47264d922026fabad0d89e5d323cd8
parent44c026a73be8038f03dbdeef028b642880cf1511
Documentation/arm64: Add ptdump documentation

ptdump is a debugfs interface used to dump the kernel page tables. It
provides a comprehensive overview about the kernel's virtual memory
layout, page table entries and associated page attributes. A document
detailing how to enable ptdump in the kernel and analyse its output has
been added.

Changes in V2:

- Corrected command to cat /sys/kernel/debug/kernel_page_tables

Changes in V1:

https://lore.kernel.org/all/20230613064845.1882177-1-chaitanyas.prakash@arm.com/

Cc: Will Deacon <will@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
CC: linux-arm-kernel@lists.infradead.org
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Chaitanya S Prakash <chaitanyas.prakash@arm.com>
Link: https://lore.kernel.org/r/20230619083802.76092-1-chaitanyas.prakash@arm.com
[catalin.marinas@arm.com: various minor fixups; sorted index.rst in alphabetical order]
Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
Documentation/arm64/index.rst
Documentation/arm64/ptdump.rst [new file with mode: 0644]