| Message ID | 20230927151205.70930-7-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | docs/specs: Convert txt files to rST | expand |
On 27/9/23 17:12, Peter Maydell wrote: > Convert docs/specs/virt-ctlr.txt to rST format. > > I added the name of the device to give readers a bit more idea > of which device we're actually documenting here. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > docs/specs/index.rst | 1 + > docs/specs/{virt-ctlr.txt => virt-ctlr.rst} | 12 +++++------- > 2 files changed, 6 insertions(+), 7 deletions(-) > rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%) $ ./scripts/get_maintainer.pl -f docs/specs/virt-ctlr.txt get_maintainer.pl: No maintainers found, printing recent contributors. get_maintainer.pl: Do not blindly cc: them on patches! Use common sense. $ ./scripts/get_maintainer.pl -f hw/misc/virt_ctrl.c Laurent Vivier <laurent@vivier.eu> (maintainer:virt) qemu-devel@nongnu.org (open list:All patches CC here) Cc'ing Laurent. Maybe worth squashing: -- >8 -- diff --git a/MAINTAINERS b/MAINTAINERS index cd8d6b140f..2fe435ea9e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1283,6 +1283,7 @@ F: include/hw/char/goldfish_tty.h F: include/hw/intc/goldfish_pic.h F: include/hw/intc/m68k_irqc.h F: include/hw/misc/virt_ctrl.h +F: docs/specs/virt-ctlr.rst --- > diff --git a/docs/specs/index.rst b/docs/specs/index.rst > index ee84b8109d6..8d30968650b 100644 > --- a/docs/specs/index.rst > +++ b/docs/specs/index.rst > @@ -29,3 +29,4 @@ guest hardware that is specific to QEMU. > ivshmem-spec > pvpanic > standard-vga > + virt-ctlr > diff --git a/docs/specs/virt-ctlr.txt b/docs/specs/virt-ctlr.rst > similarity index 70% > rename from docs/specs/virt-ctlr.txt > rename to docs/specs/virt-ctlr.rst > index 24d38084f7f..ad3edde82d2 100644 > --- a/docs/specs/virt-ctlr.txt > +++ b/docs/specs/virt-ctlr.rst > @@ -1,9 +1,9 @@ > Virtual System Controller > ========================= > > -This device is a simple interface defined for the pure virtual machine with no > -hardware reference implementation to allow the guest kernel to send command > -to the host hypervisor. > +The ``virt-ctrl`` device is a simple interface defined for the pure Clearer. Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> > +virtual machine with no hardware reference implementation to allow the > +guest kernel to send command to the host hypervisor. > > The specification can evolve, the current state is defined as below. > > @@ -11,14 +11,12 @@ This is a MMIO mapped device using 256 bytes. > > Two 32bit registers are defined: > > -1- the features register (read-only, address 0x00) > - > +the features register (read-only, address 0x00) > This register allows the device to report features supported by the > controller. > The only feature supported for the moment is power control (0x01). > > -2- the command register (write-only, address 0x04) > - > +the command register (write-only, address 0x04) > This register allows the kernel to send the commands to the hypervisor. > The implemented commands are part of the power control feature and > are reset (1), halt (2) and panic (3).
On Tue, 31 Oct 2023 at 15:39, Philippe Mathieu-Daudé <philmd@linaro.org> wrote: > > On 27/9/23 17:12, Peter Maydell wrote: > > Convert docs/specs/virt-ctlr.txt to rST format. > > > > I added the name of the device to give readers a bit more idea > > of which device we're actually documenting here. > > > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > > --- > > docs/specs/index.rst | 1 + > > docs/specs/{virt-ctlr.txt => virt-ctlr.rst} | 12 +++++------- > > 2 files changed, 6 insertions(+), 7 deletions(-) > > rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%) > > > $ ./scripts/get_maintainer.pl -f docs/specs/virt-ctlr.txt > get_maintainer.pl: No maintainers found, printing recent contributors. > get_maintainer.pl: Do not blindly cc: them on patches! Use common sense. > > $ ./scripts/get_maintainer.pl -f hw/misc/virt_ctrl.c > Laurent Vivier <laurent@vivier.eu> (maintainer:virt) > qemu-devel@nongnu.org (open list:All patches CC here) > > Cc'ing Laurent. That raises the question, is it intentional that the doc is virt-ctlr but the source file is virt-ctrl ? Should we rename one of them (looks like the doc, so easy enough to do as part of this patch)? thanks -- PMM
On 31/10/23 16:43, Peter Maydell wrote: > On Tue, 31 Oct 2023 at 15:39, Philippe Mathieu-Daudé <philmd@linaro.org> wrote: >> >> On 27/9/23 17:12, Peter Maydell wrote: >>> Convert docs/specs/virt-ctlr.txt to rST format. >>> >>> I added the name of the device to give readers a bit more idea >>> of which device we're actually documenting here. >>> >>> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> >>> --- >>> docs/specs/index.rst | 1 + >>> docs/specs/{virt-ctlr.txt => virt-ctlr.rst} | 12 +++++------- >>> 2 files changed, 6 insertions(+), 7 deletions(-) >>> rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%) >> >> >> $ ./scripts/get_maintainer.pl -f docs/specs/virt-ctlr.txt >> get_maintainer.pl: No maintainers found, printing recent contributors. >> get_maintainer.pl: Do not blindly cc: them on patches! Use common sense. >> >> $ ./scripts/get_maintainer.pl -f hw/misc/virt_ctrl.c >> Laurent Vivier <laurent@vivier.eu> (maintainer:virt) >> qemu-devel@nongnu.org (open list:All patches CC here) >> >> Cc'ing Laurent. > > That raises the question, is it intentional that the doc > is virt-ctlr but the source file is virt-ctrl ? Should we > rename one of them (looks like the doc, so easy enough to > do as part of this patch)? $ git grep ctlr| wc -l 430 $ git grep ctrl| wc -l 4063 Since you are already renaming the file, correcting the typo in the same file seems like a good idea.
diff --git a/docs/specs/index.rst b/docs/specs/index.rst index ee84b8109d6..8d30968650b 100644 --- a/docs/specs/index.rst +++ b/docs/specs/index.rst @@ -29,3 +29,4 @@ guest hardware that is specific to QEMU. ivshmem-spec pvpanic standard-vga + virt-ctlr diff --git a/docs/specs/virt-ctlr.txt b/docs/specs/virt-ctlr.rst similarity index 70% rename from docs/specs/virt-ctlr.txt rename to docs/specs/virt-ctlr.rst index 24d38084f7f..ad3edde82d2 100644 --- a/docs/specs/virt-ctlr.txt +++ b/docs/specs/virt-ctlr.rst @@ -1,9 +1,9 @@ Virtual System Controller ========================= -This device is a simple interface defined for the pure virtual machine with no -hardware reference implementation to allow the guest kernel to send command -to the host hypervisor. +The ``virt-ctrl`` device is a simple interface defined for the pure +virtual machine with no hardware reference implementation to allow the +guest kernel to send command to the host hypervisor. The specification can evolve, the current state is defined as below. @@ -11,14 +11,12 @@ This is a MMIO mapped device using 256 bytes. Two 32bit registers are defined: -1- the features register (read-only, address 0x00) - +the features register (read-only, address 0x00) This register allows the device to report features supported by the controller. The only feature supported for the moment is power control (0x01). -2- the command register (write-only, address 0x04) - +the command register (write-only, address 0x04) This register allows the kernel to send the commands to the hypervisor. The implemented commands are part of the power control feature and are reset (1), halt (2) and panic (3).
Convert docs/specs/virt-ctlr.txt to rST format. I added the name of the device to give readers a bit more idea of which device we're actually documenting here. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- docs/specs/index.rst | 1 + docs/specs/{virt-ctlr.txt => virt-ctlr.rst} | 12 +++++------- 2 files changed, 6 insertions(+), 7 deletions(-) rename docs/specs/{virt-ctlr.txt => virt-ctlr.rst} (70%)