[PATCH] dev manual, ch 1: various pedantic nitpickery

[PATCH] dev manual, ch 1: various pedantic nitpickery

[Robert P. J. Day]

Some minor grammatical and structure tweaks.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  two general changes i'm going to submit for all of dev manual (among
others):

  1) no exclamation marks, unless you're referring to the rock duo
     wham!

  2) no unnecessary capitalization

diff --git a/documentation/dev-manual/intro.rst b/documentation/dev-manual/intro.rst
index 23c848e87..0f7370a96 100644
--- a/documentation/dev-manual/intro.rst
+++ b/documentation/dev-manual/intro.rst
@@ -7,16 +7,16 @@ The Yocto Project Development Tasks Manual
 Welcome
 =======

-Welcome to the Yocto Project Development Tasks Manual! This manual
+Welcome to the Yocto Project Development Tasks Manual. This manual
 provides relevant procedures necessary for developing in the Yocto
 Project environment (i.e. developing embedded Linux images and
-user-space applications that run on targeted devices). The manual groups
+user-space applications that run on targeted devices). This manual groups
 related procedures into higher-level sections. Procedures can consist of
 high-level steps or low-level steps depending on the topic.

 This manual provides the following:

--  Procedures that help you get going with the Yocto Project. For
+-  Procedures that help you get going with the Yocto Project; for
    example, procedures that show you how to set up a build host and work
    with the Yocto Project source repositories.

@@ -24,25 +24,25 @@ This manual provides the following:
    Changes can be improvements, new features, or bug fixes.

 -  Procedures related to "everyday" tasks you perform while developing
-   images and applications using the Yocto Project. For example,
-   procedures to create a layer, customize an image, write a new recipe,
+   images and applications using the Yocto Project, such as
+   creating a new layer, customizing an image, writing a new recipe,
    and so forth.

 This manual does not provide the following:

--  Redundant Step-by-step Instructions: For example, the
+-  Redundant step-by-step instructions: For example, the
    :doc:`/sdk-manual/index` manual contains detailed
    instructions on how to install an SDK, which is used to develop
    applications for target hardware.

--  Reference or Conceptual Material: This type of material resides in an
-   appropriate reference manual. For example, system variables are
+-  Reference or conceptual material: This type of material resides in an
+   appropriate reference manual. As an example, system variables are
    documented in the :doc:`/ref-manual/index`.

--  Detailed Public Information Not Specific to the Yocto Project: For
-   example, exhaustive information on how to use the Source Control
-   Manager Git is better covered with Internet searches and official Git
-   Documentation than through the Yocto Project documentation.
+-  Detailed public information not specific to the Yocto Project: For
+   example, exhaustive information on how to use the Git version
+   control system is better covered with Internet searches and official Git
+   documentation than through the Yocto Project documentation.

 Other Information
 =================

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: [docs] [PATCH] dev manual, ch 1: various pedantic nitpickery

[Quentin Schulz]

Hi Robert,

On Fri, Aug 27, 2021 at 03:57:43PM -0400, Robert P. J. Day wrote:
> 
> Some minor grammatical and structure tweaks.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 

Reviewed-by: Quentin Schulz <foss@0leil.net>

Thanks!
Quentin

Re: [docs] [PATCH] dev manual, ch 1: various pedantic nitpickery

[Michael Opdenacker]

On 8/30/21 10:05 AM, Quentin Schulz wrote:
> Hi Robert,
>
> On Fri, Aug 27, 2021 at 03:57:43PM -0400, Robert P. J. Day wrote:
>> Some minor grammatical and structure tweaks.
>>
>> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>>
> Reviewed-by: Quentin Schulz <foss@0leil.net>

Merged into master-next. Thanks for the patch and review!

Michael.

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

Re: [docs] [PATCH] dev manual, ch 1: various pedantic nitpickery

[Michael Opdenacker]

Hi Robert,

On 8/27/21 9:57 PM, Robert P. J. Day wrote:
> --  Reference or Conceptual Material: This type of material resides in an
> -   appropriate reference manual. For example, system variables are
> +-  Reference or conceptual material: This type of material resides in an
> +   appropriate reference manual. As an example, system variables are
>     documented in the :doc:`/ref-manual/index`.


Thanks to you, I realized that uppercase is legal and even recommended
when a sentence starts after a colon:
https://www.grammarly.com/blog/capitalization-after-colons/

I haven't seen this yet in Romance languages, but this definitely makes
sense.
Thanks again!

Michael.

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