diff mbox series

[5/6] qapi: Correct "eg." to "e.g." in documentation

Message ID 20230720071610.1096458-6-armbru@redhat.com
State New
Headers show
Series qapi: Tidy up doc comments | expand

Commit Message

Markus Armbruster July 20, 2023, 7:16 a.m. UTC
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/char.json | 2 +-
 qapi/misc.json | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Philippe Mathieu-Daudé July 20, 2023, 1:41 p.m. UTC | #1
Hi Markus,

On 20/7/23 09:16, Markus Armbruster wrote:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/char.json | 2 +-
>   qapi/misc.json | 2 +-
>   2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/qapi/char.json b/qapi/char.json
> index e413ac2b70..52aaff25eb 100644
> --- a/qapi/char.json
> +++ b/qapi/char.json
> @@ -18,7 +18,7 @@
>   # @filename: the filename of the character device
>   #
>   # @frontend-open: shows whether the frontend device attached to this
> -#     backend (eg. with the chardev=... option) is in open or closed
> +#     backend (e.g. with the chardev=... option) is in open or closed
>   #     state (since 2.1)
>   #
>   # Notes: @filename is encoded using the QEMU command line character
> diff --git a/qapi/misc.json b/qapi/misc.json
> index ff070ec828..cda2effa81 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -18,7 +18,7 @@
>   # fail and the FD will be closed.
>   #
>   # @protocol: protocol name.  Valid names are "vnc", "spice",
> -#     "@dbus-display" or the name of a character device (eg. from
> +#     "@dbus-display" or the name of a character device (e.g. from
>   #     -chardev id=XXXX)
>   #
>   # @fdname: file descriptor name previously passed via 'getfd' command

$ git grep -wF 'eg.' | wc -l
       45

Why not fix all the tree?
Markus Armbruster July 20, 2023, 3:13 p.m. UTC | #2
Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> Hi Markus,
>
> On 20/7/23 09:16, Markus Armbruster wrote:
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>   qapi/char.json | 2 +-
>>   qapi/misc.json | 2 +-
>>   2 files changed, 2 insertions(+), 2 deletions(-)
>> diff --git a/qapi/char.json b/qapi/char.json
>> index e413ac2b70..52aaff25eb 100644
>> --- a/qapi/char.json
>> +++ b/qapi/char.json
>> @@ -18,7 +18,7 @@
>>   # @filename: the filename of the character device
>>   #
>>   # @frontend-open: shows whether the frontend device attached to this
>> -#     backend (eg. with the chardev=... option) is in open or closed
>> +#     backend (e.g. with the chardev=... option) is in open or closed
>>   #     state (since 2.1)
>>   #
>>   # Notes: @filename is encoded using the QEMU command line character
>> diff --git a/qapi/misc.json b/qapi/misc.json
>> index ff070ec828..cda2effa81 100644
>> --- a/qapi/misc.json
>> +++ b/qapi/misc.json
>> @@ -18,7 +18,7 @@
>>   # fail and the FD will be closed.
>>   #
>>   # @protocol: protocol name.  Valid names are "vnc", "spice",
>> -#     "@dbus-display" or the name of a character device (eg. from
>> +#     "@dbus-display" or the name of a character device (e.g. from
>>   #     -chardev id=XXXX)
>>   #
>>   # @fdname: file descriptor name previously passed via 'getfd' command
>
> $ git grep -wF 'eg.' | wc -l
>       45
>
> Why not fix all the tree?

Because I have qapi/ myopia today?
diff mbox series

Patch

diff --git a/qapi/char.json b/qapi/char.json
index e413ac2b70..52aaff25eb 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -18,7 +18,7 @@ 
 # @filename: the filename of the character device
 #
 # @frontend-open: shows whether the frontend device attached to this
-#     backend (eg. with the chardev=... option) is in open or closed
+#     backend (e.g. with the chardev=... option) is in open or closed
 #     state (since 2.1)
 #
 # Notes: @filename is encoded using the QEMU command line character
diff --git a/qapi/misc.json b/qapi/misc.json
index ff070ec828..cda2effa81 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -18,7 +18,7 @@ 
 # fail and the FD will be closed.
 #
 # @protocol: protocol name.  Valid names are "vnc", "spice",
-#     "@dbus-display" or the name of a character device (eg. from
+#     "@dbus-display" or the name of a character device (e.g. from
 #     -chardev id=XXXX)
 #
 # @fdname: file descriptor name previously passed via 'getfd' command