| Message ID | 20230720071610.1096458-4-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Tidy up doc comments | expand |
On 20/7/23 09:16, Markus Armbruster wrote: > The notes section comes out like this: > > Notes > > Additional arguments depend on the type. > > 1. For detailed information about this command, please refer to the > ‘docs/qdev-device-use.txt’ file. > > 2. It’s possible to list device properties by running QEMU with the > “-device DEVICE,help” command-line argument, where DEVICE is the > device’s name > > The first item isn't numbered. Fix that: > > 1. Additional arguments depend on the type. > > 2. For detailed information about this command, please refer to the > ‘docs/qdev-device-use.txt’ file. > > 3. It’s possible to list device properties by running QEMU with the > “-device DEVICE,help” command-line argument, where DEVICE is the > device’s name > > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > qapi/qdev.json | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
diff --git a/qapi/qdev.json b/qapi/qdev.json index 2d73b27c2a..6bc5a733b8 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -53,12 +53,12 @@ # # Notes: # -# Additional arguments depend on the type. +# 1. Additional arguments depend on the type. # -# 1. For detailed information about this command, please refer to the +# 2. For detailed information about this command, please refer to the # 'docs/qdev-device-use.txt' file. # -# 2. It's possible to list device properties by running QEMU with the +# 3. It's possible to list device properties by running QEMU with the # "-device DEVICE,help" command-line argument, where DEVICE is the # device's name #
The notes section comes out like this: Notes Additional arguments depend on the type. 1. For detailed information about this command, please refer to the ‘docs/qdev-device-use.txt’ file. 2. It’s possible to list device properties by running QEMU with the “-device DEVICE,help” command-line argument, where DEVICE is the device’s name The first item isn't numbered. Fix that: 1. Additional arguments depend on the type. 2. For detailed information about this command, please refer to the ‘docs/qdev-device-use.txt’ file. 3. It’s possible to list device properties by running QEMU with the “-device DEVICE,help” command-line argument, where DEVICE is the device’s name Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi/qdev.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)