Top of file: licence header or Doxygen comment?

[Sebastian Huber]

On 19/02/2020 13:56, Joel Sherrill wrote:
> On Wed, Feb 19, 2020, 6:30 AM Sebastian Huber 
> <sebastian.huber at embedded-brains.de 
> <mailto:sebastian.huber at embedded-brains.de>> wrote:
> 
>     On 19/02/2020 13:01, Joel Sherrill wrote:
>      > On Wed, Feb 19, 2020, 12:21 AM Chris Johns <chrisj at rtems.org
>     <mailto:chrisj at rtems.org>
>      > <mailto:chrisj at rtems.org <mailto:chrisj at rtems.org>>> wrote:
>      >
>      >     On 19/2/20 5:18 pm, Sebastian Huber wrote:
>      >      > I want to add a header and source file header template to the
>      >     RTEMS Software
>      >      > Engineering manual. What should be on the top of the file? The
>      >     license header or
>      >      > the Doxygen file comment block?
>      >
>      >     License header.
>      >
>      >
>      > I think we have existing guidance that is the opposite of that
> 
>     Yes, should we change it? In other projects, the SPDX License
>     Identifier
>     is usually on top of the file.
> 
> 
> I don't want to change existing practice unless someone writes a program 
> to verify the order of the first two comment blocks and swap them.
> 
> Or (less desirable since it delays changing things a long time) we can 
> make a master list of these and make them GCI tasks. But we have trouble 
> getting mentors over the holidays. It still may not finish and it will 
> be at least a year before potential GCI students could make a dent (and 
> likely not fix all).
> 
> Write a program or leave the order alone.

I would restrict this task to BSD-2-Clause licensed files with an SDPX 
License Identifier.

Changing RTEMS licenced files to BSD-2-Clause is a different issue.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.