Re: [PATCH 09/12] docs: fix broken references for ReST files that moved around

Corentin Labbe
2020-03-31T09:21:42Z

On Tue, Mar 17, 2020 at 02:10:48PM +0100, Mauro Carvalho Chehab wrote:
> Some broken references happened due to shifting files around
> and ReST renames. Those can't be auto-fixed by the script,
> so let's fix them manually.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/doc-guide/maintainer-profile.rst | 2 +-
> Documentation/virt/kvm/mmu.rst | 2 +-
> Documentation/virt/kvm/review-checklist.rst | 2 +-
> arch/x86/kvm/mmu/mmu.c | 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-ss/sun8i-ss-cipher.c | 2 +-
> drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c | 2 +-
> drivers/media/v4l2-core/v4l2-fwnode.c | 2 +-
> include/uapi/linux/kvm.h | 4 ++--
> tools/include/uapi/linux/kvm.h | 4 ++--
> 11 files changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/Documentation/doc-guide/maintainer-profile.rst b/Documentation/doc-guide/maintainer-profile.rst
> index 5afc0ddba40a..755d39f0d407 100644
> --- a/Documentation/doc-guide/maintainer-profile.rst
> +++ b/Documentation/doc-guide/maintainer-profile.rst
> @@ -6,7 +6,7 @@ Documentation subsystem maintainer entry profile
> The documentation "subsystem" is the central coordinating point for the
> kernel's documentation and associated infrastructure. It covers the
> hierarchy under Documentation/ (with the exception of
> -Documentation/device-tree), various utilities under scripts/ and, at least
> +Documentation/devicetree), various utilities under scripts/ and, at least
> some of the time, LICENSES/.
>
> It's worth noting, though, that the boundaries of this subsystem are rather
> diff --git a/Documentation/virt/kvm/mmu.rst b/Documentation/virt/kvm/mmu.rst
> index 60981887d20b..46126ecc70f7 100644
> --- a/Documentation/virt/kvm/mmu.rst
> +++ b/Documentation/virt/kvm/mmu.rst
> @@ -319,7 +319,7 @@ Handling a page fault is performed as follows:
>
> - If both P bit and R/W bit of error code are set, this could possibly
> be handled as a "fast page fault" (fixed without taking the MMU lock). See
> - the description in Documentation/virt/kvm/locking.txt.
> + the description in Documentation/virt/kvm/locking.rst.
>
> - if needed, walk the guest page tables to determine the guest translation
> (gva->gpa or ngpa->gpa)
> diff --git a/Documentation/virt/kvm/review-checklist.rst b/Documentation/virt/kvm/review-checklist.rst
> index 1f86a9d3f705..dc01aea4057b 100644
> --- a/Documentation/virt/kvm/review-checklist.rst
> +++ b/Documentation/virt/kvm/review-checklist.rst
> @@ -10,7 +10,7 @@ Review checklist for kvm patches
> 2. Patches should be against kvm.git master branch.
>
> 3. If the patch introduces or modifies a new userspace API:
> - - the API must be documented in Documentation/virt/kvm/api.txt
> + - the API must be documented in Documentation/virt/kvm/api.rst
> - the API must be discoverable using KVM_CHECK_EXTENSION
>
> 4. New state must include support for save/restore.
> diff --git a/arch/x86/kvm/mmu/mmu.c b/arch/x86/kvm/mmu/mmu.c
> index 560e85ebdf22..2bd9f35e9e91 100644
> --- a/arch/x86/kvm/mmu/mmu.c
> +++ b/arch/x86/kvm/mmu/mmu.c
> @@ -3586,7 +3586,7 @@ static bool fast_page_fault(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
> /*
> * Currently, fast page fault only works for direct mapping
> * since the gfn is not stable for indirect shadow page. See
> - * Documentation/virt/kvm/locking.txt to get more detail.
> + * Documentation/virt/kvm/locking.rst to get more detail.
> */
> fault_handled = fast_pf_fix_direct_spte(vcpu, sp,
> iterator.sptep, spte,
> diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
> index a5fd8975f3d3..a6abb701bfc6 100644
> --- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
> +++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
> @@ -8,7 +8,7 @@
> * This file add support for AES cipher with 128,192,256 bits keysize in
> * CBC and ECB mode.
> *
> - * You could find a link for the datasheet in Documentation/arm/sunxi/README
> + * You could find a link for the datasheet in Documentation/arm/sunxi.rst
> */
>
> #include <linux/crypto.h>
> diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
> index 3e4e4bbda34c..b957061424a1 100644
> --- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
> +++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
> @@ -7,7 +7,7 @@
> *
> * Core file which registers crypto algorithms supported by the CryptoEngine.
> *
> - * You could find a link for the datasheet in Documentation/arm/sunxi/README
> + * You could find a link for the datasheet in Documentation/arm/sunxi.rst
> */
> #include <linux/clk.h>
> #include <linux/crypto.h>
> diff --git a/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c b/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c
> index 84d52fc3a2da..c89cb2ee2496 100644
> --- a/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c
> +++ b/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-cipher.c
> @@ -8,7 +8,7 @@
> * This file add support for AES cipher with 128,192,256 bits keysize in
> * CBC and ECB mode.
> *
> - * You could find a link for the datasheet in Documentation/arm/sunxi/README
> + * You could find a link for the datasheet in Documentation/arm/sunxi.rst
> */
>
> #include <linux/crypto.h>
> diff --git a/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c b/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c
> index 6b301afffd11..8ba4f9c81dac 100644
> --- a/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c
> +++ b/drivers/crypto/allwinner/sun8i-ss/sun8i-ss-core.c
> @@ -7,7 +7,7 @@
> *
> * Core file which registers crypto algorithms supported by the SecuritySystem
> *
> - * You could find a link for the datasheet in Documentation/arm/sunxi/README
> + * You could find a link for the datasheet in Documentation/arm/sunxi.rst
> */
> #include <linux/clk.h>
> #include <linux/crypto.h>
> diff --git a/drivers/media/v4l2-core/v4l2-fwnode.c b/drivers/media/v4l2-core/v4l2-fwnode.c
> index 97f0f8b23b5d..8a1e1b95b379 100644
> --- a/drivers/media/v4l2-core/v4l2-fwnode.c
> +++ b/drivers/media/v4l2-core/v4l2-fwnode.c
> @@ -980,7 +980,7 @@ static int v4l2_fwnode_reference_parse(struct device *dev,
> *
> * THIS EXAMPLE EXISTS MERELY TO DOCUMENT THIS FUNCTION. DO NOT USE IT AS A
> * REFERENCE IN HOW ACPI TABLES SHOULD BE WRITTEN!! See documentation under
> - * Documentation/acpi/dsd instead and especially graph.txt,
> + * Documentation/firmware-guide/acpi/dsd/ instead and especially graph.txt,
> * data-node-references.txt and leds.txt .
> *
> * Scope (\_SB.PCI0.I2C2)
> diff --git a/include/uapi/linux/kvm.h b/include/uapi/linux/kvm.h
> index 5e6234cb25a6..704bd4cd3689 100644
> --- a/include/uapi/linux/kvm.h
> +++ b/include/uapi/linux/kvm.h
> @@ -116,7 +116,7 @@ struct kvm_irq_level {
> * ACPI gsi notion of irq.
> * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
> * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
> - * For ARM: See Documentation/virt/kvm/api.txt
> + * For ARM: See Documentation/virt/kvm/api.rst
> */
> union {
> __u32 irq;
> @@ -1106,7 +1106,7 @@ struct kvm_xen_hvm_config {
> *
> * KVM_IRQFD_FLAG_RESAMPLE indicates resamplefd is valid and specifies
> * the irqfd to operate in resampling mode for level triggered interrupt
> - * emulation. See Documentation/virt/kvm/api.txt.
> + * emulation. See Documentation/virt/kvm/api.rst.
> */
> #define KVM_IRQFD_FLAG_RESAMPLE (1 << 1)
>
> diff --git a/tools/include/uapi/linux/kvm.h b/tools/include/uapi/linux/kvm.h
> index 4b95f9a31a2f..e5f32fcec68f 100644
> --- a/tools/include/uapi/linux/kvm.h
> +++ b/tools/include/uapi/linux/kvm.h
> @@ -116,7 +116,7 @@ struct kvm_irq_level {
> * ACPI gsi notion of irq.
> * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
> * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
> - * For ARM: See Documentation/virt/kvm/api.txt
> + * For ARM: See Documentation/virt/kvm/api.rst
> */
> union {
> __u32 irq;
> @@ -1100,7 +1100,7 @@ struct kvm_xen_hvm_config {
> *
> * KVM_IRQFD_FLAG_RESAMPLE indicates resamplefd is valid and specifies
> * the irqfd to operate in resampling mode for level triggered interrupt
> - * emulation. See Documentation/virt/kvm/api.txt.
> + * emulation. See Documentation/virt/kvm/api.rst.
> */
> #define KVM_IRQFD_FLAG_RESAMPLE (1 << 1)
>
> --
> 2.24.1
>

Hello

for sun8i-ss and sun8i-ce:
Acked-by: Corentin LABBE <clabbe.montjoie@gmail.com>

Thanks