Re: Doxygen Guidelines: @brief for @file?

On 03/04/2019 15:48, Joel Sherrill wrote: On Wed, Apr 3, 2019 at 8:44 AM Sebastian Huber > wrote: On 03/04/2019 15:10, Joel Sherrill wrote: > > > On Wed, Apr 3, 2019 at 3:11 AM Sebastian Huber > mailto:sebastian.hu...@embedded-br

Re: [PATCH 26/28] doxygen: Added RTEMS Test Framework to API

On 4/4/19 12:43 am, Sebastian Huber wrote: > On 03/04/2019 14:57, Joel Sherrill wrote: >> I should have spotted it when the file t.h was added but we should avoid >> adding files to the top of the include tree. This space is primarily owned by >> POSIX, C, and applications. >> >> Also t.h is very s

[PATCH] Add Test suite for inttypes.h (psxinttypes.exe) in testsuites/psxtests

--- testsuites/psxtests/Makefile.am | 7 + testsuites/psxtests/configure.ac | 1 + testsuites/psxtests/psxinttypes01/init.c | 154 ++ .../psxtests/psxinttypes01/psxinttypes01.doc | 57 +++ .../psxtests/psxinttypes01/psxinttypes01.scn | 28

GSoC 2019 | Proposal Submitted

Hi I have submitted the PDF of the proposal at the GSoC site after discussion with Sebastian. Please let me know if there are any changes that need to be made. *Project:* Basic Suport for Trace Compass(ticket: #3696) *Proposal:* https://docs.google.com/document/d/1G6ISV_vIYLKl5Em2lwF8W91YrHWkve2

Re: Doxygen Guidelines: @brief for @file?

On Wed, Apr 3, 2019 at 8:44 AM Sebastian Huber < sebastian.hu...@embedded-brains.de> wrote: > On 03/04/2019 15:10, Joel Sherrill wrote: > > > > > > On Wed, Apr 3, 2019 at 3:11 AM Sebastian Huber > > > > wrote: > > > > Hello, > > > > I rework currently th

Re: Doxygen Guidelines: @brief for @file?

On 03/04/2019 15:10, Joel Sherrill wrote: On Wed, Apr 3, 2019 at 3:11 AM Sebastian Huber > wrote: Hello, I rework currently the Doxygen Guidelines in the RTEMS Software Engineering manual. I am not sure what we want to do with the @brief in the @fi

Re: [PATCH 26/28] doxygen: Added RTEMS Test Framework to API

On 03/04/2019 14:57, Joel Sherrill wrote: I should have spotted it when the file t.h was added but we should avoid adding files to the top of the include tree. This space is primarily owned by POSIX, C, and applications. Also t.h is very short with no value to being short. Being used in the t

Re: [PATCH 26/28] doxygen: Added RTEMS Test Framework to API

I should have spotted it when the file t.h was added but we should avoid adding files to the top of the include tree. This space is primarily owned by POSIX, C, and applications. Also t.h is very short with no value to being short. Being used in the tests, it could be arbitrarily long like t_test_

[PATCH 0/2] Rework Doxygen guidelines

Document for review: https://ftp.rtems.org/pub/rtems/people/sebh/eng.pdf Sebastian Huber (2): bsp-howto: Move BSP Doxygen recommendations eng: Rework Doxygen guidelines {eng => bsp-howto}/coding-doxygen-bsp.rst | 0 bsp-howto/index.rst | 1 + eng/coding-doxygen.rst

[PATCH 2/2] eng: Rework Doxygen guidelines

Update #3704. --- eng/coding-doxygen.rst | 652 - 1 file changed, 205 insertions(+), 447 deletions(-) diff --git a/eng/coding-doxygen.rst b/eng/coding-doxygen.rst index a155de1..da421d2 100644 --- a/eng/coding-doxygen.rst +++ b/eng/coding-doxygen.rs

[PATCH 1/2] bsp-howto: Move BSP Doxygen recommendations

Update #3704. --- {eng => bsp-howto}/coding-doxygen-bsp.rst | 0 bsp-howto/index.rst | 1 + eng/coding.rst| 1 - 3 files changed, 1 insertion(+), 1 deletion(-) rename {eng => bsp-howto}/coding-doxygen-bsp.rst (100%) diff --git a/eng/coding-doxyge

[PATCH v2] doxygen: Rework some Doxygen comments

They are intended as examples in the RTEMS Software Engineering manual. Update #3704. --- cpukit/include/rtems/rtems/message.h | 74 cpukit/include/rtems/score/rbtree.h | 4 +- cpukit/include/rtems/score/wkspace.h | 17 - 3 files changed, 51 insertio

[PATCH] doxygen: rtems: Rework doxygen comment

--- cpukit/include/rtems/rtems/message.h | 74 1 file changed, 42 insertions(+), 32 deletions(-) diff --git a/cpukit/include/rtems/rtems/message.h b/cpukit/include/rtems/rtems/message.h index d224c95d80..675cd98acc 100644 --- a/cpukit/include/rtems/rtems/mess

Re: [RFC/RFA] Obsolete Cell Broadband Engine SPU targets

On 03/04/2019 11:14, Peter Dufault wrote: I expect RTEMS with SPE-PowerPC will be stuck at GCC 8 and RTEMS version-locked as well. We should use GCC 7 for the RTEMS 5 release. Afterwards we should update to the latest development GCC and remove the SPE unit from the compiler flags. The SPE s

Re: [RFC/RFA] Obsolete Cell Broadband Engine SPU targets

You’re confusing the Sony/IBM/Toshiba SPU (Synergistic Processing Unit) that has some SPEs (Synergistic Processing Elements) with the Motorola then Freescale then NXP then ? E500 with the SPE (Signal Processing Extension). I’m using a processor with SPE on the Phytec MPC5554, but directly in a l

Re: [PATCH] common: Support Sphinx 2.0.0

On 03/04/2019 10:35, Chris Johns wrote: https://www.sphinx-doc.org/en/master/latex.html --- common/rtemsstyle.sty | 1 + 1 file changed, 1 insertion(+) diff --git a/common/rtemsstyle.sty b/common/rtemsstyle.sty index 15f80b5..1f88bce 100644 --- a/common/rtemsstyle.sty +++ b/common/rtemsstyle.

Re: [PATCH 3/4] bsps/riscv: UART - Comment code that queries UART interrupts

On 3/4/19 5:39 pm, Sebastian Huber wrote: > On 03/04/2019 00:07, Chris Johns wrote: >> Sure, that is fine ... but can we have some User Manual documentation of the >> options this BSP has if that is OK? :) > > https://docs.rtems.org/branches/master/user/bsps/bsps-riscv.html#build-configuration-opt

Re: [PATCH] common: Support Sphinx 2.0.0

On 3/4/19 6:25 pm, Sebastian Huber wrote: > Without this chage there is no custom RTEMS title page with Sphinx > 2.0.0. > > Maybe it is better to use the 'maketitle' option: > Yes but I need to get enough time to sort this out. I was heading down this path until we received excellent advice from

Doxygen Guidelines: @brief for @file?

Hello, I rework currently the Doxygen Guidelines in the RTEMS Software Engineering manual. I am not sure what we want to do with the @brief in the @file blocks. For me it is important that each file belongs to a group, so an @ingroup should be mandatory. With an @ingroup the @brief seems to b

[PATCH 11/28] doxygen: Added Version to API->Classic

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/recorddata.h | 2 ++ cpukit/include/rtems/timecounter.h | 2 ++ cpukit/include/rtems/version.h | 4 ++-- cpukit/sapi/src/version.c | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/cpukit/include/

[PATCH 28/28] doxygen: Split up "libmisc" subgroups and removed libmisc

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 8 cpukit/include/rtems/bspcmdline.h | 4 +++- cpukit/include/rtems/cpuuse.h | 7 +++ cpukit/include/rtems/dumpbuf.h| 2 +- cpukit/include/rtems/mw_uid.h | 7 +++ cpukit/include/rtems/sta

[PATCH 25/28] doxygen: Added inttypes.h to Print Support

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/inttypes.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/rtems/inttypes.h b/cpukit/include/rtems/inttypes.h index 406e7dd527..58ac3b1b7a 100644 --- a/cpukit/include/rtems/inttypes.h +++ b/cpukit/include/rtems

[PATCH 15/28] doxygen: Put SPI Driver into group Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/include/dev/spi/spi.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/dev/spi/spi.h b/cpukit/include/dev/spi/spi.h index f0f84f1461..872996f089 100644 --- a/cpukit/include/dev/spi/spi.h +++ b/cpukit/include/dev/spi/spi.h @@

[PATCH 27/28] doxygen: New API subgroup Tracing

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 8 cpukit/include/rtems/capture.h| 2 +- cpukit/include/rtems/recorddata.h | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index d8a49794ad..65

[PATCH 12/28] doxygen: Added I2C Driver to Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/include/dev/i2c/i2c.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/dev/i2c/i2c.h b/cpukit/include/dev/i2c/i2c.h index 5f6caf699e..61a1e1be51 100644 --- a/cpukit/include/dev/i2c/i2c.h +++ b/cpukit/include/dev/i2c/i2c.h @@

[PATCH 24/28] doxygen: Added subclasses to API->Classic

From: Andreas Dachsberger Update #3706. RTEMS Application Loader, RTEMS Runtime Link Editor, Status Checks and Test Support --- cpukit/include/rtems/rtl/rap.h | 2 ++ cpukit/include/rtems/rtl/rtl.h | 2 ++ cpukit/include/rtems/status-checks.h | 2 ++ cpukit/include/rtems/test.h

[PATCH 21/28] doxygen: Mouse now in Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index 5f214fe5cd..9beeb63614 100644 --- a/cpukit/doxygen.h +++ b/cpukit/doxygen.h @@ -67,7 +67,7 @@ /** * @defgroup libmisc_mous

[PATCH 05/28] doxygen: Added libmisc group and libmisc mouse group

From: Andreas Dachsberger Update #3706. @ingroup for these groups already existed, but no @defgroup Further restructuring necessary --- cpukit/doxygen.h | 17 + cpukit/include/rtems/bspcmdline.h | 5 ++--- 2 files changed, 19 insertions(+), 3 deletions(-) dif

[PATCH 08/28] doxygen: Removed XXX group

From: Andreas Dachsberger Update #3706. Content was added to Classic Barrier Implementation --- cpukit/include/rtems/rtems/barrierdata.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/include/rtems/rtems/barrierdata.h b/cpukit/include/rtems/rtems/barrierdata.h index

[PATCH 10/28] doxygen: Added Frame Buffer Device Driver Interface to Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/fb.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/include/rtems/fb.h b/cpukit/include/rtems/fb.h index 3ff0783e51..dd8c64333e 100644 --- a/cpukit/include/rtems/fb.h +++ b/cpukit/include/rtems/fb.h @@ -

[PATCH 26/28] doxygen: Added RTEMS Test Framework to API

From: Andreas Dachsberger Update #3706. --- cpukit/include/t.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/t.h b/cpukit/include/t.h index 10d9096be2..7ba37d3fdf 100644 --- a/cpukit/include/t.h +++ b/cpukit/include/t.h @@ -44,6 +44,8 @@ extern "C" { /** * @defgroup R

[PATCH 13/28] doxygen: Added some subgroups to API->Classic

From: Andreas Dachsberger Update #3706. I2C library, Media Manager and Profiling Support --- cpukit/include/rtems/libi2c.h| 2 ++ cpukit/include/rtems/media.h | 2 ++ cpukit/include/rtems/profiling.h | 2 ++ 3 files changed, 6 insertions(+) diff --git a/cpukit/include/rtems/libi2c.h b/

[PATCH 19/28] doxygen: Benchmark Timer Driver Interface now in Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 8 cpukit/include/rtems/btimer.h | 2 ++ 2 files changed, 10 insertions(+) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index 83ca90360a..fe847d986b 100644 --- a/cpukit/doxygen.h +++ b/cpukit/doxygen.h @@ -

[PATCH 23/28] doxygen: Zero and Null Device Drivers now in Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/devnull.h | 2 +- cpukit/include/rtems/devzero.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cpukit/include/rtems/devnull.h b/cpukit/include/rtems/devnull.h index 39081f478b..cb5d078d52 100644 --- a/cpuki

[PATCH 03/28] doxygen: Added further groups to RTEMSAPIClassic

From: Andreas Dachsberger Update #3706. Associativity Routines, BSD Compatibility Support now part of RTEMSAPIClassic --- cpukit/include/rtems/assoc.h | 4 +++- cpukit/include/rtems/bsd.h | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/cpukit/include/rtems/assoc.h b/cpuk

[PATCH 14/28] doxygen: Put C Library Support and POSIX in Internal

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/libcsupport.h| 2 ++ cpukit/include/rtems/posix/posixapi.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/cpukit/include/rtems/libcsupport.h b/cpukit/include/rtems/libcsupport.h index 51607f9ea1..41b0687c32 100644 ---

[PATCH 09/28] doxygen: Added some subgroups to IO Library

From: Andreas Dachsberger Update #3706. Types and Mount, IO Internal, Kernel Print Support --- cpukit/include/rtems/bspIo.h | 2 ++ cpukit/include/rtems/ftpfs.h | 2 ++ cpukit/include/rtems/libio_.h | 2 ++ 3 files changed, 6 insertions(+) diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/i

[PATCH 16/28] doxygen: Real Time Clock Time of Day API Definition in BSP->Shared

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/tod.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/include/rtems/tod.h b/cpukit/include/rtems/tod.h index 971e8548e8..238c4abebd 100644 --- a/cpukit/include/rtems/tod.h +++ b/cpukit/include/rtems/tod.h

[PATCH 20/28] doxygen: Time Test 27 now in Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h| 8 cpukit/include/rtems/tm27-default.h | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index fe847d986b..5f214fe5cd 100644 --- a/cpukit/doxygen

[PATCH 06/28] doxygen: Added subgroup Generic to BSP->SPARC64

From: Andreas Dachsberger Update #3706. --- bsps/sparc64/include/arch/mm/doxygen.h | 8 bsps/sparc64/include/boot/align.h | 2 +- bsps/sparc64/include/boot/gentypes.h | 2 +- bsps/sparc64/include/kernel/align.h| 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --

[PATCH 17/28] doxygen: Put Print Support in Classic API

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/print.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/rtems/print.h b/cpukit/include/rtems/print.h index 6c98b97f97..8907b71b28 100644 --- a/cpukit/include/rtems/print.h +++ b/cpukit/include/rtems/print.h @@

[PATCH 22/28] doxygen: Print Support now in API->IO

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 16 cpukit/include/rtems/bspIo.h | 2 +- cpukit/include/rtems/print.h | 2 +- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index 9beeb63614..d8a497

[PATCH 18/28] doxygen: Put Real-Timer Clock Driver Interface into group Device Drivers

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/rtc.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cpukit/include/rtems/rtc.h b/cpukit/include/rtems/rtc.h index 27b9e453c5..9f79fe67f6 100644 --- a/cpukit/include/rtems/rtc.h +++ b/cpukit/include/rtems/rtc.h @@ -26,6 +26,

[PATCH 01/28] doxygen: User Extensions Implementation group now in Internal->Classic

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/extensionimpl.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/include/rtems/extensionimpl.h b/cpukit/include/rtems/extensionimpl.h index 6ad4956b3a..12d0bb656f 100644 --- a/cpukit/include/rtems/extensi

[PATCH 00/28] Doxygen group changes

Andreas Dachsberger (28): doxygen: User Extensions Implementation group now in Internal->Classic doxygen: Added Mainpage to RTEMSAPIClassic doxygen: Added further groups to RTEMSAPIClassic doxygen: Added toplevel group for device drivers doxygen: Added libmisc group and libmisc mouse grou

[PATCH 07/28] doxygen: Added Management to Example CPU Architecture

From: Andreas Dachsberger Update #3706. --- cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h | 8 1 file changed, 8 insertions(+) diff --git a/cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h b/cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h index 8e96911a73..df37a789ac 100644 ---

[PATCH 04/28] doxygen: Added toplevel group for device drivers

From: Andreas Dachsberger Update #3706. --- cpukit/doxygen.h | 6 ++ cpukit/include/rtems/bdbuf.h | 5 - 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h index c0b2f8625e..d9d55a5cb0 100644 --- a/cpukit/doxygen.h +++ b/cpukit/

[PATCH 02/28] doxygen: Added Mainpage to RTEMSAPIClassic

From: Andreas Dachsberger Update #3706. --- cpukit/include/rtems/rtems/mainpage.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cpukit/include/rtems/rtems/mainpage.h b/cpukit/include/rtems/rtems/mainpage.h index ab9e442041..2209d56bd4 100644 --- a/cpukit/include/rtems/rtem

[PATCH] common: Support Sphinx 2.0.0

Without this chage there is no custom RTEMS title page with Sphinx 2.0.0. Maybe it is better to use the 'maketitle' option: https://www.sphinx-doc.org/en/master/latex.html --- common/rtemsstyle.sty | 1 + 1 file changed, 1 insertion(+) diff --git a/common/rtemsstyle.sty b/common/rtemsstyle.sty