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/arm into arch/ and fix all in-tree references.
This is one of the more intrusive moves (if not *the* most intrusive), but
the changes are all straighforward.
I'm happy to take these through the docs tree, but the potential for
conflicts might be less if they go through an Arm tree instead.
Jonathan Corbet (7):
arm: docs: Move Arm documentation to Documentation/arch/
arm: update in-source documentation references
arm64: Update Documentation/arm references
mips: update a reference to a moved Arm Document
crypto: update some Arm documentation references
docs: update some straggling Documentation/arm references
dt-bindings: Update Documentation/arm references
Documentation/{ => arch}/arm/arm.rst | 0
Documentation/{ => arch}/arm/booting.rst | 0
Documentation/{ => arch}/arm/cluster-pm-race-avoidance.rst | 0
Documentation/{ => arch}/arm/features.rst | 0
Documentation/{ => arch}/arm/firmware.rst | 0
.../{ => arch}/arm/google/chromebook-boot-flow.rst | 0
Documentation/{ => arch}/arm/index.rst | 0
Documentation/{ => arch}/arm/interrupts.rst | 0
Documentation/{ => arch}/arm/ixp4xx.rst | 0
Documentation/{ => arch}/arm/kernel_mode_neon.rst | 0
Documentation/{ => arch}/arm/kernel_user_helpers.rst | 0
Documentation/{ => arch}/arm/keystone/knav-qmss.rst | 0
Documentation/{ => arch}/arm/keystone/overview.rst | 0
Documentation/{ => arch}/arm/marvell.rst | 0
Documentation/{ => arch}/arm/mem_alignment.rst | 0
Documentation/{ => arch}/arm/memory.rst | 0
Documentation/{ => arch}/arm/microchip.rst | 0
Documentation/{ => arch}/arm/netwinder.rst | 0
Documentation/{ => arch}/arm/nwfpe/index.rst | 0
Documentation/{ => arch}/arm/nwfpe/netwinder-fpe.rst | 0
Documentation/{ => arch}/arm/nwfpe/notes.rst | 0
Documentation/{ => arch}/arm/nwfpe/nwfpe.rst | 0
Documentation/{ => arch}/arm/nwfpe/todo.rst | 0
Documentation/{ => arch}/arm/omap/dss.rst | 0
Documentation/{ => arch}/arm/omap/index.rst | 0
Documentation/{ => arch}/arm/omap/omap.rst | 0
Documentation/{ => arch}/arm/omap/omap_pm.rst | 0
Documentation/{ => arch}/arm/porting.rst | 0
Documentation/{ => arch}/arm/pxa/mfp.rst | 0
Documentation/{ => arch}/arm/sa1100/assabet.rst | 0
Documentation/{ => arch}/arm/sa1100/cerf.rst | 0
Documentation/{ => arch}/arm/sa1100/index.rst | 0
Documentation/{ => arch}/arm/sa1100/lart.rst | 0
Documentation/{ => arch}/arm/sa1100/serial_uart.rst | 0
.../{ => arch}/arm/samsung/bootloader-interface.rst | 0
.../{ => arch}/arm/samsung/clksrc-change-registers.awk | 0
Documentation/{ => arch}/arm/samsung/gpio.rst | 0
Documentation/{ => arch}/arm/samsung/index.rst | 0
Documentation/{ => arch}/arm/samsung/overview.rst | 0
Documentation/{ => arch}/arm/setup.rst | 0
Documentation/{ => arch}/arm/spear/overview.rst | 0
Documentation/{ => arch}/arm/sti/overview.rst | 0
Documentation/{ => arch}/arm/sti/stih407-overview.rst | 0
Documentation/{ => arch}/arm/sti/stih418-overview.rst | 0
Documentation/{ => arch}/arm/stm32/overview.rst | 0
.../{ => arch}/arm/stm32/stm32-dma-mdma-chaining.rst | 0
Documentation/{ => arch}/arm/stm32/stm32f429-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32f746-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32f769-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32h743-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32h750-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32mp13-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32mp151-overview.rst | 0
Documentation/{ => arch}/arm/stm32/stm32mp157-overview.rst | 0
Documentation/{ => arch}/arm/sunxi.rst | 0
Documentation/{ => arch}/arm/sunxi/clocks.rst | 0
Documentation/{ => arch}/arm/swp_emulation.rst | 0
Documentation/{ => arch}/arm/tcm.rst | 0
Documentation/{ => arch}/arm/uefi.rst | 0
Documentation/{ => arch}/arm/vfp/release-notes.rst | 0
Documentation/{ => arch}/arm/vlocks.rst | 0
Documentation/arch/index.rst | 2 +-
Documentation/devicetree/bindings/arm/xen.txt | 2 +-
Documentation/translations/zh_CN/arm/Booting | 4 ++--
.../translations/zh_CN/arm/kernel_user_helpers.txt | 4 ++--
MAINTAINERS | 6 +++---
arch/arm/Kconfig | 2 +-
arch/arm/common/mcpm_entry.c | 2 +-
arch/arm/common/mcpm_head.S | 2 +-
arch/arm/common/vlock.S | 2 +-
arch/arm/include/asm/setup.h | 2 +-
arch/arm/include/uapi/asm/setup.h | 2 +-
arch/arm/kernel/entry-armv.S | 2 +-
arch/arm/mach-exynos/common.h | 2 +-
arch/arm/mach-sti/Kconfig | 2 +-
arch/arm/mm/Kconfig | 4 ++--
arch/arm/tools/mach-types | 2 +-
arch/arm64/Kconfig | 2 +-
arch/arm64/kernel/kuser32.S | 2 +-
arch/mips/bmips/setup.c | 5 ++++-
drivers/crypto/allwinner/sun4i-ss/sun4i-ss-cipher.c | 2 +-
drivers/crypto/allwinner/sun4i-ss/sun4i-ss-core.c | 2 +-
drivers/crypto/allwinner/sun4i-ss/sun4i-ss-hash.c | 2 +-
drivers/crypto/allwinner/sun4i-ss/sun4i-ss.h | 2 +-
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c | 2 +-
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c | 2 +-
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c | 2 +-
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c | 2 +-
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c | 2 +-
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c | 2 +-
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c | 2 +-
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-hash.c | 2 +-
drivers/crypto/allwinner/sun8i-ss/sun8i-ss-prng.c | 2 +-
drivers/input/touchscreen/sun4i-ts.c | 2 +-
drivers/pwm/pwm-atmel.c | 2 +-
drivers/pwm/pwm-pxa.c | 2 +-
drivers/tty/serial/Kconfig | 4 ++--
97 files changed, 45 insertions(+), 42 deletions(-)
rename Documentation/{ => arch}/arm/arm.rst (100%)
rename Documentation/{ => arch}/arm/booting.rst (100%)
rename Documentation/{ => arch}/arm/cluster-pm-race-avoidance.rst (100%)
rename Documentation/{ => arch}/arm/features.rst (100%)
rename Documentation/{ => arch}/arm/firmware.rst (100%)
rename Documentation/{ => arch}/arm/google/chromebook-boot-flow.rst (100%)
rename Documentation/{ => arch}/arm/index.rst (100%)
rename Documentation/{ => arch}/arm/interrupts.rst (100%)
rename Documentation/{ => arch}/arm/ixp4xx.rst (100%)
rename Documentation/{ => arch}/arm/kernel_mode_neon.rst (100%)
rename Documentation/{ => arch}/arm/kernel_user_helpers.rst (100%)
rename Documentation/{ => arch}/arm/keystone/knav-qmss.rst (100%)
rename Documentation/{ => arch}/arm/keystone/overview.rst (100%)
rename Documentation/{ => arch}/arm/marvell.rst (100%)
rename Documentation/{ => arch}/arm/mem_alignment.rst (100%)
rename Documentation/{ => arch}/arm/memory.rst (100%)
rename Documentation/{ => arch}/arm/microchip.rst (100%)
rename Documentation/{ => arch}/arm/netwinder.rst (100%)
rename Documentation/{ => arch}/arm/nwfpe/index.rst (100%)
rename Documentation/{ => arch}/arm/nwfpe/netwinder-fpe.rst (100%)
rename Documentation/{ => arch}/arm/nwfpe/notes.rst (100%)
rename Documentation/{ => arch}/arm/nwfpe/nwfpe.rst (100%)
rename Documentation/{ => arch}/arm/nwfpe/todo.rst (100%)
rename Documentation/{ => arch}/arm/omap/dss.rst (100%)
rename Documentation/{ => arch}/arm/omap/index.rst (100%)
rename Documentation/{ => arch}/arm/omap/omap.rst (100%)
rename Documentation/{ => arch}/arm/omap/omap_pm.rst (100%)
rename Documentation/{ => arch}/arm/porting.rst (100%)
rename Documentation/{ => arch}/arm/pxa/mfp.rst (100%)
rename Documentation/{ => arch}/arm/sa1100/assabet.rst (100%)
rename Documentation/{ => arch}/arm/sa1100/cerf.rst (100%)
rename Documentation/{ => arch}/arm/sa1100/index.rst (100%)
rename Documentation/{ => arch}/arm/sa1100/lart.rst (100%)
rename Documentation/{ => arch}/arm/sa1100/serial_uart.rst (100%)
rename Documentation/{ => arch}/arm/samsung/bootloader-interface.rst (100%)
rename Documentation/{ => arch}/arm/samsung/clksrc-change-registers.awk (100%)
rename Documentation/{ => arch}/arm/samsung/gpio.rst (100%)
rename Documentation/{ => arch}/arm/samsung/index.rst (100%)
rename Documentation/{ => arch}/arm/samsung/overview.rst (100%)
rename Documentation/{ => arch}/arm/setup.rst (100%)
rename Documentation/{ => arch}/arm/spear/overview.rst (100%)
rename Documentation/{ => arch}/arm/sti/overview.rst (100%)
rename Documentation/{ => arch}/arm/sti/stih407-overview.rst (100%)
rename Documentation/{ => arch}/arm/sti/stih418-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32-dma-mdma-chaining.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32f429-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32f746-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32f769-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32h743-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32h750-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32mp13-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32mp151-overview.rst (100%)
rename Documentation/{ => arch}/arm/stm32/stm32mp157-overview.rst (100%)
rename Documentation/{ => arch}/arm/sunxi.rst (100%)
rename Documentation/{ => arch}/arm/sunxi/clocks.rst (100%)
rename Documentation/{ => arch}/arm/swp_emulation.rst (100%)
rename Documentation/{ => arch}/arm/tcm.rst (100%)
rename Documentation/{ => arch}/arm/uefi.rst (100%)
rename Documentation/{ => arch}/arm/vfp/release-notes.rst (100%)
rename Documentation/{ => arch}/arm/vlocks.rst (100%)
--
2.40.1
The Arm documentation has moved to Documentation/arch/arm; update
references under arch/arm64 to match.
Cc: Catalin Marinas <[email protected]>
Cc: Will Deacon <[email protected]>
Cc: [email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
---
arch/arm64/Kconfig | 2 +-
arch/arm64/kernel/kuser32.S | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/arch/arm64/Kconfig b/arch/arm64/Kconfig
index b1201d25a8a4..377f50dda2de 100644
--- a/arch/arm64/Kconfig
+++ b/arch/arm64/Kconfig
@@ -1619,7 +1619,7 @@ config KUSER_HELPERS
the system. This permits binaries to be run on ARMv4 through
to ARMv8 without modification.
- See Documentation/arm/kernel_user_helpers.rst for details.
+ See Documentation/arch/arm/kernel_user_helpers.rst for details.
However, the fixed address nature of these helpers can be used
by ROP (return orientated programming) authors when creating
diff --git a/arch/arm64/kernel/kuser32.S b/arch/arm64/kernel/kuser32.S
index 692e9d2e31e5..af046ceac22d 100644
--- a/arch/arm64/kernel/kuser32.S
+++ b/arch/arm64/kernel/kuser32.S
@@ -10,7 +10,7 @@
* aarch32_setup_additional_pages() and are provided for compatibility
* reasons with 32 bit (aarch32) applications that need them.
*
- * See Documentation/arm/kernel_user_helpers.rst for formal definitions.
+ * See Documentation/arch/arm/kernel_user_helpers.rst for formal definitions.
*/
#include <asm/unistd.h>
--
2.40.1
On Fri, May 19, 2023 at 10:46:03AM -0600, Jonathan Corbet wrote:
> The Arm documentation has moved to Documentation/arch/arm; update
> references under arch/arm64 to match.
>
> Cc: Catalin Marinas <[email protected]>
> Cc: Will Deacon <[email protected]>
> Cc: [email protected]
> Signed-off-by: Jonathan Corbet <[email protected]>
Acked-by: Catalin Marinas <[email protected]>