[PATCH] common: Support Sphinx 2.0.0

[Sebastian Huber]

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
index 15f80b5..1f88bce 100644
--- a/common/rtemsstyle.sty
+++ b/common/rtemsstyle.sty
@@ -54,6 +54,7 @@ gobble=0,
   \if@openright\cleardoublepage\else\clearpage\fi
   \spx@tempa
 }
+\renewcommand{\sphinxmaketitle}{\maketitle}
 
 \fancypagestyle{normal}{
   \fancyhf{}
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/rtems/mainpage.h
+++ b/cpukit/include/rtems/rtems/mainpage.h
@@ -394,7 +394,7 @@
  */
 
 /**
- * @addtogroup ClassicAPI
+ * @addtogroup RTEMSAPIClassic
  *
  * The facilities provided by RTEMS are built upon a foundation of very
  * powerful concepts. These concepts must be understood before the application
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
--- a/cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h
+++ b/cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h
@@ -306,6 +306,14 @@ extern "C" {
 /** @{ **/
 /** @} */
 
+/**
+ * @defgroup Management Management
+ * 
+ * @ingroup RTEMSScoreCPUExample
+ * 
+ * @brief Management
+ */
+
 /**
  * @addtogroup Management
  * This defines the minimal set of integer and processor state registers
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

[PATCH 00/28] Doxygen group changes

[Sebastian Huber]

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 group
  doxygen: Added subgroup Generic to BSP->SPARC64
  doxygen: Added Management to Example CPU Architecture
  doxygen: Removed XXX group
  doxygen: Added some subgroups to IO Library
  doxygen: Added Frame Buffer Device Driver Interface to Device Drivers
  doxygen: Added Version to API->Classic
  doxygen: Added I2C Driver to Device Drivers
  doxygen: Added some subgroups to API->Classic
  doxygen: Put C Library Support and POSIX in Internal
  doxygen: Put SPI Driver into group Device Drivers
  doxygen: Real Time Clock Time of Day API Definition in BSP->Shared
  doxygen: Put Print Support in Classic API
  doxygen: Put Real-Timer Clock Driver Interface into group Device
Drivers
  doxygen: Benchmark Timer Driver Interface now in Device Drivers
  doxygen: Time Test 27 now in Device Drivers
  doxygen: Mouse now in Device Drivers
  doxygen: Print Support now in API->IO
  doxygen: Zero and Null Device Drivers now in Device Drivers
  doxygen: Added subclasses to API->Classic
  doxygen: Added inttypes.h to Print Support
  doxygen: Added RTEMS Test Framework to API
  doxygen: New API subgroup Tracing
  doxygen: Split up "libmisc" subgroups and removed libmisc

 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 +-
 cpukit/doxygen.h  | 55 +++
 cpukit/include/dev/i2c/i2c.h  |  2 +
 cpukit/include/dev/spi/spi.h  |  2 +
 cpukit/include/rtems/assoc.h  |  4 +-
 cpukit/include/rtems/bdbuf.h  |  5 ++-
 cpukit/include/rtems/bsd.h|  2 +
 cpukit/include/rtems/bspIo.h  |  2 +
 cpukit/include/rtems/bspcmdline.h |  7 +--
 cpukit/include/rtems/btimer.h |  2 +
 cpukit/include/rtems/capture.h|  2 +-
 cpukit/include/rtems/cpuuse.h |  7 ++-
 cpukit/include/rtems/devnull.h|  2 +-
 cpukit/include/rtems/devzero.h|  2 +-
 cpukit/include/rtems/dumpbuf.h|  2 +-
 cpukit/include/rtems/extensionimpl.h  |  2 +-
 cpukit/include/rtems/fb.h |  2 +-
 cpukit/include/rtems/ftpfs.h  |  2 +
 cpukit/include/rtems/inttypes.h   |  2 +
 cpukit/include/rtems/libcsupport.h|  2 +
 cpukit/include/rtems/libi2c.h |  2 +
 cpukit/include/rtems/libio_.h |  2 +
 cpukit/include/rtems/media.h  |  2 +
 cpukit/include/rtems/mw_uid.h |  7 ++-
 cpukit/include/rtems/posix/posixapi.h |  2 +
 cpukit/include/rtems/print.h  |  2 +
 cpukit/include/rtems/profiling.h  |  2 +
 cpukit/include/rtems/recorddata.h |  2 +
 cpukit/include/rtems/rtc.h|  2 +
 cpukit/include/rtems/rtems/barrierdata.h  |  2 +-
 cpukit/include/rtems/rtems/mainpage.h |  2 +-
 cpukit/include/rtems/rtl/rap.h|  2 +
 cpukit/include/rtems/rtl/rtl.h|  2 +
 cpukit/include/rtems/stackchk.h   |  7 ++-
 cpukit/include/rtems/status-checks.h  |  2 +
 cpukit/include/rtems/stringto.h   |  7 ++-
 cpukit/include/rtems/test.h   |  2 +
 cpukit/include/rtems/timecounter.h|  2 +
 cpukit/include/rtems/tm27-default.h   |  4 +-
 cpukit/include/rtems/tod.h|  2 +-
 cpukit/include/rtems/untar.h  |  2 +-
 cpukit/include/rtems/version.h|  4 +-
 cpukit/include/t.h|  2 +
 cpukit/sapi/src/version.c |  2 +-
 cpukit/score/cpu/no_cpu/include/rtems/score/cpu.h |  8 
 48 files changed, 156 insertions(+), 39 deletions(-)

-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/doxygen.h
@@ -18,6 +18,12 @@
  * @brief API
  */
 
+/**
+ * @defgroup RTEMSDeviceDrivers Device Drivers
+ * 
+ * @brief Device Drivers
+ */
+
 /**
  * @defgroup libfs libfs
  * 
diff --git a/cpukit/include/rtems/bdbuf.h b/cpukit/include/rtems/bdbuf.h
index 2794af7300..7963521f2a 100644
--- a/cpukit/include/rtems/bdbuf.h
+++ b/cpukit/include/rtems/bdbuf.h
@@ -2,6 +2,7 @@
  * @file
  *
  * @ingroup rtems_bdbuf
+ * 
  * @brief Block Device Buffer Management
  */
 
@@ -33,8 +34,10 @@ extern "C" {
 
 /**
  * @defgroup rtems_libblock Block Device Library
+ * 
+ * @ingroup RTEMSDeviceDrivers
  *
- * Block device modules.
+ * @brief Block device modules.
  */
 
 /**
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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..d8a49794ad 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -18,6 +18,22 @@
  * @brief API
  */
 
+/**
+ * @defgroup RTEMSAPIIO IO
+ * 
+ * @ingroup RTEMSAPI
+ *
+ * @brief IO
+ */
+
+/**
+ * @defgroup RTEMSAPIPrintSupport Print Support
+ * 
+ * @ingroup RTEMSAPIIO
+ *
+ * @brief Print Support
+ */
+
 /**
  * @defgroup RTEMSDeviceDrivers Device Drivers
  * 
diff --git a/cpukit/include/rtems/bspIo.h b/cpukit/include/rtems/bspIo.h
index 1bc68c02cc..75e500cd0a 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -29,7 +29,7 @@ extern "C" {
 /**
  * @defgroup BSPIO Kernel Print Support
  * 
- * @ingroup LibIO
+ * @ingroup RTEMSAPIPrintSupport
  *
  * This module contains all methods and support related to providing
  * kernel level print support.
diff --git a/cpukit/include/rtems/print.h b/cpukit/include/rtems/print.h
index 8907b71b28..ed73211b2c 100644
--- a/cpukit/include/rtems/print.h
+++ b/cpukit/include/rtems/print.h
@@ -31,7 +31,7 @@ typedef struct rtems_printer rtems_printer;
 /**
  * @defgroup RTEMSPrintSupport RTEMS Print Support
  * 
- * @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIPrintSupport
  *
  * This module contains all methods and support related to providing the user
  * with an interface to the kernel level print support.
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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,8 @@ extern "C" {
 
 /**
  * @defgroup rtems_rtc Real-Time Clock Driver Interface
+ * 
+ * @ingroup RTEMSDeviceDrivers
  *
  * This driver interface provides support to read and set the real-time clock
  * and to initialize the time of day for the system.
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/extensionimpl.h
+++ b/cpukit/include/rtems/extensionimpl.h
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @defgroup ClassicUserExtensionsImpl User Extensions Implementation
  *
- * @ingroup ClassicUserExtensions
+ * @ingroup RTEMSInternalClassic
  *
  * @{
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -28,7 +28,7 @@ extern "C" {
 /**
  *  @defgroup shared_tod RTC
  *
- *  @ingroup bsp_shared
+ *  @ingroup RTEMSBSPsShared
  *
  *  @brief Set the RTC
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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.h
+++ b/cpukit/doxygen.h
@@ -32,6 +32,14 @@
  * @brief Legacy Benchmark Drivers
  */
 
+/**
+ * @defgroup RTEMSTimeTest27Support Time Test 27 Support
+ * 
+ * @ingroup RTEMSDeviceDrivers
+ * 
+ * @brief Time Test 27 Support
+ */
+
 /**
  * @defgroup libfs libfs
  * 
diff --git a/cpukit/include/rtems/tm27-default.h 
b/cpukit/include/rtems/tm27-default.h
index 2a4a34384e..099f5a6805 100644
--- a/cpukit/include/rtems/tm27-default.h
+++ b/cpukit/include/rtems/tm27-default.h
@@ -20,9 +20,9 @@
 #define __tm27_h
 
 /**
- *  @defgroup shared_tm27 Time Test 27
+ *  @defgroup shared_tm27 Time Test 27 Default
  *
- *  @ingroup shared_include
+ *  @ingroup RTEMSTimeTest27Support
  *
  *  @brief Stuff for Time Test 27
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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 --git a/bsps/sparc64/include/arch/mm/doxygen.h 
b/bsps/sparc64/include/arch/mm/doxygen.h
index 5f34c85e12..cd5924c921 100644
--- a/bsps/sparc64/include/arch/mm/doxygen.h
+++ b/bsps/sparc64/include/arch/mm/doxygen.h
@@ -5,3 +5,11 @@
  * 
  * @brief MM
  */
+
+/**
+ * @defgroup RTEMSBSPsSPARC64Generic Generic
+ * 
+ * @ingroup RTEMSBSPsSPARC64
+ * 
+ * @brief Generic
+ */
diff --git a/bsps/sparc64/include/boot/align.h 
b/bsps/sparc64/include/boot/align.h
index 96229101ed..1f0f9562fd 100644
--- a/bsps/sparc64/include/boot/align.h
+++ b/bsps/sparc64/include/boot/align.h
@@ -26,7 +26,7 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** @addtogroup generic
+/** @addtogroup RTEMSBSPsSPARC64Generic
  * @{
  */
 /** @file
diff --git a/bsps/sparc64/include/boot/gentypes.h 
b/bsps/sparc64/include/boot/gentypes.h
index 57f3725baf..bf2fcda064 100644
--- a/bsps/sparc64/include/boot/gentypes.h
+++ b/bsps/sparc64/include/boot/gentypes.h
@@ -26,7 +26,7 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** @addtogroup generic
+/** @addtogroup RTEMSBSPsSPARC64Generic
  * @{
  */
 /** @file
diff --git a/bsps/sparc64/include/kernel/align.h 
b/bsps/sparc64/include/kernel/align.h
index 6003ea9c4e..e9b33ca222 100644
--- a/bsps/sparc64/include/kernel/align.h
+++ b/bsps/sparc64/include/kernel/align.h
@@ -26,7 +26,7 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** @addtogroup generic
+/** @addtogroup RTEMSBSPsSPARC64Generic
  * @ingroup others
  * @{
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -30,6 +30,8 @@ typedef struct rtems_printer rtems_printer;
 
 /**
  * @defgroup RTEMSPrintSupport RTEMS Print Support
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * This module contains all methods and support related to providing the user
  * with an interface to the kernel level print support.
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/cpukit/include/rtems/devnull.h
+++ b/cpukit/include/rtems/devnull.h
@@ -26,7 +26,7 @@
 /**
  *  @defgroup libmisc_devnull Null Device Driver
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSDeviceDrivers
  */
 /**@{*/
 
diff --git a/cpukit/include/rtems/devzero.h b/cpukit/include/rtems/devzero.h
index 7c282dc8b3..2c3f7a11a6 100644
--- a/cpukit/include/rtems/devzero.h
+++ b/cpukit/include/rtems/devzero.h
@@ -29,7 +29,7 @@
 /**
  *  @defgroup libmisc_devzero Zero Device Driver
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSDeviceDrivers
  */
 /**@{*/
 
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/cpukit/include/rtems/assoc.h
index 97e50013d7..9dc068181b 100644
--- a/cpukit/include/rtems/assoc.h
+++ b/cpukit/include/rtems/assoc.h
@@ -12,7 +12,9 @@
 #define _RTEMS_RTEMS_ASSOC_H
 
 /**
- *  @defgroup Associativity Associativity Routines
+ * @defgroup Associativity Associativity Routines
+ * 
+ * @ingroup RTEMSAPIClassic
  */
 /**@{*/
 
diff --git a/cpukit/include/rtems/bsd.h b/cpukit/include/rtems/bsd.h
index 0c44e3787d..896133f8af 100644
--- a/cpukit/include/rtems/bsd.h
+++ b/cpukit/include/rtems/bsd.h
@@ -32,6 +32,8 @@ extern "C" {
 
 /**
  * @defgroup BSD BSD Compatibility Support
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @{
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
--- a/cpukit/include/rtems/libcsupport.h
+++ b/cpukit/include/rtems/libcsupport.h
@@ -31,6 +31,8 @@ extern "C" {
 
 /**
  * @defgroup libcsupport Standard C Library Support
+ * 
+ * @ingroup RTEMSInternal
  *
  * @brief RTEMS Specific Support for the Standard C Library
  *
diff --git a/cpukit/include/rtems/posix/posixapi.h 
b/cpukit/include/rtems/posix/posixapi.h
index 8c1eb8112b..b7f18c8a60 100644
--- a/cpukit/include/rtems/posix/posixapi.h
+++ b/cpukit/include/rtems/posix/posixapi.h
@@ -29,6 +29,8 @@
 
 /**
  * @defgroup POSIXAPI RTEMS POSIX API
+ * 
+ * @ingroup RTEMSInternal
  *
  * RTEMS POSIX API definitions and modules.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/include/rtems/bspIo.h
index 61eb873188..1bc68c02cc 100644
--- a/cpukit/include/rtems/bspIo.h
+++ b/cpukit/include/rtems/bspIo.h
@@ -28,6 +28,8 @@ extern "C" {
 
 /**
  * @defgroup BSPIO Kernel Print Support
+ * 
+ * @ingroup LibIO
  *
  * This module contains all methods and support related to providing
  * kernel level print support.
diff --git a/cpukit/include/rtems/ftpfs.h b/cpukit/include/rtems/ftpfs.h
index c1f615b85b..e07d6ae958 100644
--- a/cpukit/include/rtems/ftpfs.h
+++ b/cpukit/include/rtems/ftpfs.h
@@ -43,6 +43,8 @@ extern "C" {
 
 /**
  * @defgroup rtems_ftpfs File Transfer Protocol File System
+ * 
+ * @ingroup FileSystemTypesAndMount
  *
  * @brief The FTP file system (FTP client) can be used to transfer files from
  * or to remote hosts.
diff --git a/cpukit/include/rtems/libio_.h b/cpukit/include/rtems/libio_.h
index 414e8a20fc..78cb54a9ec 100644
--- a/cpukit/include/rtems/libio_.h
+++ b/cpukit/include/rtems/libio_.h
@@ -37,6 +37,8 @@ extern "C" {
 
 /**
  * @defgroup LibIOInternal IO Internal Library
+ * 
+ * @ingroup LibIO
  *
  * @brief Internal IO library API and implementation.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/cpukit/include/rtems/libi2c.h
index 341e390760..1d0dfd4d7b 100644
--- a/cpukit/include/rtems/libi2c.h
+++ b/cpukit/include/rtems/libi2c.h
@@ -64,6 +64,8 @@ extern "C" {
 
 /**
  * @defgroup libi2c I2C Library
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @brief I2C library.
  *
diff --git a/cpukit/include/rtems/media.h b/cpukit/include/rtems/media.h
index 0fbc564482..b9fb2d3d5c 100644
--- a/cpukit/include/rtems/media.h
+++ b/cpukit/include/rtems/media.h
@@ -32,6 +32,8 @@ extern "C" {
 
 /**
  * @defgroup RTEMSMedia Media Manager
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Removable media support.
  *
diff --git a/cpukit/include/rtems/profiling.h b/cpukit/include/rtems/profiling.h
index 9e434b2a3c..d0314ae44b 100644
--- a/cpukit/include/rtems/profiling.h
+++ b/cpukit/include/rtems/profiling.h
@@ -33,6 +33,8 @@ extern "C" {
 
 /**
  * @defgroup Profiling Profiling Support
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @brief The profiling support offers functions to report profiling
  * information available in the system.
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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_mouse Serial Mouse
  * 
- * @ingroup libmisc
+ * @ingroup RTEMSDeviceDrivers
  * 
  * @brief Serial Mouse
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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(-)

diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index d9d55a5cb0..83ca90360a 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -39,3 +39,20 @@
  * 
  * @brief nfs Client
  */
+
+/**
+ * @defgroup libmisc libmisc
+ * 
+ * @ingroup TODO
+ * 
+ * @brief libmisc
+ */
+
+/**
+ * @defgroup libmisc_mouse Serial Mouse
+ * 
+ * @ingroup libmisc
+ * 
+ * @brief Serial Mouse
+ */
+
diff --git a/cpukit/include/rtems/bspcmdline.h 
b/cpukit/include/rtems/bspcmdline.h
index 058363295b..04b1a45640 100644
--- a/cpukit/include/rtems/bspcmdline.h
+++ b/cpukit/include/rtems/bspcmdline.h
@@ -1,9 +1,6 @@
 /**
  * @file
  *
- * @defgroup BSPCommandLine BSP Command Line Helpers
- *
- * @ingroup libmisc
  * @brief BSP Command Line Handler
  *
  * This include file contains all prototypes and specifications
@@ -27,6 +24,8 @@
 
 /**
  * @defgroup BSPCommandLine BSP Command Line Helpers
+ * 
+ * @ingroup libmisc
  *
  * The BSP Command Line Handler provides a set of routines which assist
  * in examining and decoding the Command Line String passed to the BSP
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -24,6 +24,14 @@
  * @brief Device Drivers
  */
 
+/**
+ * @defgroup RTEMSLegacyBenchmarkDrivers Legacy Benchmark Drivers
+ * 
+ * @ingroup RTEMSDeviceDrivers
+ * 
+ * @brief Legacy Benchmark Drivers
+ */
+
 /**
  * @defgroup libfs libfs
  * 
diff --git a/cpukit/include/rtems/btimer.h b/cpukit/include/rtems/btimer.h
index ad9c629eba..43f910011d 100644
--- a/cpukit/include/rtems/btimer.h
+++ b/cpukit/include/rtems/btimer.h
@@ -35,6 +35,8 @@ extern "C" {
 
 /**
  * @defgroup BenchmarkTimer Benchmark Timer Driver Interface
+ * 
+ * @ingroup RTEMSLegacyBenchmarkDrivers
  *
  * This module defines the interface for the Benchmark Timer Driver.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

[PATCH 08/28] doxygen: Removed XXX group

[Sebastian Huber]

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 1598bbf6db..baf6b1468f 100644
--- a/cpukit/include/rtems/rtems/barrierdata.h
+++ b/cpukit/include/rtems/rtems/barrierdata.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
- * @addtogroup XXX
+ * @addtogroup ClassicBarrierImpl
  *
  * @{
  */
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -18,7 +18,7 @@
 /**
  * @defgroup libmisc_fb Frame Buffer Device Driver Interface
  *
- * @ingroup Device Drivers and Frameworks
+ * @ingroup RTEMSDeviceDrivers
  */
 /**@{*/
 
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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 RTEMSTestFramework RTEMS Test Framework
+ * 
+ * @ingroup RTEMSAPI
  *
  * @brief The RTEMS Test Framework helps you to write tests.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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..658c1c1dcd 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -34,6 +34,14 @@
  * @brief Print Support
  */
 
+/**
+ * @defgroup RTEMSAPITracing Tracing
+ * 
+ * @ingroup RTEMSAPI
+ *
+ * @brief Tracing
+ */
+
 /**
  * @defgroup RTEMSDeviceDrivers Device Drivers
  * 
diff --git a/cpukit/include/rtems/capture.h b/cpukit/include/rtems/capture.h
index a0b862bca1..7a313b3b8b 100644
--- a/cpukit/include/rtems/capture.h
+++ b/cpukit/include/rtems/capture.h
@@ -41,7 +41,7 @@
 /**
  *  @defgroup libmisc_capture RTEMS Capture Engine
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPITracing
  *
  *  Capture Engine Component of the RTEMS Measurement and Monitoring System
  */
diff --git a/cpukit/include/rtems/recorddata.h 
b/cpukit/include/rtems/recorddata.h
index c736fcbe2f..7ca0ff8e4f 100644
--- a/cpukit/include/rtems/recorddata.h
+++ b/cpukit/include/rtems/recorddata.h
@@ -42,7 +42,7 @@ extern "C" {
 /**
  * @defgroup RTEMSRecord Event Recording
  * 
- * @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPITracing
  *
  * @brief Low-level event recording support.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -47,6 +47,8 @@ typedef struct i2c_rdwr_ioctl_data i2c_rdwr_ioctl_data;
 
 /**
  * @defgroup I2C Inter-Integrated Circuit (I2C) Driver
+ * 
+ * @ingroup RTEMSDeviceDrivers
  *
  * @brief Inter-Integrated Circuit (I2C) bus and device driver support.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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  | 2 ++
 4 files changed, 8 insertions(+)

diff --git a/cpukit/include/rtems/rtl/rap.h b/cpukit/include/rtems/rtl/rap.h
index 03cf096cb0..ac089e3a7b 100644
--- a/cpukit/include/rtems/rtl/rap.h
+++ b/cpukit/include/rtems/rtl/rap.h
@@ -27,6 +27,8 @@ extern "C" {
 
 /**
  * @defgroup rtems_rap RTEMS Application Loader
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * The module implements an application loader for files in the RAP format. The
  * RAP format is:
diff --git a/cpukit/include/rtems/rtl/rtl.h b/cpukit/include/rtems/rtl/rtl.h
index 044aa2a332..c86202bb0c 100644
--- a/cpukit/include/rtems/rtl/rtl.h
+++ b/cpukit/include/rtems/rtl/rtl.h
@@ -38,6 +38,8 @@ extern "C" {
 
 /**
  * @defgroup rtems_rtl RTEMS Runtime Link Editor
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * The module implements a runtime link editor with the standard dlopen, and
  * dlclose family of functions.
diff --git a/cpukit/include/rtems/status-checks.h 
b/cpukit/include/rtems/status-checks.h
index 94f30209c1..ab90a47d9f 100644
--- a/cpukit/include/rtems/status-checks.h
+++ b/cpukit/include/rtems/status-checks.h
@@ -31,6 +31,8 @@ extern "C" {
 
 /**
  * @defgroup rtems_status_checks Status Checks
+ * 
+ * @ingroup RTEMSAPIClassic
  */
 /**@{**/
 
diff --git a/cpukit/include/rtems/test.h b/cpukit/include/rtems/test.h
index fbe8acf909..4b15f3bc42 100644
--- a/cpukit/include/rtems/test.h
+++ b/cpukit/include/rtems/test.h
@@ -26,6 +26,8 @@ extern "C" {
 
 /**
  * @defgroup RTEMSTest Test Support
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Test support functions.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/rtems/recorddata.h 
b/cpukit/include/rtems/recorddata.h
index f7de5229df..c736fcbe2f 100644
--- a/cpukit/include/rtems/recorddata.h
+++ b/cpukit/include/rtems/recorddata.h
@@ -41,6 +41,8 @@ extern "C" {
 
 /**
  * @defgroup RTEMSRecord Event Recording
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @brief Low-level event recording support.
  *
diff --git a/cpukit/include/rtems/timecounter.h 
b/cpukit/include/rtems/timecounter.h
index 8d1bd78618..dd4300166c 100644
--- a/cpukit/include/rtems/timecounter.h
+++ b/cpukit/include/rtems/timecounter.h
@@ -32,6 +32,8 @@ extern "C" {
 
 /**
  * @defgroup SAPITimecounter Timecounter Support
+ * 
+ * @ingroup RTEMSAPIClassic
  *
  * @{
  */
diff --git a/cpukit/include/rtems/version.h b/cpukit/include/rtems/version.h
index 9bee2e8d10..d8c1206d91 100644
--- a/cpukit/include/rtems/version.h
+++ b/cpukit/include/rtems/version.h
@@ -21,9 +21,9 @@ extern "C" {
 #endif
 
 /**
- * @defgroup ClassicVersion Version
+ * @defgroup RTEMSAPIClassicVersion Version
  *
- * @ingroup ClassicVersion
+ * @ingroup RTEMSAPIClassic
  *
  * @brief The Version API provides functions to return the version or parts of
  * the version of RTEMS you are using.
diff --git a/cpukit/sapi/src/version.c b/cpukit/sapi/src/version.c
index d240b1b0df..e1e7705863 100644
--- a/cpukit/sapi/src/version.c
+++ b/cpukit/sapi/src/version.c
@@ -8,7 +8,7 @@
  * updated if it has changed. The key may indicate there are local
  * modification.
  *
- * @ingroup ClassicVersion
+ * @ingroup RTEMSAPIClassicVersion
  */
 
 /*
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/stackchk.h   | 7 +++
 cpukit/include/rtems/stringto.h   | 7 +++
 cpukit/include/rtems/untar.h  | 2 +-
 8 files changed, 17 insertions(+), 27 deletions(-)

diff --git a/cpukit/doxygen.h b/cpukit/doxygen.h
index 658c1c1dcd..ece21ef03d 100644
--- a/cpukit/doxygen.h
+++ b/cpukit/doxygen.h
@@ -80,14 +80,6 @@
  * @brief nfs Client
  */
 
-/**
- * @defgroup libmisc libmisc
- * 
- * @ingroup TODO
- * 
- * @brief libmisc
- */
-
 /**
  * @defgroup libmisc_mouse Serial Mouse
  * 
diff --git a/cpukit/include/rtems/bspcmdline.h 
b/cpukit/include/rtems/bspcmdline.h
index 04b1a45640..04ad3d7ef2 100644
--- a/cpukit/include/rtems/bspcmdline.h
+++ b/cpukit/include/rtems/bspcmdline.h
@@ -1,5 +1,7 @@
 /**
  * @file
+ * 
+ * @ingroup BSPCommandLine
  *
  * @brief BSP Command Line Handler
  *
@@ -25,7 +27,7 @@
 /**
  * @defgroup BSPCommandLine BSP Command Line Helpers
  * 
- * @ingroup libmisc
+ * @ingroup RTEMSAPIClassic
  *
  * The BSP Command Line Handler provides a set of routines which assist
  * in examining and decoding the Command Line String passed to the BSP
diff --git a/cpukit/include/rtems/cpuuse.h b/cpukit/include/rtems/cpuuse.h
index 325ef0def3..a825005356 100644
--- a/cpukit/include/rtems/cpuuse.h
+++ b/cpukit/include/rtems/cpuuse.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_cpuuse CPU Usage
- *
- * @ingroup libmisc
+ * @ingroup libmisc_cpuuse
+ * 
  * @brief CPU Usage Report
  *
  * This include file contains information necessary to utilize
@@ -28,7 +27,7 @@
 /**
  *  @defgroup libmisc_cpuuse CPU Usage
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/dumpbuf.h b/cpukit/include/rtems/dumpbuf.h
index d714879ab4..690ac63341 100644
--- a/cpukit/include/rtems/dumpbuf.h
+++ b/cpukit/include/rtems/dumpbuf.h
@@ -22,7 +22,7 @@
 /**
  *  @defgroup libmisc_dumpbuf Print Memory Buffer
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIPrintSupport
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/mw_uid.h b/cpukit/include/rtems/mw_uid.h
index 494254..e90ef695a9 100644
--- a/cpukit/include/rtems/mw_uid.h
+++ b/cpukit/include/rtems/mw_uid.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_fb_mw Input Devices for MicroWindows
- *
- * @ingroup libmisc
+ * @ingroup libmisc_fb_mw
+ * 
  * @brief Input Devices for MicroWindows
  *
  * This file defines the interface for input devices used by MicroWindows
@@ -23,7 +22,7 @@
 /**
  *  @defgroup libmisc_fb_mw Input Devices for MicroWindows
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSDeviceDrivers
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/stackchk.h b/cpukit/include/rtems/stackchk.h
index 22f2730481..700e557337 100644
--- a/cpukit/include/rtems/stackchk.h
+++ b/cpukit/include/rtems/stackchk.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_stackchk Stack Checker Mechanism
- *
- * @ingroup libmisc
+ * @ingroup libmisc_stackchk
+ * 
  * @brief Stack Checker Information
  *
  * This include file contains information necessary to utilize
@@ -30,7 +29,7 @@
 /**
  *  @defgroup libmisc_stackchk Stack Checker Mechanism
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 #ifdef __cplusplus
diff --git a/cpukit/include/rtems/stringto.h b/cpukit/include/rtems/stringto.h
index 53e8147c81..7a220ea6b3 100644
--- a/cpukit/include/rtems/stringto.h
+++ b/cpukit/include/rtems/stringto.h
@@ -1,9 +1,8 @@
 /**
  * @file
  *
- * @defgroup libmisc_conv_help Conversion Helpers
- *
- * @ingroup libmisc
+ * @ingroup libmisc_conv_help
+ * 
  * @brief Convert String to Pointer (with validation)
  *
  * This file defines the interface to a set of string conversion helpers.
@@ -23,7 +22,7 @@
 /**
  *  @defgroup libmisc_conv_help Conversion Helpers
  *
- *  @ingroup libmisc
+ *  @ingroup RTEMSAPIClassic
  */
 /**@{*/
 
diff --git a/cpukit/include/rtems/untar.h b/cpukit/include/rtems/untar.h
index bc0a97c103..ba99eb04b9 100644
--- a/cpukit/include/rtems/untar.h
+++ b/cpukit/include/rtems/untar.h
@@ -28,7 +28,7 @@
 /**
  *  @defgroup libmisc_untar_img Untar Image
  *
- *  @ingroup libmisc
+ *  @ingroup LibIO
  */
 /**@{*/
 #ifdef __cplusplus
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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/inttypes.h
@@ -29,6 +29,8 @@ extern "C" {
 
 /**
  * @defgroup RTEMS inttypes.h Extensions
+ * 
+ * @ingroup RTEMSAPIPrintSupport
  *
  * This module defines portable PRIxxx constants beyond those
  * in the C and POSIX standard.
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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
@@ -39,6 +39,8 @@ typedef struct spi_bus spi_bus;
 
 /**
  * @defgroup SPI Serial Peripheral Interface (SPI) Driver
+ * 
+ * @ingroup RTEMSDeviceDrivers
  *
  * @brief Serial Peripheral Interface (SPI) bus driver support.
  *
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Doxygen Guidelines: @brief for @file?

[Sebastian Huber]

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 be redundant (the group should have an @brief and a detailed 
description). This is my proposal for the @file blocks:


Files
-

Place an ``@file`` block at the top of each file.  The ``@file`` block 
should

precede the license header.  This placement reduces the chance of merge
conflicts in imported third-party code.  The ``@file`` block shall be 
put into

a group with ``@ingroup``.  The ``@file`` block shall not have additional
content, e.g. a ``@brief`` description.

.. code:: c

    /**
 * @file
 *
 * @brief RTEMSScoreThread
 */

--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: [PATCH] common: Support Sphinx 2.0.0

[Chris Johns]

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 the sphinx community on solving the
issue we had.

> 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.sty
> @@ -54,6 +54,7 @@ gobble=0,
>\if@openright\cleardoublepage\else\clearpage\fi
>\spx@tempa
>  }
> +\renewcommand{\sphinxmaketitle}{\maketitle}
>  
>  \fancypagestyle{normal}{
>\fancyhf{}
> 

Does this work with older versions?

Chris
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Chris Johns]

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-options
> 

Nice. I should have looked.

Chris


___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: [PATCH] common: Support Sphinx 2.0.0

[Sebastian Huber]

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.sty
@@ -54,6 +54,7 @@ gobble=0,
\if@openright\cleardoublepage\else\clearpage\fi
\spx@tempa
  }
+\renewcommand{\sphinxmaketitle}{\maketitle}
  
  \fancypagestyle{normal}{

\fancyhf{}


Does this work with older versions?


I didn't test with older versions.

--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Peter Dufault]

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 limited 
way.  See below.

There is continuing work to add SPE to LLVM/Clang.  I don’t follow it closely 
but see activity in January and February.  I found the following comment this 
AM (https://github.com/crosstool-ng/crosstool-ng/issues/1152, and not that I 
know what Rust is):

"Just as a heads-up: There have been many improvements in LLVM regarding 
PowerPCSPE thanks to the work of Justin Hibbits. LLVM works so well now that 
even Rust can be used on PowerPCSPE.”

I don’t know how the work will progress or how ready RTEMS is for LLVM/Clang.

I’m directly using the SPE via downloaded and assembled assembly language 
libraries (MPC5500_libdsp2_v06, MPC5500_spe_linear_algebra_v1_8).  However, 
falling back to proper context saving and soft-float to track new versions of 
GCC would be a major change in timing and a can of worms.

I expect RTEMS with SPE-PowerPC will be stuck at GCC 8 and RTEMS version-locked 
as well.

It’s too bad there is no compiler support from NXP because the ETPU approach 
(extended Time Processing Unit, special simple processors with canned routines 
that can be downloaded) that are on the chips worked well for custom motor 
control, more valuable than the SPE.  ETPU appears to be ending it’s life 
anyway with a replacement from some Bosch peripheral.  I’ll be recommending EOL 
for PowerPC/SPE and will be looking for a different approach.

> On Apr 2, 2019, at 10:06 , Joel Sherrill  wrote:
> 
> Hi
> 
> We knew this was coming. My recollection is that we have a single BSP this 
> would impact. But that has already been impacted by SPU being split into a 
> separate gcc target post GCC 7. And that has not been addressed yet anyway.
> 
> What's the plan for SPU? 
> 
> -- Forwarded message -
> From: Ulrich Weigand 
> Date: Tue, Apr 2, 2019 at 4:46 AM
> Subject: [RFC/RFA] Obsolete Cell Broadband Engine SPU targets
> To: , 
> Cc: , 
> 
> 
> Hello,
> 
> the spu-elf target in GCC supports generating code for the SPU processors
> of the Cell Broadband Engine; it has been part of upstream GCC since 2008.
> 
> However, at this point I believe this target is no longer in use:
> - There is no supported Cell/B.E. hardware any more.
> - There is no supported operating system supporting Cell/B.E. any more.
> 
> I've still been running daily regression tests until now, but I'll be
> unable to continue to do so much longer since the systems I've been
> using for this will go away.
> 
> Rather than leave SPU support untested/maintained, I'd therefore
> propose to declare all SPU targets obsolete in GCC 9 and remove
> the code with GCC 10.
> 
> Any objections to this approach?
> 
> Bye,
> Ulrich
> 
> 
> gcc/ChangeLog:
> 
> * config.gcc: Mark spu* targets as deprecated/obsolete.
> 
> Index: gcc/config.gcc
> ===
> --- gcc/config.gcc  (revision 270076)
> +++ gcc/config.gcc  (working copy)
> @@ -248,6 +248,7 @@ md_file=
>  # Obsolete configurations.
>  case ${target} in
>*-*-solaris2.10* \
> +  | spu*-*-*   \
>| tile*-*-*  \
>   )
>  if test "x$enable_obsolete" != xyes; then
> -- 
>   Dr. Ulrich Weigand
>   GNU/Linux compilers and toolchain
>   ulrich.weig...@de.ibm.com
> 
> ___
> devel mailing list
> devel@rtems.org
> http://lists.rtems.org/mailman/listinfo/devel

Peter
-
Peter Dufault
HD Associates, Inc.  Software and System Engineering

This email is delivered through the public internet using protocols subject to 
interception and tampering.

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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 support can then bit rot a while. In general, the 
embedded PowerPC is dead after the NXP take over.


--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

[PATCH] doxygen: rtems: Rework doxygen comment

[Sebastian Huber]

---
 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/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -104,19 +104,27 @@ rtems_status_code rtems_message_queue_delete(
 );
 
 /**
- *  @brief rtems_message_queue_send
- *
- *  Message Queue Manager - rtems_message_queue_send
- *
- *  This routine implements the rtems_message_queue_send directive.
- *  This directive sends the message buffer to the message queue
- *  indicated by ID.  If one or more tasks is blocked waiting
- *  to receive a message from this message queue, then one will
- *  receive the message.  The task selected to receive the
- *  message is based on the task queue discipline algorithm in
- *  use by this particular message queue.  If no tasks are waiting,
- *  then the message buffer will be placed at the REAR of the
- *  chain of pending messages for this message queue.
+ * @brief Sends a message to the message queue.
+ *
+ * This directive sends the message buffer to the message queue indicated by
+ * ID.  If one or more tasks is blocked waiting to receive a message from this
+ * message queue, then one will receive the message.  The task selected to
+ * receive the message is based on the task queue discipline algorithm in use
+ * by this particular message queue.  If no tasks are waiting, then the message
+ * buffer will be placed at the rear of the chain of pending messages for this
+ * message queue.
+ *
+ * @param id The message queue ID.
+ * @param buffer The message content buffer.
+ * @param size The size of the message.
+ *
+ * @retval RTEMS_SUCCESSFUL Successful operation.
+ * @retval RTEMS_INVALID_ID Invalid message queue ID.
+ * @retval RTEMS_INVALID_ADDRESS The message buffer pointer is @c NULL.
+ * @retval RTEMS_INVALID_SIZE The message size is larger than the maximum
+ *   message size of the message queue.
+ * @retval RTEMS_TOO_MANY The new message would exceed the message queue limit
+ *   for pending messages.
  */
 rtems_status_code rtems_message_queue_send(
   rtems_idid,
@@ -169,25 +177,27 @@ rtems_status_code rtems_message_queue_broadcast(
 );
 
 /**
- * @brief RTEMS Message Queue Receive
- *
- * This routine implements the rtems_message_queue_receive directive.
- * This directive is invoked when the calling task wishes to receive
- * a message from the message queue indicated by ID. The received
- * message is to be placed in buffer. If no messages are outstanding
- * and the option_set indicates that the task is willing to block,
- * then the task will be blocked until a message arrives or until,
- * optionally, timeout clock ticks have passed.
- *
- * @param[in] id is the queue id
- * @param[in] buffer is the pointer to message buffer
- * @param[in] size is the size of message receive
- * @param[in] option_set is the options on receive
- * @param[in] timeout is the number of ticks to wait
- *
- * @retval This method returns RTEMS_SUCCESSFUL if there was not an
- * error. Otherwise, a status code is returned indicating the
- * source of the error.
+ * @brief Receives a message from the message queue
+ *
+ * This directive is invoked when the calling task wishes to receive a message
+ * from the message queue indicated by ID. The received message is to be placed
+ * in the buffer. If no messages are outstanding and the option set indicates
+ * that the task is willing to block, then the task will be blocked until a
+ * message arrives or until, optionally, timeout clock ticks have passed.
+ *
+ * @param id The message queue ID.
+ * @param[out] buffer The buffer for the message content.  The buffer must be
+ *   large enough to store maximum size messages of this message queue.
+ * @param[out] size The size of the message.
+ * @param option_set The option set, e.g. RTEMS_NO_WAIT or RTEMS_WAIT.
+ * @param timeout The number of ticks to wait if the RTEMS_WAIT is set.  Use
+ *   RTEMS_NO_TIMEOUT to wait indefinitely.
+ *
+ * @retval RTEMS_SUCCESSFUL Successful operation.
+ * @retval RTEMS_INVALID_ID Invalid message queue ID.
+ * @retval RTEMS_INVALID_ADDRESS The message buffer pointer or the message size
+ *   pointer is @c NULL.
+ * @retval RTEMS_TIMEOUT A timeout occurred and no message was received.
  */
 rtems_status_code rtems_message_queue_receive(
   rtems_idid,
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

[PATCH v2] doxygen: Rework some Doxygen comments

[Sebastian Huber]

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 insertions(+), 44 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/message.h
+++ b/cpukit/include/rtems/rtems/message.h
@@ -104,19 +104,27 @@ rtems_status_code rtems_message_queue_delete(
 );
 
 /**
- *  @brief rtems_message_queue_send
- *
- *  Message Queue Manager - rtems_message_queue_send
- *
- *  This routine implements the rtems_message_queue_send directive.
- *  This directive sends the message buffer to the message queue
- *  indicated by ID.  If one or more tasks is blocked waiting
- *  to receive a message from this message queue, then one will
- *  receive the message.  The task selected to receive the
- *  message is based on the task queue discipline algorithm in
- *  use by this particular message queue.  If no tasks are waiting,
- *  then the message buffer will be placed at the REAR of the
- *  chain of pending messages for this message queue.
+ * @brief Sends a message to the message queue.
+ *
+ * This directive sends the message buffer to the message queue indicated by
+ * ID.  If one or more tasks is blocked waiting to receive a message from this
+ * message queue, then one will receive the message.  The task selected to
+ * receive the message is based on the task queue discipline algorithm in use
+ * by this particular message queue.  If no tasks are waiting, then the message
+ * buffer will be placed at the rear of the chain of pending messages for this
+ * message queue.
+ *
+ * @param id The message queue ID.
+ * @param buffer The message content buffer.
+ * @param size The size of the message.
+ *
+ * @retval RTEMS_SUCCESSFUL Successful operation.
+ * @retval RTEMS_INVALID_ID Invalid message queue ID.
+ * @retval RTEMS_INVALID_ADDRESS The message buffer pointer is @c NULL.
+ * @retval RTEMS_INVALID_SIZE The message size is larger than the maximum
+ *   message size of the message queue.
+ * @retval RTEMS_TOO_MANY The new message would exceed the message queue limit
+ *   for pending messages.
  */
 rtems_status_code rtems_message_queue_send(
   rtems_idid,
@@ -169,25 +177,27 @@ rtems_status_code rtems_message_queue_broadcast(
 );
 
 /**
- * @brief RTEMS Message Queue Receive
- *
- * This routine implements the rtems_message_queue_receive directive.
- * This directive is invoked when the calling task wishes to receive
- * a message from the message queue indicated by ID. The received
- * message is to be placed in buffer. If no messages are outstanding
- * and the option_set indicates that the task is willing to block,
- * then the task will be blocked until a message arrives or until,
- * optionally, timeout clock ticks have passed.
- *
- * @param[in] id is the queue id
- * @param[in] buffer is the pointer to message buffer
- * @param[in] size is the size of message receive
- * @param[in] option_set is the options on receive
- * @param[in] timeout is the number of ticks to wait
- *
- * @retval This method returns RTEMS_SUCCESSFUL if there was not an
- * error. Otherwise, a status code is returned indicating the
- * source of the error.
+ * @brief Receives a message from the message queue
+ *
+ * This directive is invoked when the calling task wishes to receive a message
+ * from the message queue indicated by ID. The received message is to be placed
+ * in the buffer. If no messages are outstanding and the option set indicates
+ * that the task is willing to block, then the task will be blocked until a
+ * message arrives or until, optionally, timeout clock ticks have passed.
+ *
+ * @param id The message queue ID.
+ * @param[out] buffer The buffer for the message content.  The buffer must be
+ *   large enough to store maximum size messages of this message queue.
+ * @param[out] size The size of the message.
+ * @param option_set The option set, e.g. RTEMS_NO_WAIT or RTEMS_WAIT.
+ * @param timeout The number of ticks to wait if the RTEMS_WAIT is set.  Use
+ *   RTEMS_NO_TIMEOUT to wait indefinitely.
+ *
+ * @retval RTEMS_SUCCESSFUL Successful operation.
+ * @retval RTEMS_INVALID_ID Invalid message queue ID.
+ * @retval RTEMS_INVALID_ADDRESS The message buffer pointer or the message size
+ *   pointer is @c NULL.
+ * @retval RTEMS_TIMEOUT A timeout occurred and no message was received.
  */
 rtems_status_code rtems_message_queue_receive(
   rtems_idid,
diff --git a/cpukit/include/rtems/score/rbtree.h 
b/cpukit/include/rtems/score/rbtree.h
index 51f9125dda..c01a893b6e 100644
--- a/cpukit/include/rtems/score/rbtree.h
+++ b/cpukit/include/rtems/score/rbtree.h
@@ -106,8 +106,8 @@ RTEMS_INLINE_ROUTINE bool _RBTree_Is_node_off_tree(
 /**
  * @brief Reb

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

[Sebastian Huber]

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-doxygen-bsp.rst b/bsp-howto/coding-doxygen-bsp.rst
similarity index 100%
rename from eng/coding-doxygen-bsp.rst
rename to bsp-howto/coding-doxygen-bsp.rst
diff --git a/bsp-howto/index.rst b/bsp-howto/index.rst
index 4795e08..67f64d8 100644
--- a/bsp-howto/index.rst
+++ b/bsp-howto/index.rst
@@ -40,3 +40,4 @@ RTEMS BSP and Driver Guide (|version|).
ata
ide_controller
command
+   coding-doxygen-bsp
diff --git a/eng/coding.rst b/eng/coding.rst
index 907fed1..decadea 100644
--- a/eng/coding.rst
+++ b/eng/coding.rst
@@ -14,7 +14,6 @@ TBD  - Write introduction, re-order, identify missing content
 coding-conventions
 coding-80cols
 coding-deprecating
-coding-doxygen-bsp
 coding-doxygen
 coding-file-hdr
 coding-gen-patch
-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

[PATCH 2/2] eng: Rework Doxygen guidelines

[Sebastian Huber]

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.rst
@@ -1,481 +1,239 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
-.. Copyright (C) 2018.
-.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
+.. Copyright (C) 2019 embedded brains GmbH
 
-General Doxygen Recommentations
-===
+Doxygen Guidelines
+==
 
-.. COMMENT: TBD - Convert the following to Rest and insert into this file
-.. COMMENT: TBD - https://devel.rtems.org/wiki/Developer/Coding/Doxygen
-
-.. sidebar:: *History*
+Group Names
+---
 
-  RTEMS is much older than Doxygen (http://www.doxygen.org/) and
-  the documentation in the .h files was obviously not written with
-  Doxygen markup in mind. In 2007, Joel Sherrill undertook to convert the
-  documentation in the .h and .inl files in the RTEMS SuperCore? to Doxygen
-  format. As a result of this effort, the Doxygen for the development
-  version of the RTEMS is now built automatically periodically and made
-  available on the RTEMS Website. In April 2008, Joel Sherrill began to
-  update the Classic API (e.g. cpukit/rtems) .h files to include Doxygen
-  markup. Now, RTEMS has nice Doxygen markup including state and sequence
-  diagrams.
-
-Doxygen Best Practices
---
-
-* Do not use ``@a``. Instead use ``@param`` to document function parameters.
-* Do not use ``@return``. Instead use ``@retval`` to document return status
-  codes.
-* Do not write documentation for trivial functions.
-* Do not repeat documentation, use ``@see`` for example.
-* Do not use ``@note``.
-* Use groups and arrange them in a hierarchy. Put every file into at least
-  one group.
-* Use dot comments for state diagrams.
-* Use one whitespace character after an asterisk.
-
-Special Notes for Google Code-in Students
--
-
-Follow the directions given by the `Google Code-in
-`_ task and this should take
-care of itself if in doubt ask a mentor and/or tell a mentor the decision you
-made.
-
-Header File Example

-
-`thread.h
-`_ and
-`threadimpl.h
-`_
-should be a good example of how a header file shouldbe written. The following
-gives details in bits and pieces.
-
-Header blocks
--
-
-Header files should contain the similar comment blocks as other source files,
-described at :ref:`coding-file-hdr`.
-
-.. code-block:: c
-
-  /**
-   * @file
-   *
-   * @ingroup FlipFlop
-   *
-   * @brief Flip-Flop API
-   */
-
-  /*
-   * Copyright (c)  Author.
-   *
-   * The license and distribution terms for this file may be
-   * found in the file LICENSE in this distribution or at
-   * http://www.rtems.com/license/LICENSE.
-   */
-
-Header guard
-
-
-After the comment blocks, use a header guard that assembles at least the
-include path of the file. For example, if ``flipflop.h`` is in
- then
-
-.. code-block:: c
-
-  #ifndef RTEMS_LIB_FLIP_FLOP_H
-  #define RTEMS_LIB_FLIP_FLOP_H
-
-Includes
-
-
-Then add your include files before protecting C declarations from C++.
-
-.. code-block:: c
-
-  #include 
-
-  #ifdef __cplusplus
-  extern "C" {
-  #endif /* __cplusplus */
-
-Using @defgroup for group definitions
--
-
-Add any group definitions surrounding the function declarations that belong
-in that group. Rarely, a header may define more than one group. Here we use
-a dot diagram.
-
-.. code-block:: c
-
-  /**
-   * @defgroup FlipFlop Flip-Flop
-   *
-   * @brief Simple Flip-Flop state machine.
-   *
-   * @dot
-   *   digraph {
-   * start [label="START"];
-   * flip [label="FLIP"];
-   * flop [label="FLOP"];
-   * flip -> flop [label="flop()", URL="\ref flop"];
-   * flop -> flip [label="flip()", URL="\ref flip"];
-   * start -> flip
-   *   [label="flip_flop_initialize(FLIP)", URL="\ref 
flip_flop_initialize"];
-   * start -> flop
-   *   [label="flip_flop_initialize(FLOP)", URL="\ref 
flip_flop_initialize"];
-   * flip -> start
-   *   [label="flip_flop_restart()", URL="\ref flip_flop_restart"];
-   *   }
-   * @enddot
-   *
-   * @{
-   */
-
-enum and struct

-
-Provide documentation for declarations of enumerated types and structs.
-Use typedefs for structs, and do not use ``_t`` as a typename suffix.
-
-.. code-block:: c
-
-  /**
-   * @brief The set of possible flip-flop states.
-   *
-   * Enumerated type to define the set of states for a flip-flop.
-   */
-  typedef enum {
-START = 0,
-FLIP,
-FLOP
-  } flip_flop_state;
-
-  /**
-   

[PATCH 0/2] Rework Doxygen guidelines

[Sebastian Huber]

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| 652 ++
 eng/coding.rst|   1 -
 4 files changed, 206 insertions(+), 448 deletions(-)
 rename {eng => bsp-howto}/coding-doxygen-bsp.rst (100%)

-- 
2.16.4

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Joel Sherrill]

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_framework.h and really
wouldn't matter.

On Wed, Apr 3, 2019 at 2:32 AM Sebastian Huber <
sebastian.hu...@embedded-brains.de> wrote:

> 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 RTEMSTestFramework RTEMS Test Framework
> + *
> + * @ingroup RTEMSAPI
>   *
>   * @brief The RTEMS Test Framework helps you to write tests.
>   *
> --
> 2.16.4
>
> ___
> devel mailing list
> devel@rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
>
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Sebastian Huber]

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 
tests, it could be arbitrarily long like t_test_framework.h and really 
wouldn't matter.


I searched for  and it seems nobody else was crazy enough to use 
such a header file. Originally, the test framework had an RTEMS 
independent name. Maybe, we should move it to  and move 
the current  to .


--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Doxygen Guidelines: @brief for @file?

[Sebastian Huber]

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 @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 be redundant (the group should have an @brief and a detailed
description). This is my proposal for the @file blocks:

Files
-

Place an ``@file`` block at the top of each file.  The ``@file``
block
should
precede the license header.  This placement reduces the chance of
merge
conflicts in imported third-party code.  The ``@file`` block shall be
put into
a group with ``@ingroup``.  The ``@file`` block shall not have
additional
content, e.g. a ``@brief`` description.

.. code:: c

 /**
  * @file
  *
  * @brief RTEMSScoreThread
  */


The @brief shows up in at least the list of files and table of 
contents when PDF. It should
be a short English description of the files. I feel STRONGLY that we 
should have an @brief

and that it is better English than the example above.

Here is an example in HTML output of where it is used:

http://www.icu-project.org/apiref/icu4c/files.html

FWIW the daily built Doxygen is inaccessible so I can't show you what 
it looks like in our

documentation.


We have about 5000 files which should be in a group. I don't want to 
write prosaic text for each file. What about this approach:


/**
 * @file
 *
 * @ingroup RTEMSScoreThread
 *
 * @brief
 *
 * @copybrief RTEMSScoreThread
 */

--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Doxygen Guidelines: @brief for @file?

[Joel Sherrill]

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 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 be redundant (the group should have an @brief and a detailed
> > description). This is my proposal for the @file blocks:
> >
> > Files
> > -
> >
> > Place an ``@file`` block at the top of each file.  The ``@file``
> > block
> > should
> > precede the license header.  This placement reduces the chance of
> > merge
> > conflicts in imported third-party code.  The ``@file`` block shall be
> > put into
> > a group with ``@ingroup``.  The ``@file`` block shall not have
> > additional
> > content, e.g. a ``@brief`` description.
> >
> > .. code:: c
> >
> >  /**
> >   * @file
> >   *
> >   * @brief RTEMSScoreThread
> >   */
> >
> >
> > The @brief shows up in at least the list of files and table of
> > contents when PDF. It should
> > be a short English description of the files. I feel STRONGLY that we
> > should have an @brief
> > and that it is better English than the example above.
> >
> > Here is an example in HTML output of where it is used:
> >
> > http://www.icu-project.org/apiref/icu4c/files.html
> >
> > FWIW the daily built Doxygen is inaccessible so I can't show you what
> > it looks like in our
> > documentation.
>
> We have about 5000 files which should be in a group. I don't want to
> write prosaic text for each file.


Now you know why we have been using Doxygen as GCI tasks for years.
More people should mentor GCI to do this type of random, broad clean up.



> What about this approach:
>
> /**
>   * @file
>   *
>   * @ingroup RTEMSScoreThread
>   *
>   * @brief
>   *
>   * @copybrief RTEMSScoreThread
>   */
>

This is OK as a default but it shouldn't be the only option. I wouldn't
delete
a comment that was more specific or use that when a more specific
comment is better.

We don't want comments to exist just to improve a comments to code ratio.
They are supposed to be meaningful. IMO the copybrief adds no value to
the file when reading it. It only adds value when the file is processed and
you are reading the Doxygen output. So use this as a default but don't
delete @brief's which are better and this does not stop someone from
writing a more meaningful brief.

I still don't know where in the output, text beyond the @brief on a file
block goes. Any ideas?


>
> --
> 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.hu...@embedded-brains.de
> PGP : Public key available on request.
>
> Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.
>
> ___
> devel mailing list
> devel@rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

GSoC 2019 | Proposal Submitted

[Ravindra Kumar Meena]

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_vIYLKl5Em2lwF8W91YrHWkve2KRSPOolerjTg/edit?usp=sharing


Thanks

-- 
*Ravindra Kumar Meena*,
B. Tech. Computer Science and Engineering,
Indian Institute of Technology (Indian School of Mines)
, Dhanbad
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

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

[Vaibhav Gupta]

---
 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 
 5 files changed, 247 insertions(+)
 create mode 100644 testsuites/psxtests/psxinttypes01/init.c
 create mode 100644 testsuites/psxtests/psxinttypes01/psxinttypes01.doc
 create mode 100644 testsuites/psxtests/psxinttypes01/psxinttypes01.scn

diff --git a/testsuites/psxtests/Makefile.am
b/testsuites/psxtests/Makefile.am
index 749258cc0c..f619dd9ae9 100644
--- a/testsuites/psxtests/Makefile.am
+++ b/testsuites/psxtests/Makefile.am
@@ -22,6 +22,13 @@ psx01_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_FLAGS_psx01) \
$(support_includes) -I$(top_srcdir)/include
 endif

+if TEST_psxinttypes01
+psx_tests += psxinttypes01
+psxinttypes01_SOURCES = psxinttypes01/init.c
+psxinttypes01_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_FLAGS_psxinttypes01) \
+   $(support_includes)
+endif
+
 if HAS_POSIX
 if TEST_psx02
 psx_tests += psx02
diff --git a/testsuites/psxtests/configure.ac b/testsuites/psxtests/
configure.ac
index cdd6ee7e4e..e032a6f5ec 100644
--- a/testsuites/psxtests/configure.ac
+++ b/testsuites/psxtests/configure.ac
@@ -140,6 +140,7 @@ RTEMS_TEST_CHECK([psxtimes01])
 RTEMS_TEST_CHECK([psxualarm])
 RTEMS_TEST_CHECK([psxusleep])
 RTEMS_TEST_CHECK([lib_a])
+RTEMS_TEST_CHECK([psxinttypes01])

 AC_CONFIG_FILES([Makefile])
 AC_OUTPUT
diff --git a/testsuites/psxtests/psxinttypes01/init.c
b/testsuites/psxtests/psxinttypes01/init.c
new file mode 100644
index 00..1c6340afe2
--- /dev/null
+++ b/testsuites/psxtests/psxinttypes01/init.c
@@ -0,0 +1,154 @@
+/**
+ *  @file
+ *  @brief Test suite for inttypes.h methods
+ */
+
+/*
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (C) 2019, Vaibhav Gupta
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *notice, this list of conditions and the following disclaimer in the
+ *documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include 
+#include 
+#include 
+#include 
+#include 
+#include 
+#include 
+
+const char rtems_test_name[] = "PSXINTTYPE 01";
+
+/* forward declarations to avoid warnings */
+rtems_task Init(rtems_task_argument ignored);
+
+rtems_task Init(rtems_task_argument ignored)
+{
+  int   base = 10;
+  char *nptr1= "123abc";
+  char *endptr1  = NULL;
+  wchar_t  *nptr2= L"-123junk";
+  wchar_t  *endptr2  = NULL;
+  intmax_t  status1;
+  uintmax_t status2;
+
+
+  TEST_BEGIN();
+
+  puts( "\nChecking invalid base value" );
+  rtems_test_assert( base >=2 && base <= 36 );
+
+  /*Test for strtoimax  */
+  puts( "Strtoimax Testcases" );
+  puts( "Generating Status" );
+  status1 = strtoimax( nptr1, &endptr1, base );
+
+  rtems_test_assert( status1 != 0);
+  rtems_test_assert( base != EINVAL);
+
+  puts( "Checking Garbage end of endptr" );
+  rtems_test_assert( *endptr1 != '\0' );
+
+  puts( "Checking Underflow Case" );
+  rtems_test_assert( status1 >= INTMAX_MIN );
+
+  puts( "Checking Overflow Case" );
+  rtems_test_assert( status1 <= INTMAX_MAX ) ;
+
+  printf( "status = %jd \n" , status1 );
+
+  /*Test for strtoumax  */
+  puts( "Strtoumax Testcases" );
+  puts( "Generating Status" );
+  status2 = strtoumax( nptr1, &endptr1, base );
+
+  rtems_test_assert( status2 != 0);
+  rtems_test_assert( base != EINVAL);
+
+  puts( "Checking Garbage end of endptr" );
+  rtems_test_assert( *endptr1 != '\0' );
+
+  puts( "Checking Overflow Case" );
+  rtems_test_assert( status2 <= UINTMAX_MAX );
+
+  printf( "status = %ju \n", status2 );
+
+  /*Test for wcstoimax  */
+  puts( "Wcstoimax Testcases" );
+  puts( "Generating Status" );
+  status1 = wcstoimax

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

[Chris Johns]

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 short with no value to being short. Being used in the tests,
>> it could be arbitrarily long like t_test_framework.h and really wouldn't 
>> matter.
> 
> I searched for  and it seems nobody else was crazy enough to use such a
> header file. Originally, the test framework had an RTEMS independent name.
> Maybe, we should move it to  and move the current 
> to .

I am ok with renaming these files.

Chria
___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel

Re: Doxygen Guidelines: @brief for @file?

[Sebastian Huber]

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-brains.de>
> >> wrote:
>


[...]


What about this approach:

/**
  * @file
  *
  * @ingroup RTEMSScoreThread
  *
  * @brief
  *
  * @copybrief RTEMSScoreThread
  */


This is OK as a default but it shouldn't be the only option. I 
wouldn't delete

a comment that was more specific or use that when a more specific
comment is better.

We don't want comments to exist just to improve a comments to code ratio.
They are supposed to be meaningful. IMO the copybrief adds no value to
the file when reading it.


The file path, file name and @ingroup gives you already a good 
indication to which area a file belongs.



It only adds value when the file is processed and
you are reading the Doxygen output. So use this as a default but don't
delete @brief's which are better and this does not stop someone from
writing a more meaningful brief.


What about this:

Files
-

Each source or header file shall have an ``@file`` block at the top of the
file.  The ``@file`` block should precede the license header separated 
by one
blank line.  This placement reduces the chance of merge conflicts in 
imported

third-party code.  The ``@file`` block shall be put into a group with
``@ingroup GroupName``.  The ``@file`` block should have an ``@brief``
description and a detailed description if it is considered helpful. Use
``@brief @copybrief GroupName`` as a default to copy the ``@brief`` 
description

from the corresponding group and omit the detailed description.

.. code:: c

    /**
 * @file
 *
 * @ingroup RTEMSScoreThread
 *
 * @brief @copybrief RTEMSScoreThread
 */

.. code:: c

    /**
 * @file
 *
 * @ingroup RTEMSScoreThread
 *
 * @brief Some helpful brief description.
 *
 * Some helpful detailed description.
 */

Unclear:

Should the @brief in Title Case or should it be a normal sentence?

Some hints what helpful is would be nice. What is the threshold to write 
something special?




I still don't know where in the output, text beyond the @brief on a file
block goes. Any ideas?


It goes to the "Detailed Description" of the file documentation.

https://docs.rtems.org/doxygen/branches/master/score_2thread_8h.html#details

--
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.hu...@embedded-brains.de
PGP : Public key available on request.

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

___
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel