Commit Graph
16 Commits
Author SHA1 Message Date
Sebastian Huber 3b061c5c44 cpukit/libmisc: Write the Doxygen briefs
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>
2026-09-01 20:17:20 +00:00
Sebastian Huber 7caa18eaec cpukit/libmisc: Fix the file groups
The capture engine, the monitor and the stdio redirector had no group on
any file.  The flattened device tree implementation sat in rtems_fdt,
the group of its API.  The string conversion, the BSP command line, the
dump buffer and the stack checker sources sat in the API group of the
interface they implement.  Twenty-four files wrote the group title after
the group name, so Doxygen looked for one group per title word.

Give each component the group of its implementation.  The stdio
redirector works on file descriptors, so it joins LibIO.  Drop the group
title from every @ingroup line.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-01 20:17:20 +00:00
Gedare Bloom 6c47d4d000 cpukit/libmisc: relicense stringto
Fixes #5475
Updates #3053
2026-02-05 14:50:37 -06:00
Gedare Bloom 41df32a43c cpukit/libmisc: reformat stringto
Fixes #5472.
2026-02-05 14:50:37 -06:00
Prashant Rahul 77b0e01e79 cpukit/stringto: add special defines for stringtounsignedchar
This adds special defines in case of conversion to unsigned char
Adds missing defines in some of the other stringto functions
and adds the stringto.h header to all stringto* implementations

Signed-off-by: Prashant Rahul <prashantrahul141@protonmail.com>
2026-02-04 23:34:44 +00:00
Prashant Rahul b0755abea6 cpukit/stringto: refactor: Revert to commit e8d59ca6af
Reverts back all stringto implementation files  to
e8d59ca6af

Signed-off-by: Prashant Rahul <prashantrahul141@protonmail.com>
2026-02-04 23:34:44 +00:00
Joel Sherrill 51a2ee5e33 cpukit/*: Add SPDX for RTEMS legacy license
These may still be relicensed but adding SPDX is needed.

Updates #4805.
2025-08-22 10:14:12 -05:00
Amar Takhar 662ad275f7 ascii: Remove non-ASCII characters from names
There are only the 3 names in our entire source that use non-ASCII characters.
Our documentation can still use any type of character.  We want to limit source
to ASCII for safety reasons.
2025-05-22 19:35:12 +00:00
Sebastian Huber cfe8f7a9b7 doxygen: Switch @brief and @ingroup
This order change fixes the Latex documentation build via Doxygen.
2020-04-28 09:04:00 +02:00
Chris Johns c49985691f Change all references of rtems.com to rtems.org. 2014-03-21 08:10:47 +11:00
Mathew Kallada f5f2676824 libmisc: Doxygen Enhancement Task #1 2012-12-21 11:13:06 -06:00
Joel Sherrill 9b4422a251 Remove All CVS Id Strings Possible Using a Script
Script does what is expected and tries to do it as
smartly as possible.

+ remove occurrences of two blank comment lines
  next to each other after Id string line removed.
+ remove entire comment blocks which only exited to
  contain CVS Ids
+ If the processing left a blank line at the top of
  a file, it was removed.
2012-05-11 08:44:13 -05:00
Ralf Corsepius a38457a755 2011-02-01 Ralf Corsepius <ralf.corsepius@rtems.org>
* libmisc/stringto/stringtofloat.c: Reformat range check.
	Add check for result = -HUGE_VALF.
2011-02-01 05:41:48 +00:00
Ralf Corsepius 8b9a33e895 2011-02-01 Ralf Corsepius <ralf.corsepius@rtems.org>
* libmisc/stringto/stringtodouble.c,
	libmisc/stringto/stringtofloat.c: Rework.
2011-02-01 02:34:19 +00:00
Ralf Corsepius 56f61c7d6f Add HAVE_CONFIG_H support to let files receive configure defines. 2010-03-28 15:20:32 +00:00
Joel Sherrill e8d59ca6af 2009-07-22 Joel Sherrill <joel.sherrill@oarcorp.com>
* Makefile.am, preinstall.am, libmisc/Makefile.am, wrapup/Makefile.am:
	Add the stringto family of string to number converters. These are
	error checking wrappers for the strtoXXX methods and do their best to
	return false if the conversion failed. The error checking required
	for this is tedious and error prone. Hence better to have in a family
	of helper routines.
	* libmisc/stringto/stringto.h, libmisc/stringto/stringto_template.h,
	libmisc/stringto/stringtodouble.c, libmisc/stringto/stringtofloat.c,
	libmisc/stringto/stringtoint.c, libmisc/stringto/stringtolong.c,
	libmisc/stringto/stringtolonglong.c,
	libmisc/stringto/stringtounsignedchar.c,
	libmisc/stringto/stringtounsignedint.c,
	libmisc/stringto/stringtounsignedlong.c,
	libmisc/stringto/stringtounsignedlonglong.c: New files.
2009-07-22 14:26:25 +00:00