qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Harsh Prateek Bora <harshpb@linux.ibm.com>
To: Sean Wei <me@sean.taipei>, qemu-devel@nongnu.org
Cc: "Michael S. Tsirkin" <mst@redhat.com>,
	Igor Mammedov <imammedo@redhat.com>,
	Ani Sinha <anisinha@redhat.com>,
	Gustavo Romero <gustavo.romero@linaro.org>,
	Nicholas Piggin <npiggin@gmail.com>,
	Daniel Henrique Barboza <danielhb413@gmail.com>,
	Fabiano Rosas <farosas@suse.de>,
	Laurent Vivier <lvivier@redhat.com>,
	Paolo Bonzini <pbonzini@redhat.com>,
	"open list:sPAPR (pseries)" <qemu-ppc@nongnu.org>
Subject: Re: [PATCH 5/6] treewide: update docs file extensions (.txt -> .rst) in comments
Date: Wed, 2 Jul 2025 11:20:01 +0530	[thread overview]
Message-ID: <ece06429-f17c-4ce1-9718-87929b72a3f6@linux.ibm.com> (raw)
In-Reply-To: <20250616.qemu.relocated.05@sean.taipei>



On 6/16/25 21:20, Sean Wei wrote:
> Several source comments still refer to docs with the old .txt
> extension that were previously converted to reStructuredText.
> 
> Update these references to use the correct .rst extensions to
> maintain accurate in-tree documentation pointers.
> 
> No functional changes.
> 
> Related commits:
>    50f8174c5c1 (Jul 2021): docs/specs/acpi_nvdimm: Convert to rST
>    f054eb1c920 (Jul 2021): docs/specs/acpi_pci_hotplug: Convert to rST
>    912fb3678b8 (Sep 2023): docs/specs/vmgenid: Convert to rST
>    bb1cff6ee04 (Sep 2023): docs/specs/ivshmem-spec: Convert to rST
>    55ff468f781 (Jan 2022): docs: Rename ppc-spapr-hotplug.txt to .rst
> 
> Signed-off-by: Sean Wei <me@sean.taipei>
> ---
>   hw/acpi/nvdimm.c               | 2 +-
>   hw/acpi/pcihp.c                | 2 +-
>   hw/acpi/vmgenid.c              | 6 +++---
>   hw/misc/ivshmem-flat.c         | 2 +-
>   hw/ppc/spapr.c                 | 2 +-
>   include/hw/acpi/pcihp.h        | 2 +-
>   include/hw/misc/ivshmem-flat.h | 2 +-
>   tests/qtest/vmgenid-test.c     | 2 +-
>   8 files changed, 10 insertions(+), 10 deletions(-)

Reviewed-by: Harsh Prateek Bora <harshpb@linux.ibm.com>

> 
> diff --git a/hw/acpi/nvdimm.c b/hw/acpi/nvdimm.c
> index 9ba90806f2..732d613ac0 100644
> --- a/hw/acpi/nvdimm.c
> +++ b/hw/acpi/nvdimm.c
> @@ -535,7 +535,7 @@ nvdimm_dsm_no_payload(uint32_t func_ret_status, hwaddr dsm_mem_addr)
>   
>   #define NVDIMM_QEMU_RSVD_HANDLE_ROOT         0x10000
>   
> -/* Read FIT data, defined in docs/specs/acpi_nvdimm.txt. */
> +/* Read FIT data, defined in docs/specs/acpi_nvdimm.rst. */
>   static void nvdimm_dsm_func_read_fit(NVDIMMState *state, NvdimmDsmIn *in,
>                                        hwaddr dsm_mem_addr)
>   {
> diff --git a/hw/acpi/pcihp.c b/hw/acpi/pcihp.c
> index aac90013d4..497281ae20 100644
> --- a/hw/acpi/pcihp.c
> +++ b/hw/acpi/pcihp.c
> @@ -3,7 +3,7 @@
>    *
>    * QEMU supports PCI hotplug via ACPI. This module
>    * implements the interface between QEMU and the ACPI BIOS.
> - * Interface specification - see docs/specs/acpi_pci_hotplug.txt
> + * Interface specification - see docs/specs/acpi_pci_hotplug.rst
>    *
>    * Copyright (c) 2013, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
>    * Copyright (c) 2006 Fabrice Bellard
> diff --git a/hw/acpi/vmgenid.c b/hw/acpi/vmgenid.c
> index fac3d6d97e..33c35c85dd 100644
> --- a/hw/acpi/vmgenid.c
> +++ b/hw/acpi/vmgenid.c
> @@ -38,7 +38,7 @@ void vmgenid_build_acpi(VmGenIdState *vms, GArray *table_data, GArray *guid,
>       guid_le = qemu_uuid_bswap(vms->guid);
>       /* The GUID is written at a fixed offset into the fw_cfg file
>        * in order to implement the "OVMF SDT Header probe suppressor"
> -     * see docs/specs/vmgenid.txt for more details
> +     * see docs/specs/vmgenid.rst for more details
>        */
>       g_array_insert_vals(guid, VMGENID_GUID_OFFSET, guid_le.data,
>                           ARRAY_SIZE(guid_le.data));
> @@ -101,7 +101,7 @@ void vmgenid_build_acpi(VmGenIdState *vms, GArray *table_data, GArray *guid,
>        * < 4GB, but write 64 bits anyway.
>        * The address that is patched in is offset in order to implement
>        * the "OVMF SDT Header probe suppressor"
> -     * see docs/specs/vmgenid.txt for more details.
> +     * see docs/specs/vmgenid.rst for more details.
>        */
>       bios_linker_loader_write_pointer(linker,
>           VMGENID_ADDR_FW_CFG_FILE, 0, sizeof(uint64_t),
> @@ -153,7 +153,7 @@ static void vmgenid_update_guest(VmGenIdState *vms)
>               guid_le = qemu_uuid_bswap(vms->guid);
>               /* The GUID is written at a fixed offset into the fw_cfg file
>                * in order to implement the "OVMF SDT Header probe suppressor"
> -             * see docs/specs/vmgenid.txt for more details.
> +             * see docs/specs/vmgenid.rst for more details.
>                */
>               cpu_physical_memory_write(vmgenid_addr, guid_le.data,
>                                         sizeof(guid_le.data));
> diff --git a/hw/misc/ivshmem-flat.c b/hw/misc/ivshmem-flat.c
> index be28c24d73..fe4be6be17 100644
> --- a/hw/misc/ivshmem-flat.c
> +++ b/hw/misc/ivshmem-flat.c
> @@ -362,7 +362,7 @@ static bool ivshmem_flat_connect_server(DeviceState *dev, Error **errp)
>        *
>        *  ivshmem_flat_recv_msg() calls return 'msg' and 'fd'.
>        *
> -     *  See ./docs/specs/ivshmem-spec.txt for details on the protocol.
> +     *  See docs/specs/ivshmem-spec.rst for details on the protocol.
>        */
>   
>       /* Step 0 */
> diff --git a/hw/ppc/spapr.c b/hw/ppc/spapr.c
> index 702f774cda..08615f6c90 100644
> --- a/hw/ppc/spapr.c
> +++ b/hw/ppc/spapr.c
> @@ -577,7 +577,7 @@ static int spapr_dt_dynamic_memory(SpaprMachineState *spapr, void *fdt,
>   
>   /*
>    * Adds ibm,dynamic-reconfiguration-memory node.
> - * Refer to docs/specs/ppc-spapr-hotplug.txt for the documentation
> + * Refer to docs/specs/ppc-spapr-hotplug.rst for the documentation
>    * of this device tree node.
>    */
>   static int spapr_dt_dynamic_reconfiguration_memory(SpaprMachineState *spapr,
> diff --git a/include/hw/acpi/pcihp.h b/include/hw/acpi/pcihp.h
> index a97904bada..cdc0cb8e43 100644
> --- a/include/hw/acpi/pcihp.h
> +++ b/include/hw/acpi/pcihp.h
> @@ -3,7 +3,7 @@
>    *
>    * QEMU supports PCI hotplug via ACPI. This module
>    * implements the interface between QEMU and the ACPI BIOS.
> - * Interface specification - see docs/specs/acpi_pci_hotplug.txt
> + * Interface specification - see docs/specs/acpi_pci_hotplug.rst
>    *
>    * Copyright (c) 2013, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
>    * Copyright (c) 2006 Fabrice Bellard
> diff --git a/include/hw/misc/ivshmem-flat.h b/include/hw/misc/ivshmem-flat.h
> index 09bc3abcad..3eca99004e 100644
> --- a/include/hw/misc/ivshmem-flat.h
> +++ b/include/hw/misc/ivshmem-flat.h
> @@ -36,7 +36,7 @@ typedef struct IvshmemFTState IvshmemFTState;
>   
>   DECLARE_INSTANCE_CHECKER(IvshmemFTState, IVSHMEM_FLAT, TYPE_IVSHMEM_FLAT)
>   
> -/* Ivshmem registers. See ./docs/specs/ivshmem-spec.txt for details. */
> +/* Ivshmem registers. See docs/specs/ivshmem-spec.rst for details. */
>   enum ivshmem_registers {
>       INTMASK = 0,
>       INTSTATUS = 4,
> diff --git a/tests/qtest/vmgenid-test.c b/tests/qtest/vmgenid-test.c
> index e613374665..33e96b7c55 100644
> --- a/tests/qtest/vmgenid-test.c
> +++ b/tests/qtest/vmgenid-test.c
> @@ -61,7 +61,7 @@ static uint32_t acpi_find_vgia(QTestState *qts)
>   
>               /* The GUID is written at a fixed offset into the fw_cfg file
>                * in order to implement the "OVMF SDT Header probe suppressor"
> -             * see docs/specs/vmgenid.txt for more details
> +             * see docs/specs/vmgenid.rst for more details
>                */
>               guid_offset = le32_to_cpu(vgia_val) + VMGENID_GUID_OFFSET;
>               g_free(table_aml);


  parent reply	other threads:[~2025-07-02  5:51 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-16 15:46 [PATCH 0/6] Fix paths for relocated files Sean Wei
2025-06-16 15:47 ` [PATCH 1/6] MAINTAINERS: update docs file extensions (.txt -> .rst) Sean Wei
2025-07-01 17:18   ` Thomas Huth
2025-06-16 15:48 ` [PATCH 2/6] MAINTAINERS: fix paths for relocated files Sean Wei
2025-07-01 17:24   ` Thomas Huth
2025-07-01 18:06     ` Sean Wei
2025-07-01 18:54       ` Thomas Huth
2025-06-16 15:49 ` [PATCH 3/6] MAINTAINERS: fix vendor capitalization (Vmware -> VMware) Sean Wei
2025-06-16 15:50 ` [PATCH 4/6] MAINTAINERS: fix VMware filename typo (vwm -> vmw) Sean Wei
2025-07-01 17:25   ` Thomas Huth
2025-06-16 15:50 ` [PATCH 5/6] treewide: update docs file extensions (.txt -> .rst) in comments Sean Wei
2025-07-01 17:28   ` Thomas Huth
2025-07-02  5:50   ` Harsh Prateek Bora [this message]
2025-06-16 15:51 ` [PATCH 6/6] treewide: fix paths for relocated files " Sean Wei
2025-07-01 17:32   ` Thomas Huth

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ece06429-f17c-4ce1-9718-87929b72a3f6@linux.ibm.com \
    --to=harshpb@linux.ibm.com \
    --cc=anisinha@redhat.com \
    --cc=danielhb413@gmail.com \
    --cc=farosas@suse.de \
    --cc=gustavo.romero@linaro.org \
    --cc=imammedo@redhat.com \
    --cc=lvivier@redhat.com \
    --cc=me@sean.taipei \
    --cc=mst@redhat.com \
    --cc=npiggin@gmail.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-ppc@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).