mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-10-06 10:59:48 +08:00
Sebastian Huber
3b061c5c44
The briefs of the libmisc files named a topic, not the content of the file. Four shell briefs named the wrong command. The file main_blksync.c said "RM Shell Command Implementation". The files main_id.c, main_time.c and shellconfig.c named ls and debugrfs. Four string conversion sources named the conversion, for example "Convert String to Unsigned Long". Write every brief in the style of the tree. A source brief starts with "This source file contains". A command brief names the command the file provides. A header brief starts with "This header file provides". Put @file, @ingroup and @brief in this order in every block. Updates #5717. Assisted-by: Claude:claude-opus-5 claude-code Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
libmisc
This directory contains for the "miscellaneous" library. Currently this library contains a number of useful support libraries:
- Task Stack Overflow Checker
- Workspace Consistency Checker
- Task Execution Time Monitor
- Period Statistics Monitor
- Debug Monitor
The following ideas have been mentioned for items which could go in this library, but this list is not all inclusive:
- there are no outstanding suggestions.
The intent of this library is to provide a home for useful utility routines which are dependent upon RTEMS.
--joel 16 Sept 97