[PATCH 2/3] bsps/sparc: Add copyright and license information

Joel Sherrill joel.sherrill at OARcorp.com
Mon May 12 15:50:52 UTC 2014


I know this is a non-obvious pain in the (*& request but the proper
file header is more like this:

/**
 * @file
 *
 * @ingroup CPU_BSP
 *
 * @brief XXX
 */

/*
  * COPYRIGHT AND LICENSE INFORMATION
  */

If the Doxygen blends with the license/copyright, the
copyright/license ends up repeated as commentary in
the Doxygen.

Also many BSPs still have the information that should
be in the Doxygen file header part in a comment block
with the copyright/license.

This is actually explained here:
http://www.rtems.org/wiki/index.php/Coding_Conventions
but if it isn't clear, we can fix it.

Since you are touching that part of the files, let's try to
fix the problems.

Thanks.

--joel

On 5/12/2014 9:39 AM, Daniel Cederman wrote:
> ---
>  .../lib/libbsp/sparc/erc32/erc32sonic/erc32sonic.c |    7 +++++++
>  c/src/lib/libbsp/sparc/erc32/gnatsupp/gnatsupp.c   |   12 ++++++++++--
>  c/src/lib/libbsp/sparc/erc32/startup/boardinit.S   |    8 ++++++++
>  c/src/lib/libbsp/sparc/leon2/cchip/cchip.c         |    3 +++
>  c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c   |    8 ++++++++
>  c/src/lib/libbsp/sparc/leon2/include/cchip.h       |    9 +++++++++
>  c/src/lib/libbsp/sparc/leon2/include/rasta.h       |    8 ++++++++
>  c/src/lib/libbsp/sparc/leon2/rasta/rasta.c         |    3 +++
>  c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c   |    8 ++++++++
>  9 files changed, 64 insertions(+), 2 deletions(-)
>
> diff --git a/c/src/lib/libbsp/sparc/erc32/erc32sonic/erc32sonic.c b/c/src/lib/libbsp/sparc/erc32/erc32sonic/erc32sonic.c
> index baa39ed..c818db4 100644
> --- a/c/src/lib/libbsp/sparc/erc32/erc32sonic/erc32sonic.c
> +++ b/c/src/lib/libbsp/sparc/erc32/erc32sonic/erc32sonic.c
> @@ -1,6 +1,13 @@
>  /*
>   *  THARSYS VME SPARC RT board SONIC Configuration Information
>   *
> + *  COPYRIGHT (c) 2000.
> + *  European Space Agency.
> + *
> + *  The license and distribution terms for this file may be
> + *  found in the file LICENSE in this distribution or at
> + *  http://www.rtems.org/license/LICENSE.
> + *
>   *  References:
>   *
>   *  1) SVME/DMV-171 Single Board Computer Documentation Package, #805905,
> diff --git a/c/src/lib/libbsp/sparc/erc32/gnatsupp/gnatsupp.c b/c/src/lib/libbsp/sparc/erc32/gnatsupp/gnatsupp.c
> index bc70883..b2115c3 100644
> --- a/c/src/lib/libbsp/sparc/erc32/gnatsupp/gnatsupp.c
> +++ b/c/src/lib/libbsp/sparc/erc32/gnatsupp/gnatsupp.c
> @@ -1,7 +1,15 @@
>  /*
>   *
> - * Support for gnat/rtems interrupts and exception handling.
> - * Jiri Gaisler, ESA/ESTEC, 17-02-1999.
> + *  Support for gnat/rtems interrupts and exception handling.
> + *  Jiri Gaisler, ESA/ESTEC, 17-02-1999.
> + *
> + *  COPYRIGHT (c) 1999.
> + *  European Space Agency.
> + *
> + *  The license and distribution terms for this file may be
> + *  found in the file LICENSE in this distribution or at
> + *  http://www.rtems.org/license/LICENSE.
> + *
>   */
>  
>  #include <bsp/gnatcommon.h>
> diff --git a/c/src/lib/libbsp/sparc/erc32/startup/boardinit.S b/c/src/lib/libbsp/sparc/erc32/startup/boardinit.S
> index 2c96af5..046678f 100644
> --- a/c/src/lib/libbsp/sparc/erc32/startup/boardinit.S
> +++ b/c/src/lib/libbsp/sparc/erc32/startup/boardinit.S
> @@ -2,6 +2,14 @@
>   *  boardinit.s
>   *
>   *  Initialise various ERC32 registers
> + *
> + *  COPYRIGHT (c) 2000.
> + *  European Space Agency.
> + *
> + *  The license and distribution terms for this file may be
> + *  found in the file LICENSE in this distribution or at
> + *  http://www.rtems.org/license/LICENSE.
> + *
>   */
>  
>  #include <rtems/asm.h>
> diff --git a/c/src/lib/libbsp/sparc/leon2/cchip/cchip.c b/c/src/lib/libbsp/sparc/leon2/cchip/cchip.c
> index c1f4d43..fe45f2e 100644
> --- a/c/src/lib/libbsp/sparc/leon2/cchip/cchip.c
> +++ b/c/src/lib/libbsp/sparc/leon2/cchip/cchip.c
> @@ -7,6 +7,9 @@
>  /*
>   *  GR-701 (Companion Chip) PCI board driver
>   *
> + *  COPYRIGHT (c) 2007.
> + *  Aeroflex Gaisler AB.
> + *
>   *  The license and distribution terms for this file may be
>   *  found in the file LICENSE in this distribution or at
>   *  http://www.rtems.org/license/LICENSE.
> diff --git a/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c b/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c
> index 820252d..f90bbc3 100644
> --- a/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c
> +++ b/c/src/lib/libbsp/sparc/leon2/gnatsupp/gnatsupp.c
> @@ -8,6 +8,14 @@
>   *
>   * Support for gnat/rtems interrupts and exception handling.
>   * Jiri Gaisler, ESA/ESTEC, 17-02-1999.
> + *
> + * COPYRIGHT (c) 1999.
> + * European Space Agency.
> + *
> + * The license and distribution terms for this file may be
> + * found in the file LICENSE in this distribution or at
> + * http://www.rtems.org/license/LICENSE.
> + *
>   */
>  
>  #include <bsp/gnatcommon.h>
> diff --git a/c/src/lib/libbsp/sparc/leon2/include/cchip.h b/c/src/lib/libbsp/sparc/leon2/include/cchip.h
> index beb9f74..2844410 100644
> --- a/c/src/lib/libbsp/sparc/leon2/include/cchip.h
> +++ b/c/src/lib/libbsp/sparc/leon2/include/cchip.h
> @@ -5,6 +5,15 @@
>   * @brief Register all drivers supported by the Companion Chip board
>   */
>  
> +/*
> + *  COPYRIGHT (c) 2007.
> + *  Aeroflex Gaisler AB.
> + *
> + *  The license and distribution terms for this file may be
> + *  found in the file LICENSE in this distribution or at
> + *  http://www.rtems.org/license/LICENSE.
> + */
> +
>  #ifndef __CCHIP_H__
>  #define __CCHIP_H__
>  
> diff --git a/c/src/lib/libbsp/sparc/leon2/include/rasta.h b/c/src/lib/libbsp/sparc/leon2/include/rasta.h
> index 8352900..dff9a49 100644
> --- a/c/src/lib/libbsp/sparc/leon2/include/rasta.h
> +++ b/c/src/lib/libbsp/sparc/leon2/include/rasta.h
> @@ -3,6 +3,14 @@
>   * @defgroup leon2_rasta Rasta Handler
>   * @ingroup sparc_leon2
>   * @brief Handles Rasta
> + *
> + *  COPYRIGHT (c) 2007.
> + *  Aeroflex Gaisler AB.
> + *
> + *  The license and distribution terms for this file may be
> + *  found in the file LICENSE in this distribution or at
> + *  http://www.rtems.org/license/LICENSE.
> + *
>   */
>  
>  #ifndef __RASTA_H__
> diff --git a/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c b/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c
> index b439bcb..e4faaff 100644
> --- a/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c
> +++ b/c/src/lib/libbsp/sparc/leon2/rasta/rasta.c
> @@ -7,6 +7,9 @@
>  /*
>   *  GR-RASTA-IO PCI board driver
>   *
> + *  COPYRIGHT (c) 2007.
> + *  Aeroflex Gaisler AB.
> + *
>   *  The license and distribution terms for this file may be
>   *  found in the file LICENSE in this distribution or at
>   *  http://www.rtems.org/license/LICENSE.
> diff --git a/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c b/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
> index 3190627..9dc3c2c 100644
> --- a/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
> +++ b/c/src/lib/libbsp/sparc/leon3/gnatsupp/gnatsupp.c
> @@ -6,6 +6,14 @@
>  
>  /*
>   * Jiri Gaisler, ESA/ESTEC, 17-02-1999.
> + *
> + * COPYRIGHT (c) 1999.
> + * European Space Agency.
> + *
> + * The license and distribution terms for this file may be
> + * found in the file LICENSE in this distribution or at
> + * http://www.rtems.org/license/LICENSE.
> + *
>   */
>  
>  #include <bsp/gnatcommon.h>

-- 
Joel Sherrill, Ph.D.             Director of Research & Development
joel.sherrill at OARcorp.com        On-Line Applications Research
Ask me about RTEMS: a free RTOS  Huntsville AL 35805
Support Available                (256) 722-9985




More information about the devel mailing list