[PATCH v2] doc: bitbake-user-manual: grammar fix for the number of "metadata"

[PATCH v2] doc: bitbake-user-manual: grammar fix for the number of "metadata"

[Michael Opdenacker]

"metadata" is used both as singular and as plural.
The first change fixes a case in which the verb has a singular conjugation
but absence of article indicates a plural case.

The second and third changes are for consistency with the first one inside
the same paragraph.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
---
 doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index eb140665..55effc35 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -27,11 +27,11 @@ Linux software stacks using a task-oriented approach.
 Conceptually, BitBake is similar to GNU Make in some regards but has
 significant differences:
 
--  BitBake executes tasks according to provided metadata that builds up
-   the tasks. Metadata is stored in recipe (``.bb``) and related recipe
+-  BitBake executes tasks according to provided metadata that build up
+   the tasks. Metadata are stored in recipe (``.bb``) and related recipe
    "append" (``.bbappend``) files, configuration (``.conf``) and
    underlying include (``.inc``) files, and in class (``.bbclass``)
-   files. The metadata provides BitBake with instructions on what tasks
+   files. The metadata provide BitBake with instructions on what tasks
    to run and the dependencies between those tasks.
 
 -  BitBake includes a fetcher library for obtaining source code from
-- 
2.25.1

Re: [docs] [PATCH v2] doc: bitbake-user-manual: grammar fix for the number of "metadata"

[Richard Purdie]

On Thu, 2021-07-29 at 15:13 +0200, Michael Opdenacker wrote:
> "metadata" is used both as singular and as plural.
> The first change fixes a case in which the verb has a singular conjugation
> but absence of article indicates a plural case.
> 
> The second and third changes are for consistency with the first one inside
> the same paragraph.
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Reviewed-by: Quentin Schulz <foss@0leil.net>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> index eb140665..55effc35 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
> @@ -27,11 +27,11 @@ Linux software stacks using a task-oriented approach.
>  Conceptually, BitBake is similar to GNU Make in some regards but has
>  significant differences:
>  
> 
> --  BitBake executes tasks according to provided metadata that builds up
> -   the tasks. Metadata is stored in recipe (``.bb``) and related recipe
> +-  BitBake executes tasks according to provided metadata that build up
> +   the tasks. Metadata are stored in recipe (``.bb``) and related recipe
>     "append" (``.bbappend``) files, configuration (``.conf``) and
>     underlying include (``.inc``) files, and in class (``.bbclass``)
> -   files. The metadata provides BitBake with instructions on what tasks
> +   files. The metadata provide BitBake with instructions on what tasks
>     to run and the dependencies between those tasks.

This change doesn't sound like an improvement to me. I would always say 
"The metadata provides", not what you have here which doesn't read 
correctly to me. "builds up" also sounds better to me than "build up". I'd
also say "Metadata is" sounds more correct too.

I'm not sure I like the original wording but this doesn't sound right, at
least to me.

Cheers,

Richard

Re: [bitbake-devel] [docs] [PATCH v2] doc: bitbake-user-manual: grammar fix for the number of "metadata"

[Michael Opdenacker]

Hi Richard,

On 7/29/21 3:51 PM, Richard Purdie wrote:
> On Thu, 2021-07-29 at 15:13 +0200, Michael Opdenacker wrote:
>> "metadata" is used both as singular and as plural.
>> The first change fixes a case in which the verb has a singular conjugation
>> but absence of article indicates a plural case.
>>
>> The second and third changes are for consistency with the first one inside
>> the same paragraph.
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> Reviewed-by: Quentin Schulz <foss@0leil.net>
>> ---
>>  doc/bitbake-user-manual/bitbake-user-manual-intro.rst | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
>> index eb140665..55effc35 100644
>> --- a/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
>> +++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
>> @@ -27,11 +27,11 @@ Linux software stacks using a task-oriented approach.
>>  Conceptually, BitBake is similar to GNU Make in some regards but has
>>  significant differences:
>>  
>>
>> --  BitBake executes tasks according to provided metadata that builds up
>> -   the tasks. Metadata is stored in recipe (``.bb``) and related recipe
>> +-  BitBake executes tasks according to provided metadata that build up
>> +   the tasks. Metadata are stored in recipe (``.bb``) and related recipe
>>     "append" (``.bbappend``) files, configuration (``.conf``) and
>>     underlying include (``.inc``) files, and in class (``.bbclass``)
>> -   files. The metadata provides BitBake with instructions on what tasks
>> +   files. The metadata provide BitBake with instructions on what tasks
>>     to run and the dependencies between those tasks.
> This change doesn't sound like an improvement to me. I would always say 
> "The metadata provides", not what you have here which doesn't read 
> correctly to me. "builds up" also sounds better to me than "build up". I'd
> also say "Metadata is" sounds more correct too.
>
> I'm not sure I like the original wording but this doesn't sound right, at
> least to me.


Many thanks for the review. I know what to update then :)
Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com