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>
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>
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.
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.
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.
rtems_shell_help static.
* libmisc/shell/main_hexdump.c: Make main_hexdump static.
* libmisc/shell/main_id.c: Make rtems_shell_main_id static.
* libmisc/shell/main_ifconfig.c: Make rtems_shell_main_ifconfig static.
* libmisc/shell/main_ln.c: Make rtems_shell_main_ln static.
* libmisc/shell/main_logoff.c: Make rtems_shell_main_logoff static.
* libmisc/shell/main_ls.c: Make rtems_shell_main_ls static.
* libmisc/shell/main_mallocinfo.c: Include <rtems/libcsupport.h>.
Remove private decls of malloc_info,
rtems_shell_print_unified_work_area_message.
Make rtems_shell_main_malloc_info static.
* libmisc/shell/main_medit.c: Remove private decl of
rtems_shell_main_mdump.
Make rtems_shell_main_medit static.
* libmisc/shell/main_mfill.c: Make rtems_shell_main_mfill static.
* libmisc/shell/main_mkdir.c: Make rtems_shell_main_mkdir static.
* libmisc/shell/main_mknod.c: Make rtems_shell_main_mknod static.
* libmisc/shell/main_mmove.c: Remove private decl of
rtems_shell_main_mdump.
Make rtems_shell_main_mmove static.
* libmisc/shell/main_mount.c: Make rtems_shell_main_mount static.
* libmisc/shell/main_msdosfmt.c: Make rtems_shell_main_msdos_format
static.
* libmisc/shell/main_mv.c: Include "internal.h".
Make rtems_shell_mv_exit, rtems_shell_main_mv static.
Remove private decls of strmode rtems_shell_main_cp,
rtems_shell_main_rm.
* libmisc/shell/main_mwdump.c: Make rtems_shell_main_mwdump static.
* libmisc/shell/main_netstats.c: Make rtems_shell_main_netstats
static.
* libmisc/shell/main_perioduse.c: Make rtems_shell_main_perioduse
static.
* libmisc/shell/main_pwd.c: Make rtems_shell_main_pwd static.
* libmisc/shell/main_rm.c: Include "internal.h".
Make rtems_shell_rm_exit static.
Remove private decl of strmode.
* libmisc/shell/main_rmdir.c: Make rtems_shell_main_rmdir static.
libmisc/shell/main_route.c: Make rtems_shell_main_route static.
* libmisc/shell/main_setenv.c: Make rtems_shell_main_setenv static.
* libmisc/shell/main_sleep.c: Make rtems_shell_main_sleep static.
* libmisc/shell/main_stackuse.c: Make rtems_shell_main_stackuse static.
* libmisc/shell/main_time.c: Make rtems_shell_main_time static.
* libmisc/shell/main_tty.c: Make rtems_shell_main_tty static.
* libmisc/shell/main_umask.c: Make rtems_shell_main_umask static.
* libmisc/shell/main_unmount.c: Make rtems_shell_main_unmount
static.
* libmisc/shell/main_unsetenv.c: Make rtems_shell_main_unsetenv
static.
* libmisc/shell/main_whoami.c: Make rtems_shell_main_whoami static.
* libmisc/shell/main_wkspaceinfo.c: Make
rtems_shell_main_wkspace_info static.
* libmisc/Makefile.am, libmisc/shell/main_chmod.c,
libmisc/shell/main_mdump.c, libmisc/shell/main_medit.c,
libmisc/shell/main_mfill.c, libmisc/shell/main_mmove.c,
libmisc/shell/main_msdosfmt.c, libmisc/shell/main_mwdump.c,
libmisc/shell/main_sleep.c, libmisc/shell/main_umask.c,
libmisc/shell/shell_script.c, libmisc/stringto/stringto.h,
libmisc/stringto/stringto_template.h: Convert return type from bool
to rtems_status_code and add rtems_string_to_pointer. Perform
associated clean up and changes for return type change.
* libmisc/stringto/stringtopointer.c: New file.
* libmisc/monitor/mon-monitor.c, libmisc/monitor/mon-object.c,
libmisc/monitor/monitor.h, libmisc/shell/main_chmod.c,
libmisc/shell/main_tty.c, libmisc/shell/main_umask.c,
libmisc/shell/main_whoami.c: Add pthread command to monitor when
POSIX is enabled. Remove include of rtems/monitor.h from files not
related.
* libmisc/shell/cat_file.c, libmisc/shell/main_alias.c,
libmisc/shell/main_blksync.c, libmisc/shell/main_cat.c,
libmisc/shell/main_chdir.c, libmisc/shell/main_chmod.c,
libmisc/shell/main_chroot.c, libmisc/shell/main_cpuuse.c,
libmisc/shell/main_date.c, libmisc/shell/main_help.c,
libmisc/shell/main_id.c, libmisc/shell/main_logoff.c,
libmisc/shell/main_ls.c, libmisc/shell/main_mallocinfo.c,
libmisc/shell/main_mdump.c, libmisc/shell/main_medit.c,
libmisc/shell/main_mfill.c, libmisc/shell/main_mkdir.c,
libmisc/shell/main_mmove.c, libmisc/shell/main_mount.c,
libmisc/shell/main_mount_nfs.c, libmisc/shell/main_msdosfmt.c,
libmisc/shell/main_mwdump.c, libmisc/shell/main_perioduse.c,
libmisc/shell/main_pwd.c, libmisc/shell/main_rm.c,
libmisc/shell/main_rmdir.c, libmisc/shell/main_stackuse.c,
libmisc/shell/main_tty.c, libmisc/shell/main_umask.c,
libmisc/shell/main_unmount.c, libmisc/shell/main_whoami.c,
libmisc/shell/shell.h: Clean up done while writing documentation.
Some command improvements such as date now allows setting of the
current TOD. Often commands did not use stdout/stderr per
expectations and did not return -1 on an error.
* libnetworking/rtems/tftp.h: Provide a decl to the TFTP file
system opts table.
* libnetworking/rtems/ftpfs.h: Provide a decl to the FTP file
system opts table.
* libmisc/Makefile.am: Add the mount command and supporting files.
* libmisc/preinstall.am: Rebuilt.
* libmisc/shell/cat_file.c, libmisc/shell/cmds.c,
libmisc/shell/main_alias.c, libmisc/shell/main_cat.c,
libmisc/shell/main_cd.c, libmisc/shell/main_chdir.c,
libmisc/shell/main_chmod.c, libmisc/shell/main_chroot.c,
libmisc/shell/main_cpuuse.c, libmisc/shell/main_date.c,
libmisc/shell/main_dir.c, libmisc/shell/main_exit.c,
libmisc/shell/main_help.c, libmisc/shell/main_id.c,
libmisc/shell/main_logoff.c, libmisc/shell/main_ls.c,
libmisc/shell/main_mallocdump.c, libmisc/shell/main_mdump.c,
libmisc/shell/main_medit.c, libmisc/shell/main_mfill.c,
libmisc/shell/main_mkdir.c, libmisc/shell/main_mmove.c,
libmisc/shell/main_mwdump.c, libmisc/shell/main_pwd.c,
libmisc/shell/main_rm.c, libmisc/shell/main_rmdir.c,
libmisc/shell/main_stackuse.c, libmisc/shell/main_tty.c,
libmisc/shell/main_umask.c, libmisc/shell/main_whoami.c,
libmisc/shell/shell.c, libmisc/shell/shell_cmdset.c,
libmisc/shell/shell_makeargs.c, libmisc/shell/str2int.c,
libmisc/shell/write_file.c: Move all shell_* types, variables and
functions to rtems_shell_* to avoid namespace clashes with
applications. The is an RTEMS shell after all.
* libmisc/shell/shell.h, libmisc/shell/internal.h,
libmisc/shell/shellconfig.h: Move all shell_* types, variables and
functions to rtems_shell_* to avoid namespace clashes with
applications. Add the mount command supporting types.
* libmisc/shell/main_mount.c, libmisc/shell/main_mount_ftp.c,
libmisc/shell/main_mount_msdos.c, libmisc/shell/main_mount_nfs.c,
libmisc/shell/main_mount_tftp.c: New.
Sebastian Huber
Joel Sherrill
Gedare Bloom
Chris Johns
Joel Sherrill
Ralf Corsepius