[PATCH] doxygen: Replace main page

[Sebastian Huber]

On 27.07.23 02:13, Joel Sherrill wrote:
> 
> 
> On Wed, Jul 26, 2023 at 12:50 AM Sebastian Huber 
> <sebastian.huber at embedded-brains.de 
> <mailto:sebastian.huber at embedded-brains.de>> wrote:
> 
>     Replace the main page with a high level description of the RTEMS feature
>     set similar to:
> 
>     https://docs.rtems.org/branches/master/user/overview/index.html#features <https://docs.rtems.org/branches/master/user/overview/index.html#features>
> 
>     The replaced content can be found in the RTEMS Classic API Guide:
> 
>     https://docs.rtems.org/branches/master/c-user/overview.html
>     <https://docs.rtems.org/branches/master/c-user/overview.html>
> 
>     https://docs.rtems.org/branches/master/c-user/key_concepts.html
>     <https://docs.rtems.org/branches/master/c-user/key_concepts.html>
> 
>     Update #3705.
>     ---
>       cpukit/include/rtems/rtems/mainpage.h | 1078 ++++---------------------
>       1 file changed, 166 insertions(+), 912 deletions(-)
> 
>     diff --git a/cpukit/include/rtems/rtems/mainpage.h
>     b/cpukit/include/rtems/rtems/mainpage.h
>     index f168cc3395..d284429d20 100644
>     --- a/cpukit/include/rtems/rtems/mainpage.h
>     +++ b/cpukit/include/rtems/rtems/mainpage.h
>     @@ -10,8 +10,7 @@
>        */
> 
>       /*
>     - *  COPYRIGHT (c) 1989-2014.
>     - *  On-Line Applications Research Corporation (OAR).
>     + * Copyright (C) 2021 embedded brains GmbH & Co. KG
> 
> 
> No. You are reformatting this. This text dates back to the beginnings of
> RTEMS. You should NOT remove the OAR copyright.

I am quite careful with copyright, but everyone can make mistakes. This 
patch replaces the original content with the new features section from:

https://git.rtems.org/rtems-docs/commit/user/overview/index.rst?id=52f4890281a50d7d2e27386257cc9799d9152707

Which updated OAR Copyright line do you want to see in this patch? I 
will add it to v2 of the patch.

[...]
>     + * The Real-Time Executive for Multiprocessor Systems (RTEMS) is a
>     + * multi-threaded, single address-space, real-time operating system
>     with no
>     + * kernel-space/user-space separation.  It is capable to operate in
>     an SMP
>     + * configuration providing a state of the art feature set.
>     + *
>     + * RTEMS is licensed under a [modified GPL 2.0 or later license with an
>     + * exception for static
>     linking](https://git.rtems.org/rtems/tree/LICENSE
>     <https://git.rtems.org/rtems/tree/LICENSE>>).
>     + * It exposes no license requirements on application code.  The
>     third-party
>     + * software used and distributed by RTEMS which may be linked to the
>     + * application is licensed under permissive open source licenses. 
>     Everything
>     + * necessary to build RTEMS applications is available as open
>     source software.
>     + * This makes you completely vendor independent.
>     + *
>     + * The goal is to use the [BSD 2-Clause
>     + * license](https://git.rtems.org/rtems/tree/LICENSE.BSD-2-Clause
>     <https://git.rtems.org/rtems/tree/LICENSE.BSD-2-Clause>) for new code
>     + * or code those copyright holder agreed to a license change, see
>     + * [#3053](https://devel.rtems.org/ticket/3053
>     <https://devel.rtems.org/ticket/3053>) for the details.
> 
> 
> This is true but out of date. The bulk of the target and BSP independent 
> code
> is BSD-2 and we state that first. There are older submissions -- 
> primarily around
> BSPs and a couple of architectures where GPL code is present.
> 
> We state now that we are BSD-2 with remnants of GPLv2 + exception and will
> NOT accept code under the old license.

Yes, the patch is actually from 2021, but I was busy with other things 
in the meantime. I will reformulate this section for v2. The user manual 
probably needs also an update:

https://docs.rtems.org/branches/master/user/overview/index.html#features

-- 
embedded brains GmbH
Herr Sebastian HUBER
Dornierstr. 4
82178 Puchheim
Germany
email: sebastian.huber at embedded-brains.de
phone: +49-89-18 94 741 - 16
fax:   +49-89-18 94 741 - 08

Registergericht: Amtsgericht München
Registernummer: HRB 157899
Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
Unsere Datenschutzerklärung finden Sie hier:
https://embedded-brains.de/datenschutzerklaerung/