Move the Arm architecture documentation under Documentation/arch/. This

brings some order to the documentation directory, declutters the top-level
 directory, and makes the documentation organization more closely match that
 of the source.
 -----BEGIN PGP SIGNATURE-----
 
 iQFDBAABCAAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmSbDRwPHGNvcmJldEBs
 d24ubmV0AAoJEBdDWhNsDH5Y0b0H/A69Yxns1Bf465rNNINREaWWzJzIPGyJax9F
 7x2zYphL2BLmDysHDvBpP858ytA4qzmqS7TopI1zjqTS6Uh4qTfsQTWNfk536Oyi
 XOkKONPAqzuk4Pvsam4t46lMb5xqkyy7FcsZSp25ona7t8nLiTkoxTWIabvFziFN
 F7qJ/u/Uzck53FgR2Xtss4vrkcWDTgva5SzQUhoxGfEqjEOoQi7CfqLQC468wfOt
 /XlBCnTRPnZ6bFiD/9QHU+D0setWVBs0IJHH2ogDlx/FHOvp83haJHVRFNYpx0Gd
 UY72gEbovzYauKMaa6azBo+1Tje6tTu6wfV3ZAG8UJYe/vJkdUw=
 =EBMZ
 -----END PGP SIGNATURE-----

Merge tag 'docs-arm-move' of git://git.lwn.net/linux

Pull arm documentation move from Jonathan Corbet:
 "Move the Arm architecture documentation under Documentation/arch/.

  This brings some order to the documentation directory, declutters the
  top-level directory, and makes the documentation organization more
  closely match that of the source"

* tag 'docs-arm-move' of git://git.lwn.net/linux:
  dt-bindings: Update Documentation/arm references
  docs: update some straggling Documentation/arm references
  crypto: update some Arm documentation references
  mips: update a reference to a moved Arm Document
  arm64: Update Documentation/arm references
  arm: update in-source documentation references
  arm: docs: Move Arm documentation to Documentation/arch/
This commit is contained in:
Linus Torvalds 2023-06-27 11:58:16 -07:00
commit 04fc8904d5
97 changed files with 44 additions and 41 deletions

View file

@ -10,7 +10,7 @@ implementation.
:maxdepth: 2 :maxdepth: 2
arc/index arc/index
../arm/index arm/index
../arm64/index ../arm64/index
ia64/index ia64/index
../loongarch/index ../loongarch/index

View file

@ -56,7 +56,7 @@ hypervisor {
}; };
The format and meaning of the "xen,uefi-*" parameters are similar to those in The format and meaning of the "xen,uefi-*" parameters are similar to those in
Documentation/arm/uefi.rst, which are provided by the regular UEFI stub. However Documentation/arch/arm/uefi.rst, which are provided by the regular UEFI stub. However
they differ because they are provided by the Xen hypervisor, together with a set they differ because they are provided by the Xen hypervisor, together with a set
of UEFI runtime services implemented via hypercalls, see of UEFI runtime services implemented via hypercalls, see
http://xenbits.xen.org/docs/unstable/hypercall/x86_64/include,public,platform.h.html. http://xenbits.xen.org/docs/unstable/hypercall/x86_64/include,public,platform.h.html.

View file

@ -1,4 +1,4 @@
Chinese translated version of Documentation/arm/booting.rst Chinese translated version of Documentation/arch/arm/booting.rst
If you have any comment or update to the content, please contact the If you have any comment or update to the content, please contact the
original document maintainer directly. However, if you have a problem original document maintainer directly. However, if you have a problem
@ -9,7 +9,7 @@ or if there is a problem with the translation.
Maintainer: Russell King <linux@arm.linux.org.uk> Maintainer: Russell King <linux@arm.linux.org.uk>
Chinese maintainer: Fu Wei <tekkamanninja@gmail.com> Chinese maintainer: Fu Wei <tekkamanninja@gmail.com>
--------------------------------------------------------------------- ---------------------------------------------------------------------
Documentation/arm/booting.rst 的中文翻译 Documentation/arch/arm/booting.rst 的中文翻译
如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文
交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻

View file

@ -1,4 +1,4 @@
Chinese translated version of Documentation/arm/kernel_user_helpers.rst Chinese translated version of Documentation/arch/arm/kernel_user_helpers.rst
If you have any comment or update to the content, please contact the If you have any comment or update to the content, please contact the
original document maintainer directly. However, if you have a problem original document maintainer directly. However, if you have a problem
@ -10,7 +10,7 @@ Maintainer: Nicolas Pitre <nicolas.pitre@linaro.org>
Dave Martin <dave.martin@linaro.org> Dave Martin <dave.martin@linaro.org>
Chinese maintainer: Fu Wei <tekkamanninja@gmail.com> Chinese maintainer: Fu Wei <tekkamanninja@gmail.com>
--------------------------------------------------------------------- ---------------------------------------------------------------------
Documentation/arm/kernel_user_helpers.rst 的中文翻译 Documentation/arch/arm/kernel_user_helpers.rst 的中文翻译
如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文
交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻

View file

@ -2710,7 +2710,7 @@ Q: https://patchwork.kernel.org/project/linux-samsung-soc/list/
B: mailto:linux-samsung-soc@vger.kernel.org B: mailto:linux-samsung-soc@vger.kernel.org
C: irc://irc.libera.chat/linux-exynos C: irc://irc.libera.chat/linux-exynos
T: git git://git.kernel.org/pub/scm/linux/kernel/git/krzk/linux.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/krzk/linux.git
F: Documentation/arm/samsung/ F: Documentation/arch/arm/samsung/
F: Documentation/devicetree/bindings/arm/samsung/ F: Documentation/devicetree/bindings/arm/samsung/
F: Documentation/devicetree/bindings/hwinfo/samsung,* F: Documentation/devicetree/bindings/hwinfo/samsung,*
F: Documentation/devicetree/bindings/power/pd-samsung.yaml F: Documentation/devicetree/bindings/power/pd-samsung.yaml
@ -15331,7 +15331,7 @@ OMAP DISPLAY SUBSYSTEM and FRAMEBUFFER SUPPORT (DSS2)
L: linux-omap@vger.kernel.org L: linux-omap@vger.kernel.org
L: linux-fbdev@vger.kernel.org L: linux-fbdev@vger.kernel.org
S: Orphan S: Orphan
F: Documentation/arm/omap/dss.rst F: Documentation/arch/arm/omap/dss.rst
F: drivers/video/fbdev/omap2/ F: drivers/video/fbdev/omap2/
OMAP FRAMEBUFFER SUPPORT OMAP FRAMEBUFFER SUPPORT

View file

@ -1782,7 +1782,7 @@ config VFP
Say Y to include VFP support code in the kernel. This is needed Say Y to include VFP support code in the kernel. This is needed
if your hardware includes a VFP unit. if your hardware includes a VFP unit.
Please see <file:Documentation/arm/vfp/release-notes.rst> for Please see <file:Documentation/arch/arm/vfp/release-notes.rst> for
release notes and additional status information. release notes and additional status information.
Say N if your target does not have VFP hardware. Say N if your target does not have VFP hardware.

View file

@ -21,7 +21,7 @@
/* /*
* The public API for this code is documented in arch/arm/include/asm/mcpm.h. * The public API for this code is documented in arch/arm/include/asm/mcpm.h.
* For a comprehensive description of the main algorithm used here, please * For a comprehensive description of the main algorithm used here, please
* see Documentation/arm/cluster-pm-race-avoidance.rst. * see Documentation/arch/arm/cluster-pm-race-avoidance.rst.
*/ */
struct sync_struct mcpm_sync; struct sync_struct mcpm_sync;

View file

@ -5,7 +5,7 @@
* Created by: Nicolas Pitre, March 2012 * Created by: Nicolas Pitre, March 2012
* Copyright: (C) 2012-2013 Linaro Limited * Copyright: (C) 2012-2013 Linaro Limited
* *
* Refer to Documentation/arm/cluster-pm-race-avoidance.rst * Refer to Documentation/arch/arm/cluster-pm-race-avoidance.rst
* for details of the synchronisation algorithms used here. * for details of the synchronisation algorithms used here.
*/ */

View file

@ -6,7 +6,7 @@
* Copyright: (C) 2012-2013 Linaro Limited * Copyright: (C) 2012-2013 Linaro Limited
* *
* This algorithm is described in more detail in * This algorithm is described in more detail in
* Documentation/arm/vlocks.rst. * Documentation/arch/arm/vlocks.rst.
*/ */
#include <linux/linkage.h> #include <linux/linkage.h>

View file

@ -5,7 +5,7 @@
* Copyright (C) 1997-1999 Russell King * Copyright (C) 1997-1999 Russell King
* *
* Structure passed to kernel to tell it about the * Structure passed to kernel to tell it about the
* hardware it's running on. See Documentation/arm/setup.rst * hardware it's running on. See Documentation/arch/arm/setup.rst
* for more info. * for more info.
*/ */
#ifndef __ASMARM_SETUP_H #ifndef __ASMARM_SETUP_H

View file

@ -9,7 +9,7 @@
* published by the Free Software Foundation. * published by the Free Software Foundation.
* *
* Structure passed to kernel to tell it about the * Structure passed to kernel to tell it about the
* hardware it's running on. See Documentation/arm/setup.rst * hardware it's running on. See Documentation/arch/arm/setup.rst
* for more info. * for more info.
*/ */
#ifndef _UAPI__ASMARM_SETUP_H #ifndef _UAPI__ASMARM_SETUP_H

View file

@ -875,7 +875,7 @@ ENDPROC(__bad_stack)
* existing ones. This mechanism should be used only for things that are * existing ones. This mechanism should be used only for things that are
* really small and justified, and not be abused freely. * really small and justified, and not be abused freely.
* *
* See Documentation/arm/kernel_user_helpers.rst for formal definitions. * See Documentation/arch/arm/kernel_user_helpers.rst for formal definitions.
*/ */
THUMB( .arm ) THUMB( .arm )

View file

@ -106,7 +106,7 @@ void exynos_firmware_init(void);
#define C2_STATE (1 << 3) #define C2_STATE (1 << 3)
/* /*
* Magic values for bootloader indicating chosen low power mode. * Magic values for bootloader indicating chosen low power mode.
* See also Documentation/arm/samsung/bootloader-interface.rst * See also Documentation/arch/arm/samsung/bootloader-interface.rst
*/ */
#define EXYNOS_SLEEP_MAGIC 0x00000bad #define EXYNOS_SLEEP_MAGIC 0x00000bad
#define EXYNOS_AFTR_MAGIC 0xfcba0d10 #define EXYNOS_AFTR_MAGIC 0xfcba0d10

View file

@ -21,7 +21,7 @@ menuconfig ARCH_STI
help help
Include support for STMicroelectronics' STiH415/416, STiH407/10 and Include support for STMicroelectronics' STiH415/416, STiH407/10 and
STiH418 family SoCs using the Device Tree for discovery. More STiH418 family SoCs using the Device Tree for discovery. More
information can be found in Documentation/arm/sti/ and information can be found in Documentation/arch/arm/sti/ and
Documentation/devicetree. Documentation/devicetree.
if ARCH_STI if ARCH_STI

View file

@ -712,7 +712,7 @@ config ARM_VIRT_EXT
assistance. assistance.
A compliant bootloader is required in order to make maximum A compliant bootloader is required in order to make maximum
use of this feature. Refer to Documentation/arm/booting.rst for use of this feature. Refer to Documentation/arch/arm/booting.rst for
details. details.
config SWP_EMULATE config SWP_EMULATE
@ -904,7 +904,7 @@ config KUSER_HELPERS
the CPU type fitted to the system. This permits binaries to be the CPU type fitted to the system. This permits binaries to be
run on ARMv4 through to ARMv7 without modification. run on ARMv4 through to ARMv7 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 However, the fixed address nature of these helpers can be used
by ROP (return orientated programming) authors when creating by ROP (return orientated programming) authors when creating

View file

@ -7,7 +7,7 @@
# http://www.arm.linux.org.uk/developer/machines/download.php # http://www.arm.linux.org.uk/developer/machines/download.php
# #
# Please do not send patches to this file; it is automatically generated! # Please do not send patches to this file; it is automatically generated!
# To add an entry into this database, please see Documentation/arm/arm.rst, # To add an entry into this database, please see Documentation/arch/arm/arm.rst,
# or visit: # or visit:
# #
# http://www.arm.linux.org.uk/developer/machines/?action=new # http://www.arm.linux.org.uk/developer/machines/?action=new

View file

@ -1620,7 +1620,7 @@ config KUSER_HELPERS
the system. This permits binaries to be run on ARMv4 through the system. This permits binaries to be run on ARMv4 through
to ARMv8 without modification. 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 However, the fixed address nature of these helpers can be used
by ROP (return orientated programming) authors when creating by ROP (return orientated programming) authors when creating

View file

@ -10,7 +10,7 @@
* aarch32_setup_additional_pages() and are provided for compatibility * aarch32_setup_additional_pages() and are provided for compatibility
* reasons with 32 bit (aarch32) applications that need them. * 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> #include <asm/unistd.h>

View file

@ -178,7 +178,10 @@ void __init plat_mem_setup(void)
ioport_resource.start = 0; ioport_resource.start = 0;
ioport_resource.end = ~0; ioport_resource.end = ~0;
/* intended to somewhat resemble ARM; see Documentation/arm/booting.rst */ /*
* intended to somewhat resemble ARM; see
* Documentation/arch/arm/booting.rst
*/
if (fw_arg0 == 0 && fw_arg1 == 0xffffffff) if (fw_arg0 == 0 && fw_arg1 == 0xffffffff)
dtb = phys_to_virt(fw_arg2); dtb = phys_to_virt(fw_arg2);
else else

View file

@ -8,7 +8,7 @@
* keysize in CBC and ECB mode. * keysize in CBC and ECB mode.
* Add support also for DES and 3DES in CBC and ECB mode. * Add support also for DES and 3DES in CBC and ECB mode.
* *
* You could find the datasheet in Documentation/arm/sunxi.rst * You could find the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include "sun4i-ss.h" #include "sun4i-ss.h"

View file

@ -6,7 +6,7 @@
* *
* Core file which registers crypto algorithms supported by the SS. * Core file which registers crypto algorithms supported by the SS.
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/clk.h> #include <linux/clk.h>
#include <linux/crypto.h> #include <linux/crypto.h>

View file

@ -6,7 +6,7 @@
* *
* This file add support for MD5 and SHA1. * This file add support for MD5 and SHA1.
* *
* You could find the datasheet in Documentation/arm/sunxi.rst * You could find the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include "sun4i-ss.h" #include "sun4i-ss.h"
#include <asm/unaligned.h> #include <asm/unaligned.h>

View file

@ -8,7 +8,7 @@
* Support MD5 and SHA1 hash algorithms. * Support MD5 and SHA1 hash algorithms.
* Support DES and 3DES * Support DES and 3DES
* *
* You could find the datasheet in Documentation/arm/sunxi.rst * You could find the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/clk.h> #include <linux/clk.h>

View file

@ -8,7 +8,7 @@
* This file add support for AES cipher with 128,192,256 bits keysize in * This file add support for AES cipher with 128,192,256 bits keysize in
* CBC and ECB mode. * CBC and ECB mode.
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/bottom_half.h> #include <linux/bottom_half.h>

View file

@ -7,7 +7,7 @@
* *
* Core file which registers crypto algorithms supported by the CryptoEngine. * Core file which registers crypto algorithms supported by the CryptoEngine.
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/clk.h> #include <linux/clk.h>
#include <linux/crypto.h> #include <linux/crypto.h>

View file

@ -7,7 +7,7 @@
* *
* This file add support for MD5 and SHA1/SHA224/SHA256/SHA384/SHA512. * This file add support for MD5 and SHA1/SHA224/SHA256/SHA384/SHA512.
* *
* You could find the datasheet in Documentation/arm/sunxi.rst * You could find the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/bottom_half.h> #include <linux/bottom_half.h>
#include <linux/dma-mapping.h> #include <linux/dma-mapping.h>

View file

@ -7,7 +7,7 @@
* *
* This file handle the PRNG * This file handle the PRNG
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include "sun8i-ce.h" #include "sun8i-ce.h"
#include <linux/dma-mapping.h> #include <linux/dma-mapping.h>

View file

@ -7,7 +7,7 @@
* *
* This file handle the TRNG * This file handle the TRNG
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include "sun8i-ce.h" #include "sun8i-ce.h"
#include <linux/dma-mapping.h> #include <linux/dma-mapping.h>

View file

@ -8,7 +8,7 @@
* This file add support for AES cipher with 128,192,256 bits keysize in * This file add support for AES cipher with 128,192,256 bits keysize in
* CBC and ECB mode. * CBC and ECB mode.
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/bottom_half.h> #include <linux/bottom_half.h>

View file

@ -7,7 +7,7 @@
* *
* Core file which registers crypto algorithms supported by the SecuritySystem * Core file which registers crypto algorithms supported by the SecuritySystem
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/clk.h> #include <linux/clk.h>
#include <linux/crypto.h> #include <linux/crypto.h>

View file

@ -7,7 +7,7 @@
* *
* This file add support for MD5 and SHA1/SHA224/SHA256. * This file add support for MD5 and SHA1/SHA224/SHA256.
* *
* You could find the datasheet in Documentation/arm/sunxi.rst * You could find the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include <linux/bottom_half.h> #include <linux/bottom_half.h>
#include <linux/dma-mapping.h> #include <linux/dma-mapping.h>

View file

@ -7,7 +7,7 @@
* *
* This file handle the PRNG found in the SS * This file handle the PRNG found in the SS
* *
* You could find a link for the datasheet in Documentation/arm/sunxi.rst * You could find a link for the datasheet in Documentation/arch/arm/sunxi.rst
*/ */
#include "sun8i-ss.h" #include "sun8i-ss.h"
#include <linux/dma-mapping.h> #include <linux/dma-mapping.h>

View file

@ -22,7 +22,7 @@
* in the kernel). So this driver offers straight forward, reliable single * in the kernel). So this driver offers straight forward, reliable single
* touch functionality only. * touch functionality only.
* *
* s.a. A20 User Manual "1.15 TP" (Documentation/arm/sunxi.rst) * s.a. A20 User Manual "1.15 TP" (Documentation/arch/arm/sunxi.rst)
* (looks like the description in the A20 User Manual v1.3 is better * (looks like the description in the A20 User Manual v1.3 is better
* than the one in the A10 User Manual v.1.5) * than the one in the A10 User Manual v.1.5)
*/ */

View file

@ -6,7 +6,7 @@
* Bo Shen <voice.shen@atmel.com> * Bo Shen <voice.shen@atmel.com>
* *
* Links to reference manuals for the supported PWM chips can be found in * Links to reference manuals for the supported PWM chips can be found in
* Documentation/arm/microchip.rst. * Documentation/arch/arm/microchip.rst.
* *
* Limitations: * Limitations:
* - Periods start with the inactive level. * - Periods start with the inactive level.

View file

@ -8,7 +8,7 @@
* eric miao <eric.miao@marvell.com> * eric miao <eric.miao@marvell.com>
* *
* Links to reference manuals for some of the supported PWM chips can be found * Links to reference manuals for some of the supported PWM chips can be found
* in Documentation/arm/marvell.rst. * in Documentation/arch/arm/marvell.rst.
* *
* Limitations: * Limitations:
* - When PWM is stopped, the current PWM period stops abruptly at the next * - When PWM is stopped, the current PWM period stops abruptly at the next

View file

@ -450,8 +450,8 @@ config SERIAL_SA1100
help help
If you have a machine based on a SA1100/SA1110 StrongARM(R) CPU you If you have a machine based on a SA1100/SA1110 StrongARM(R) CPU you
can enable its onboard serial port by enabling this option. can enable its onboard serial port by enabling this option.
Please read <file:Documentation/arm/sa1100/serial_uart.rst> for further Please read <file:Documentation/arch/arm/sa1100/serial_uart.rst> for
info. further info.
config SERIAL_SA1100_CONSOLE config SERIAL_SA1100_CONSOLE
bool "Console on SA1100 serial port" bool "Console on SA1100 serial port"