[PATCH 1/2] eng: Add application config options how-to

Gedare Bloom gedare at rtems.org
Thu Aug 6 18:34:07 UTC 2020


On Thu, Aug 6, 2020 at 12:24 PM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Hello Gedare,
>
> thanks for the review. I tried to fix most of the issues in v2.
>
> On 06/08/2020 18:57, Gedare Bloom wrote:
> >> +Generate Content after Changes
> >> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >> +
> >> +Once you are done with the modifications of an existing item or the creation of
> > The rest of this document is in the third person or second-person
> > understood (meaning, we never say "you" but it is understood that
> > "you" do the things). It may be more consistent to remove these "you":
>
> Chris was also not that happy about this "you" style which I have from:
>
> https://plainlanguage.gov/
>
> Since I used this also elsewhere I would like to keep it for now.
>

OK, that's fine. My complaint is more along the lines of
inconsistency. Seeking plain/understandable language is noble, but may
conflict with the goals of technical documentation. I'm not an expert
on either of those though! (Thankfully, I haven't written too much of
the documentation in my academic style, hah.)

v2 looks good to me.


More information about the devel mailing list