14 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 2ac6ce0f41 cpukit/libmisc/shell: Group the files
Two of the 124 shell sources named a group.  The other 122 gave Doxygen
no place to file them, so the shell groups listed two files.

Point each command at RTEMSImplShellCommands and each infrastructure
file at RTEMSImplShell.  The imported utility code joins
RTEMSImplShellUtilities.

Fifty-five files still have no Doxygen block.  Most of them hold the
imported utility code.  A later commit adds the blocks.

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 1f79c2d7ef cpukit/libfs: Fix the file system groups
Six group names in libfs reached no group.  The names libfs_msdos,
libfs_dosfs, FatFS and LibFSIMFS had no definition.  The groups
libfs_ff and libfs_ffo had a definition with no parent.  Nineteen files
in defaults wrote the group title after the group name, so Doxygen
looked for the groups File, System and Operations as well.

Point the DOS file system files at DOSFS and delete the two dead group
definitions in dosfs.  Point the FatFS files at RTEMSImplFATFS and
imfs_init.c at IMFS.  Drop the group title from the @ingroup lines in
defaults.

The file ioman.c implements rtems_io_register_name(), so it joins
RTEMSImplClassicIO with the other I/O manager directives.  The file
imfs_eval_devfs.c joins IMFS with its neighbour imfs_eval.c.

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
Joel Sherrill 3c2592be04 cpukit/libmisc/shell: Correct comparisons of different signedness
The GCC warning -Wsign-compare flagged these instances of comparing
signed and unsigned types. A common pair was size_t and int.
2025-12-04 18:46:23 -05:00
Joel Sherrill f519633d0d cpukit/.../shell: Address missing field initializer warnings
Address missing field initializer warnings.

These were all rtems_shell_cmd_t or rtems_shell_alias_t declarations
with initialization.  The initialization was changed to using named
fields.

Updates #5325.
2025-10-14 14:23:59 -05: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
Joel Sherrill 68baf9eead libmisc/shell/*: Relicense to 2-BSD
Many files in this directory were by persons and organizations
that have previously given relicensing permission. git history
was used to confirm authorship and contributions on files which
had unclear or missing copyrights.

Update #3053.
2025-03-01 20:21:56 +00:00
zhengxiaojun 29a0d99bfd cpukit/libmisc/shell:fix command df overflow
- change type unsigned to uint64_t, it might overflowed if
    the size is greater the 4GB.
  - increase buffer size is to eliminate the compiler's warning
    that the buffer might be too small
2024-09-13 21:30:43 +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
Joel Sherrill 5ce776ec62 cpukit/libmisc/shell/main_df.c: Eliminate printf() format warning 2015-03-22 10:29:57 -05:00
Gedare Bloom ce4e691a01 shell: fix printf warnings 2015-03-16 13:01:37 -04:00
Chris Johns c49985691f Change all references of rtems.com to rtems.org. 2014-03-21 08:10:47 +11:00
Sebastian Huber 7660e8b347 Include missing <string.h> 2013-07-23 15:12:54 +02:00
Andrei Mozzhuhin 7bb71c7e9d shell: Add df command 2013-05-16 11:40:42 +02:00