[PATCH 1/2] rtems: Add "Generated from ..." comments

[Joel Sherrill]

On Wed, Oct 7, 2020 at 10:32 PM Chris Johns <chrisj at rtems.org> wrote:

> On 8/10/20 2:18 pm, Joel Sherrill wrote:
> > On Wed, Oct 7, 2020, 10:14 PM Chris Johns <chrisj at rtems.org
> > <mailto:chrisj at rtems.org>> wrote:
> >     On 7/10/20 9:14 pm, Sebastian Huber wrote:
> >     > Improve file header comment.
> >
> >     This is great.
> >
> > Agreed. I assume the spec: is defined somewhere.
>
> The patch has ...
>
> +/* Generated from spec:/rtems/if/group */
>
> and the file is ...
>
> https://git.rtems.org/rtems-central/tree/spec/rtems/if/group.yml


Awesome!

>
>
> These addition are a really good productivity improvement. It takes
> seconds to
> find the file and there is no guess work involved.
>

That definitely addresses a serious issue in maintaining anything that is
generated -- finding the spot to touch in the magical file it is generated
from.

Guess we will just have to be alert to where people struggle as we go
forward and make an effort to ensure questions are only asked once and
always answered with links to documentation.

--joel


> Chris
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20201008/9ea606de/attachment.html>