[PATCH v1] docs: move riscv under arch

Conor Dooley conor at kernel.org
Mon Oct 2 06:25:09 PDT 2023


Hey,

On Sat, Sep 30, 2023 at 09:52:00PM +0300, Costa Shulyupin wrote:
> and fix all in-tree references.
> 
> 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.
> 
> Signed-off-by: Costa Shulyupin <costa.shul at redhat.com>

Firstly, $subject is not correct - this is now v2.
Also, please do not send new versions as a response to old threads. It
buries them in people's mailboxes that do things like sorting by
threads. Clearly no resubmission should be required for either of those
items though, so:
Reviewed-by: Conor Dooley <conor.dooley at microchip.com>

Thanks,
Conor.

> 
> ---
> Changes in v1: rebased on linux-next
> 
> Signed-off-by: Costa Shulyupin <costa.shul at redhat.com>
> ---
>  Documentation/arch/index.rst                                  | 2 +-
>  Documentation/{ => arch}/riscv/acpi.rst                       | 0
>  Documentation/{ => arch}/riscv/boot-image-header.rst          | 0
>  Documentation/{ => arch}/riscv/boot.rst                       | 0
>  Documentation/{ => arch}/riscv/features.rst                   | 0
>  Documentation/{ => arch}/riscv/hwprobe.rst                    | 0
>  Documentation/{ => arch}/riscv/index.rst                      | 0
>  Documentation/{ => arch}/riscv/patch-acceptance.rst           | 0
>  Documentation/{ => arch}/riscv/uabi.rst                       | 0
>  Documentation/{ => arch}/riscv/vector.rst                     | 0
>  Documentation/{ => arch}/riscv/vm-layout.rst                  | 0
>  Documentation/maintainer/maintainer-entry-profile.rst         | 2 +-
>  Documentation/process/index.rst                               | 2 +-
>  Documentation/translations/it_IT/riscv/patch-acceptance.rst   | 2 +-
>  Documentation/translations/zh_CN/arch/index.rst               | 2 +-
>  .../translations/zh_CN/{ => arch}/riscv/boot-image-header.rst | 4 ++--
>  Documentation/translations/zh_CN/{ => arch}/riscv/index.rst   | 4 ++--
>  .../translations/zh_CN/{ => arch}/riscv/patch-acceptance.rst  | 4 ++--
>  .../translations/zh_CN/{ => arch}/riscv/vm-layout.rst         | 4 ++--
>  .../zh_CN/maintainer/maintainer-entry-profile.rst             | 2 +-
>  MAINTAINERS                                                   | 2 +-
>  arch/riscv/include/uapi/asm/hwprobe.h                         | 2 +-
>  arch/riscv/kernel/sys_riscv.c                                 | 2 +-
>  23 files changed, 17 insertions(+), 17 deletions(-)
>  rename Documentation/{ => arch}/riscv/acpi.rst (100%)
>  rename Documentation/{ => arch}/riscv/boot-image-header.rst (100%)
>  rename Documentation/{ => arch}/riscv/boot.rst (100%)
>  rename Documentation/{ => arch}/riscv/features.rst (100%)
>  rename Documentation/{ => arch}/riscv/hwprobe.rst (100%)
>  rename Documentation/{ => arch}/riscv/index.rst (100%)
>  rename Documentation/{ => arch}/riscv/patch-acceptance.rst (100%)
>  rename Documentation/{ => arch}/riscv/uabi.rst (100%)
>  rename Documentation/{ => arch}/riscv/vector.rst (100%)
>  rename Documentation/{ => arch}/riscv/vm-layout.rst (100%)
>  rename Documentation/translations/zh_CN/{ => arch}/riscv/boot-image-header.rst (96%)
>  rename Documentation/translations/zh_CN/{ => arch}/riscv/index.rst (79%)
>  rename Documentation/translations/zh_CN/{ => arch}/riscv/patch-acceptance.rst (93%)
>  rename Documentation/translations/zh_CN/{ => arch}/riscv/vm-layout.rst (98%)
> 
> diff --git a/Documentation/arch/index.rst b/Documentation/arch/index.rst
> index 194e7e797877..d27c360e0312 100644
> --- a/Documentation/arch/index.rst
> +++ b/Documentation/arch/index.rst
> @@ -19,7 +19,7 @@ implementation.
>     openrisc/index
>     parisc/index
>     ../powerpc/index
> -   ../riscv/index
> +   riscv/index
>     s390/index
>     sh/index
>     sparc/index
> diff --git a/Documentation/riscv/acpi.rst b/Documentation/arch/riscv/acpi.rst
> similarity index 100%
> rename from Documentation/riscv/acpi.rst
> rename to Documentation/arch/riscv/acpi.rst
> diff --git a/Documentation/riscv/boot-image-header.rst b/Documentation/arch/riscv/boot-image-header.rst
> similarity index 100%
> rename from Documentation/riscv/boot-image-header.rst
> rename to Documentation/arch/riscv/boot-image-header.rst
> diff --git a/Documentation/riscv/boot.rst b/Documentation/arch/riscv/boot.rst
> similarity index 100%
> rename from Documentation/riscv/boot.rst
> rename to Documentation/arch/riscv/boot.rst
> diff --git a/Documentation/riscv/features.rst b/Documentation/arch/riscv/features.rst
> similarity index 100%
> rename from Documentation/riscv/features.rst
> rename to Documentation/arch/riscv/features.rst
> diff --git a/Documentation/riscv/hwprobe.rst b/Documentation/arch/riscv/hwprobe.rst
> similarity index 100%
> rename from Documentation/riscv/hwprobe.rst
> rename to Documentation/arch/riscv/hwprobe.rst
> diff --git a/Documentation/riscv/index.rst b/Documentation/arch/riscv/index.rst
> similarity index 100%
> rename from Documentation/riscv/index.rst
> rename to Documentation/arch/riscv/index.rst
> diff --git a/Documentation/riscv/patch-acceptance.rst b/Documentation/arch/riscv/patch-acceptance.rst
> similarity index 100%
> rename from Documentation/riscv/patch-acceptance.rst
> rename to Documentation/arch/riscv/patch-acceptance.rst
> diff --git a/Documentation/riscv/uabi.rst b/Documentation/arch/riscv/uabi.rst
> similarity index 100%
> rename from Documentation/riscv/uabi.rst
> rename to Documentation/arch/riscv/uabi.rst
> diff --git a/Documentation/riscv/vector.rst b/Documentation/arch/riscv/vector.rst
> similarity index 100%
> rename from Documentation/riscv/vector.rst
> rename to Documentation/arch/riscv/vector.rst
> diff --git a/Documentation/riscv/vm-layout.rst b/Documentation/arch/riscv/vm-layout.rst
> similarity index 100%
> rename from Documentation/riscv/vm-layout.rst
> rename to Documentation/arch/riscv/vm-layout.rst
> diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
> index 6b64072d4bf2..7ad4bfc2cc03 100644
> --- a/Documentation/maintainer/maintainer-entry-profile.rst
> +++ b/Documentation/maintainer/maintainer-entry-profile.rst
> @@ -101,7 +101,7 @@ to do something different in the near future.
>  
>     ../doc-guide/maintainer-profile
>     ../nvdimm/maintainer-entry-profile
> -   ../riscv/patch-acceptance
> +   ../arch/riscv/patch-acceptance
>     ../driver-api/media/maintainer-entry-profile
>     ../driver-api/vfio-pci-device-specific-driver-acceptance
>     ../nvme/feature-and-quirk-policy
> diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
> index b501cd977053..db09a81d474b 100644
> --- a/Documentation/process/index.rst
> +++ b/Documentation/process/index.rst
> @@ -71,7 +71,7 @@ lack of a better place.
>     volatile-considered-harmful
>     botching-up-ioctls
>     clang-format
> -   ../riscv/patch-acceptance
> +   ../arch/riscv/patch-acceptance
>     ../core-api/unaligned-memory-access
>  
>  .. only::  subproject and html
> diff --git a/Documentation/translations/it_IT/riscv/patch-acceptance.rst b/Documentation/translations/it_IT/riscv/patch-acceptance.rst
> index edf67252b3fb..2d7afb1f6959 100644
> --- a/Documentation/translations/it_IT/riscv/patch-acceptance.rst
> +++ b/Documentation/translations/it_IT/riscv/patch-acceptance.rst
> @@ -1,6 +1,6 @@
>  .. include:: ../disclaimer-ita.rst
>  
> -:Original: :doc:`../../../riscv/patch-acceptance`
> +:Original: :doc:`../../../arch/riscv/patch-acceptance`
>  :Translator: Federico Vaga <federico.vaga at vaga.pv.it>
>  
>  arch/riscv linee guida alla manutenzione per gli sviluppatori
> diff --git a/Documentation/translations/zh_CN/arch/index.rst b/Documentation/translations/zh_CN/arch/index.rst
> index 945b078168b0..71186d9df7c9 100644
> --- a/Documentation/translations/zh_CN/arch/index.rst
> +++ b/Documentation/translations/zh_CN/arch/index.rst
> @@ -10,7 +10,7 @@
>  
>     mips/index
>     arm64/index
> -   ../riscv/index
> +   ../arch/riscv/index
>     openrisc/index
>     parisc/index
>     loongarch/index
> diff --git a/Documentation/translations/zh_CN/riscv/boot-image-header.rst b/Documentation/translations/zh_CN/arch/riscv/boot-image-header.rst
> similarity index 96%
> rename from Documentation/translations/zh_CN/riscv/boot-image-header.rst
> rename to Documentation/translations/zh_CN/arch/riscv/boot-image-header.rst
> index 0234c28a7114..779b5172fe24 100644
> --- a/Documentation/translations/zh_CN/riscv/boot-image-header.rst
> +++ b/Documentation/translations/zh_CN/arch/riscv/boot-image-header.rst
> @@ -1,6 +1,6 @@
> -.. include:: ../disclaimer-zh_CN.rst
> +.. include:: ../../disclaimer-zh_CN.rst
>  
> -:Original: Documentation/riscv/boot-image-header.rst
> +:Original: Documentation/arch/riscv/boot-image-header.rst
>  
>  :翻译:
>  
> diff --git a/Documentation/translations/zh_CN/riscv/index.rst b/Documentation/translations/zh_CN/arch/riscv/index.rst
> similarity index 79%
> rename from Documentation/translations/zh_CN/riscv/index.rst
> rename to Documentation/translations/zh_CN/arch/riscv/index.rst
> index 131e405aa857..3b041c116169 100644
> --- a/Documentation/translations/zh_CN/riscv/index.rst
> +++ b/Documentation/translations/zh_CN/arch/riscv/index.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -.. include:: ../disclaimer-zh_CN.rst
> +.. include:: ../../disclaimer-zh_CN.rst
>  
> -:Original: Documentation/riscv/index.rst
> +:Original: Documentation/arch/riscv/index.rst
>  
>  :翻译:
>  
> diff --git a/Documentation/translations/zh_CN/riscv/patch-acceptance.rst b/Documentation/translations/zh_CN/arch/riscv/patch-acceptance.rst
> similarity index 93%
> rename from Documentation/translations/zh_CN/riscv/patch-acceptance.rst
> rename to Documentation/translations/zh_CN/arch/riscv/patch-acceptance.rst
> index d180d24717bf..c8eb230ca8ee 100644
> --- a/Documentation/translations/zh_CN/riscv/patch-acceptance.rst
> +++ b/Documentation/translations/zh_CN/arch/riscv/patch-acceptance.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -.. include:: ../disclaimer-zh_CN.rst
> +.. include:: ../../disclaimer-zh_CN.rst
>  
> -:Original: Documentation/riscv/patch-acceptance.rst
> +:Original: Documentation/arch/riscv/patch-acceptance.rst
>  
>  :翻译:
>  
> diff --git a/Documentation/translations/zh_CN/riscv/vm-layout.rst b/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> similarity index 98%
> rename from Documentation/translations/zh_CN/riscv/vm-layout.rst
> rename to Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> index 91884e2dfff8..4b9f4dcf6c19 100644
> --- a/Documentation/translations/zh_CN/riscv/vm-layout.rst
> +++ b/Documentation/translations/zh_CN/arch/riscv/vm-layout.rst
> @@ -1,7 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
> -.. include:: ../disclaimer-zh_CN.rst
> +.. include:: ../../disclaimer-zh_CN.rst
>  
> -:Original: Documentation/riscv/vm-layout.rst
> +:Original: Documentation/arch/riscv/vm-layout.rst
>  
>  :翻译:
>  
> diff --git a/Documentation/translations/zh_CN/maintainer/maintainer-entry-profile.rst b/Documentation/translations/zh_CN/maintainer/maintainer-entry-profile.rst
> index a1ee99c4786e..0f5acfb1012e 100644
> --- a/Documentation/translations/zh_CN/maintainer/maintainer-entry-profile.rst
> +++ b/Documentation/translations/zh_CN/maintainer/maintainer-entry-profile.rst
> @@ -89,4 +89,4 @@
>  
>     ../doc-guide/maintainer-profile
>     ../../../nvdimm/maintainer-entry-profile
> -   ../../../riscv/patch-acceptance
> +   ../../../arch/riscv/patch-acceptance
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 208cfcc1aee3..863ba7e0123c 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -18533,7 +18533,7 @@ L:	linux-riscv at lists.infradead.org
>  S:	Supported
>  Q:	https://patchwork.kernel.org/project/linux-riscv/list/
>  C:	irc://irc.libera.chat/riscv
> -P:	Documentation/riscv/patch-acceptance.rst
> +P:	Documentation/arch/riscv/patch-acceptance.rst
>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/riscv/linux.git
>  F:	arch/riscv/
>  N:	riscv
> diff --git a/arch/riscv/include/uapi/asm/hwprobe.h b/arch/riscv/include/uapi/asm/hwprobe.h
> index 006bfb48343d..d43e306ce2f9 100644
> --- a/arch/riscv/include/uapi/asm/hwprobe.h
> +++ b/arch/riscv/include/uapi/asm/hwprobe.h
> @@ -10,7 +10,7 @@
>  
>  /*
>   * Interface for probing hardware capabilities from userspace, see
> - * Documentation/riscv/hwprobe.rst for more information.
> + * Documentation/arch/riscv/hwprobe.rst for more information.
>   */
>  struct riscv_hwprobe {
>  	__s64 key;
> diff --git a/arch/riscv/kernel/sys_riscv.c b/arch/riscv/kernel/sys_riscv.c
> index 473159b5f303..b651ec698a91 100644
> --- a/arch/riscv/kernel/sys_riscv.c
> +++ b/arch/riscv/kernel/sys_riscv.c
> @@ -79,7 +79,7 @@ SYSCALL_DEFINE3(riscv_flush_icache, uintptr_t, start, uintptr_t, end,
>  
>  /*
>   * The hwprobe interface, for allowing userspace to probe to see which features
> - * are supported by the hardware.  See Documentation/riscv/hwprobe.rst for more
> + * are supported by the hardware.  See Documentation/arch/riscv/hwprobe.rst for more
>   * details.
>   */
>  static void hwprobe_arch_id(struct riscv_hwprobe *pair,
> -- 
> 2.41.0
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-riscv/attachments/20231002/60161a0b/attachment.sig>


More information about the linux-riscv mailing list