2023-06-13 09:59:03

by Jonathan Corbet

[permalink] [raw]
Subject: [PATCH 0/5] arm64: docs: Move the arm64 docs under Documentation/arch/

Architecture-specific documentation is being moved into Documentation/arch/
as a way of cleaning up the top-level documentation directory and making
the docs hierarchy more closely match the source hierarchy. Move
Documentation/arm64 into arch/ and fix all in-tree references.

Jonathan Corbet (5):
docs: arm64: Move arm64 documentation under Documentation/arch/
dt-bindings: fix dangling Documentation/arm64 reference
arm64: Fix dangling references to Documentation/arm64
mm: Fix a dangling Documentation/arm64 reference
perf arm-spe: Fix a dangling Documentation/arm64 reference

Documentation/ABI/testing/sysfs-devices-system-cpu | 2 +-
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/sysctl/kernel.rst | 2 +-
Documentation/{ => arch}/arm64/acpi_object_usage.rst | 0
Documentation/{ => arch}/arm64/amu.rst | 0
Documentation/{ => arch}/arm64/arm-acpi.rst | 2 +-
Documentation/{ => arch}/arm64/asymmetric-32bit.rst | 0
Documentation/{ => arch}/arm64/booting.rst | 0
.../{ => arch}/arm64/cpu-feature-registers.rst | 0
Documentation/{ => arch}/arm64/elf_hwcaps.rst | 12 ++++++------
Documentation/{ => arch}/arm64/features.rst | 0
Documentation/{ => arch}/arm64/hugetlbpage.rst | 0
Documentation/{ => arch}/arm64/index.rst | 0
Documentation/{ => arch}/arm64/kasan-offsets.sh | 0
.../{ => arch}/arm64/legacy_instructions.rst | 0
.../{ => arch}/arm64/memory-tagging-extension.rst | 2 +-
Documentation/{ => arch}/arm64/memory.rst | 0
Documentation/{ => arch}/arm64/perf.rst | 0
.../{ => arch}/arm64/pointer-authentication.rst | 0
Documentation/{ => arch}/arm64/silicon-errata.rst | 0
Documentation/{ => arch}/arm64/sme.rst | 2 +-
Documentation/{ => arch}/arm64/sve.rst | 2 +-
.../{ => arch}/arm64/tagged-address-abi.rst | 2 +-
Documentation/{ => arch}/arm64/tagged-pointers.rst | 2 +-
Documentation/arch/index.rst | 2 +-
.../devicetree/bindings/cpu/idle-states.yaml | 2 +-
.../translations/zh_CN/{ => arch}/arm64/amu.rst | 4 ++--
.../translations/zh_CN/{ => arch}/arm64/booting.txt | 4 ++--
.../zh_CN/{ => arch}/arm64/elf_hwcaps.rst | 10 +++++-----
.../zh_CN/{ => arch}/arm64/hugetlbpage.rst | 4 ++--
.../translations/zh_CN/{ => arch}/arm64/index.rst | 4 ++--
.../zh_CN/{ => arch}/arm64/legacy_instructions.txt | 4 ++--
.../translations/zh_CN/{ => arch}/arm64/memory.txt | 4 ++--
.../translations/zh_CN/{ => arch}/arm64/perf.rst | 4 ++--
.../zh_CN/{ => arch}/arm64/silicon-errata.txt | 4 ++--
.../zh_CN/{ => arch}/arm64/tagged-pointers.txt | 4 ++--
Documentation/translations/zh_CN/arch/index.rst | 2 +-
.../translations/zh_TW/{ => arch}/arm64/amu.rst | 4 ++--
.../translations/zh_TW/{ => arch}/arm64/booting.txt | 4 ++--
.../zh_TW/{ => arch}/arm64/elf_hwcaps.rst | 10 +++++-----
.../zh_TW/{ => arch}/arm64/hugetlbpage.rst | 4 ++--
.../translations/zh_TW/{ => arch}/arm64/index.rst | 4 ++--
.../zh_TW/{ => arch}/arm64/legacy_instructions.txt | 4 ++--
.../translations/zh_TW/{ => arch}/arm64/memory.txt | 4 ++--
.../translations/zh_TW/{ => arch}/arm64/perf.rst | 4 ++--
.../zh_TW/{ => arch}/arm64/silicon-errata.txt | 4 ++--
.../zh_TW/{ => arch}/arm64/tagged-pointers.txt | 4 ++--
Documentation/translations/zh_TW/index.rst | 2 +-
Documentation/virt/kvm/api.rst | 2 +-
MAINTAINERS | 2 +-
arch/arm64/Kconfig | 4 ++--
arch/arm64/include/asm/efi.h | 2 +-
arch/arm64/include/asm/image.h | 2 +-
arch/arm64/include/uapi/asm/sigcontext.h | 2 +-
arch/arm64/kernel/kexec_image.c | 2 +-
mm/mremap.c | 3 ++-
tools/perf/util/arm-spe-decoder/arm-spe-decoder.c | 2 +-
57 files changed, 76 insertions(+), 75 deletions(-)
rename Documentation/{ => arch}/arm64/acpi_object_usage.rst (100%)
rename Documentation/{ => arch}/arm64/amu.rst (100%)
rename Documentation/{ => arch}/arm64/arm-acpi.rst (99%)
rename Documentation/{ => arch}/arm64/asymmetric-32bit.rst (100%)
rename Documentation/{ => arch}/arm64/booting.rst (100%)
rename Documentation/{ => arch}/arm64/cpu-feature-registers.rst (100%)
rename Documentation/{ => arch}/arm64/elf_hwcaps.rst (96%)
rename Documentation/{ => arch}/arm64/features.rst (100%)
rename Documentation/{ => arch}/arm64/hugetlbpage.rst (100%)
rename Documentation/{ => arch}/arm64/index.rst (100%)
rename Documentation/{ => arch}/arm64/kasan-offsets.sh (100%)
rename Documentation/{ => arch}/arm64/legacy_instructions.rst (100%)
rename Documentation/{ => arch}/arm64/memory-tagging-extension.rst (99%)
rename Documentation/{ => arch}/arm64/memory.rst (100%)
rename Documentation/{ => arch}/arm64/perf.rst (100%)
rename Documentation/{ => arch}/arm64/pointer-authentication.rst (100%)
rename Documentation/{ => arch}/arm64/silicon-errata.rst (100%)
rename Documentation/{ => arch}/arm64/sme.rst (99%)
rename Documentation/{ => arch}/arm64/sve.rst (99%)
rename Documentation/{ => arch}/arm64/tagged-address-abi.rst (99%)
rename Documentation/{ => arch}/arm64/tagged-pointers.rst (98%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/amu.rst (97%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/booting.txt (98%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/elf_hwcaps.rst (94%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/hugetlbpage.rst (91%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/index.rst (63%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/legacy_instructions.txt (95%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/memory.txt (97%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/perf.rst (96%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/silicon-errata.txt (97%)
rename Documentation/translations/zh_CN/{ => arch}/arm64/tagged-pointers.txt (94%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/amu.rst (97%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/booting.txt (98%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/elf_hwcaps.rst (94%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/hugetlbpage.rst (91%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/index.rst (71%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/legacy_instructions.txt (96%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/memory.txt (97%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/perf.rst (96%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/silicon-errata.txt (97%)
rename Documentation/translations/zh_TW/{ => arch}/arm64/tagged-pointers.txt (95%)

--
2.40.1



2023-06-13 10:00:21

by Jonathan Corbet

[permalink] [raw]
Subject: [PATCH 3/5] arm64: Fix dangling references to Documentation/arm64

The arm64 documentation has moved under Documentation/arch/; fix up
references in the arm64 subtree to match.

Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
Cc: Ard Biesheuvel <[email protected]>
Cc: [email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
---
arch/arm64/Kconfig | 4 ++--
arch/arm64/include/asm/efi.h | 2 +-
arch/arm64/include/asm/image.h | 2 +-
arch/arm64/include/uapi/asm/sigcontext.h | 2 +-
arch/arm64/kernel/kexec_image.c | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/arch/arm64/Kconfig b/arch/arm64/Kconfig
index 343e1e1cae10..1746ac824b91 100644
--- a/arch/arm64/Kconfig
+++ b/arch/arm64/Kconfig
@@ -1585,7 +1585,7 @@ config ARM64_TAGGED_ADDR_ABI
When this option is enabled, user applications can opt in to a
relaxed ABI via prctl() allowing tagged addresses to be passed
to system calls as pointer arguments. For details, see
- Documentation/arm64/tagged-address-abi.rst.
+ Documentation/arch/arm64/tagged-address-abi.rst.

menuconfig COMPAT
bool "Kernel support for 32-bit EL0"
@@ -2047,7 +2047,7 @@ config ARM64_MTE
explicitly opt in. The mechanism for the userspace is
described in:

- Documentation/arm64/memory-tagging-extension.rst.
+ Documentation/arch/arm64/memory-tagging-extension.rst.

endmenu # "ARMv8.5 architectural features"

diff --git a/arch/arm64/include/asm/efi.h b/arch/arm64/include/asm/efi.h
index f86b157a5da3..ca3f72476c29 100644
--- a/arch/arm64/include/asm/efi.h
+++ b/arch/arm64/include/asm/efi.h
@@ -88,7 +88,7 @@ efi_status_t __efi_rt_asm_wrapper(void *, const char *, ...);
* guaranteed to cover the kernel Image.
*
* Since the EFI stub is part of the kernel Image, we can relax the
- * usual requirements in Documentation/arm64/booting.rst, which still
+ * usual requirements in Documentation/arch/arm64/booting.rst, which still
* apply to other bootloaders, and are required for some kernel
* configurations.
*/
diff --git a/arch/arm64/include/asm/image.h b/arch/arm64/include/asm/image.h
index c2b13213c720..c09cf942dc92 100644
--- a/arch/arm64/include/asm/image.h
+++ b/arch/arm64/include/asm/image.h
@@ -27,7 +27,7 @@

/*
* struct arm64_image_header - arm64 kernel image header
- * See Documentation/arm64/booting.rst for details
+ * See Documentation/arch/arm64/booting.rst for details
*
* @code0: Executable code, or
* @mz_header alternatively used for part of MZ header
diff --git a/arch/arm64/include/uapi/asm/sigcontext.h b/arch/arm64/include/uapi/asm/sigcontext.h
index 656a10ea6c67..f23c1dc3f002 100644
--- a/arch/arm64/include/uapi/asm/sigcontext.h
+++ b/arch/arm64/include/uapi/asm/sigcontext.h
@@ -177,7 +177,7 @@ struct zt_context {
* vector length beyond its initial architectural limit of 2048 bits
* (16 quadwords).
*
- * See linux/Documentation/arm64/sve.rst for a description of the VL/VQ
+ * See linux/Documentation/arch/arm64/sve.rst for a description of the VL/VQ
* terminology.
*/
#define SVE_VQ_BYTES __SVE_VQ_BYTES /* bytes per quadword */
diff --git a/arch/arm64/kernel/kexec_image.c b/arch/arm64/kernel/kexec_image.c
index 5ed6a585f21f..636be6715155 100644
--- a/arch/arm64/kernel/kexec_image.c
+++ b/arch/arm64/kernel/kexec_image.c
@@ -48,7 +48,7 @@ static void *image_load(struct kimage *image,

/*
* We require a kernel with an unambiguous Image header. Per
- * Documentation/arm64/booting.rst, this is the case when image_size
+ * Documentation/arch/arm64/booting.rst, this is the case when image_size
* is non-zero (practically speaking, since v3.17).
*/
h = (struct arm64_image_header *)kernel;
--
2.40.1


2023-06-13 10:02:11

by Jonathan Corbet

[permalink] [raw]
Subject: [PATCH 5/5] perf arm-spe: Fix a dangling Documentation/arm64 reference

The arm64 documentation has moved under Documentation/arch/. Fix up a
dangling reference to match.

Cc: Peter Zijlstra <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Arnaldo Carvalho de Melo <[email protected]>
Cc: Mark Rutland <[email protected]>
Cc: Alexander Shishkin <[email protected]>
Cc: Jiri Olsa <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
---
tools/perf/util/arm-spe-decoder/arm-spe-decoder.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c b/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
index f3918f290df5..ba807071d3c1 100644
--- a/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
+++ b/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
@@ -51,7 +51,7 @@ static u64 arm_spe_calc_ip(int index, u64 payload)
* (bits [63:56]) is assigned as top-byte tag; so we only can
* retrieve address value from bits [55:0].
*
- * According to Documentation/arm64/memory.rst, if detects the
+ * According to Documentation/arch/arm64/memory.rst, if detects the
* specific pattern in bits [55:52] of payload which falls in
* the kernel space, should fixup the top byte and this allows
* perf tool to parse DSO symbol for data address correctly.
--
2.40.1


2023-06-13 15:37:26

by Arnaldo Carvalho de Melo

[permalink] [raw]
Subject: Re: [PATCH 5/5] perf arm-spe: Fix a dangling Documentation/arm64 reference

Em Tue, Jun 13, 2023 at 03:46:06AM -0600, Jonathan Corbet escreveu:
> The arm64 documentation has moved under Documentation/arch/. Fix up a
> dangling reference to match.

Its not upstream nor in the perf-tools-next, so please merge it in the
tree where this documentation move took place.

Acked-by: Arnaldo Carvalho de Melo <[email protected]>

- Arnaldo

> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Arnaldo Carvalho de Melo <[email protected]>
> Cc: Mark Rutland <[email protected]>
> Cc: Alexander Shishkin <[email protected]>
> Cc: Jiri Olsa <[email protected]>
> Signed-off-by: Jonathan Corbet <[email protected]>
> ---
> tools/perf/util/arm-spe-decoder/arm-spe-decoder.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c b/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
> index f3918f290df5..ba807071d3c1 100644
> --- a/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
> +++ b/tools/perf/util/arm-spe-decoder/arm-spe-decoder.c
> @@ -51,7 +51,7 @@ static u64 arm_spe_calc_ip(int index, u64 payload)
> * (bits [63:56]) is assigned as top-byte tag; so we only can
> * retrieve address value from bits [55:0].
> *
> - * According to Documentation/arm64/memory.rst, if detects the
> + * According to Documentation/arch/arm64/memory.rst, if detects the
> * specific pattern in bits [55:52] of payload which falls in
> * the kernel space, should fixup the top byte and this allows
> * perf tool to parse DSO symbol for data address correctly.
> --
> 2.40.1
>

--

- Arnaldo

2023-06-14 07:18:06

by Catalin Marinas

[permalink] [raw]
Subject: Re: [PATCH 3/5] arm64: Fix dangling references to Documentation/arm64

On Tue, Jun 13, 2023 at 03:46:04AM -0600, Jonathan Corbet wrote:
> The arm64 documentation has moved under Documentation/arch/; fix up
> references in the arm64 subtree to match.
>
> Cc: Catalin Marinas <[email protected]>
> Cc: Will Deacon <[email protected]>
> Cc: Ard Biesheuvel <[email protected]>
> Cc: [email protected]
> Signed-off-by: Jonathan Corbet <[email protected]>

Acked-by: Catalin Marinas <[email protected]>

2023-06-14 07:18:39

by Catalin Marinas

[permalink] [raw]
Subject: Re: [PATCH 5/5] perf arm-spe: Fix a dangling Documentation/arm64 reference

On Tue, Jun 13, 2023 at 03:46:06AM -0600, Jonathan Corbet wrote:
> The arm64 documentation has moved under Documentation/arch/. Fix up a
> dangling reference to match.
>
> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Arnaldo Carvalho de Melo <[email protected]>
> Cc: Mark Rutland <[email protected]>
> Cc: Alexander Shishkin <[email protected]>
> Cc: Jiri Olsa <[email protected]>
> Signed-off-by: Jonathan Corbet <[email protected]>

Acked-by: Catalin Marinas <[email protected]>