Files
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

113 lines
3.0 KiB
C

/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSImplShellCommands
*
* @brief This source file contains the cmdls shell command.
*/
/*
* Copyright (C) 2014 embedded brains GmbH & Co. KG
*
* 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 <errno.h>
#include <stdio.h>
#include <string.h>
#include <rtems/shellconfig.h>
#include "internal.h"
static void error(const char *s, int eno)
{
printf("%s: %s\n", s, strerror(eno));
}
static void print_cmd(const rtems_shell_cmd_t *shell_cmd)
{
if (rtems_shell_can_see_cmd(shell_cmd)) {
mode_t m = shell_cmd->mode;
printf(
"%c%c%c%c%c%c%c%c%c %5u %5u %s\n",
(m & S_IRUSR) != 0 ? 'r' : '-',
(m & S_IWUSR) != 0 ? 'w' : '-',
(m & S_IXUSR) != 0 ? 'x' : '-',
(m & S_IRGRP) != 0 ? 'r' : '-',
(m & S_IWGRP) != 0 ? 'w' : '-',
(m & S_IXGRP) != 0 ? 'x' : '-',
(m & S_IROTH) != 0 ? 'r' : '-',
(m & S_IWOTH) != 0 ? 'w' : '-',
(m & S_IXOTH) != 0 ? 'x' : '-',
(unsigned) shell_cmd->uid,
(unsigned) shell_cmd->gid,
shell_cmd->name
);
}
}
static int rtems_shell_main_cmdls(int argc, char **argv)
{
const rtems_shell_cmd_t *shell_cmd;
if (argc <= 1) {
shell_cmd = rtems_shell_first_cmd;
while (shell_cmd != NULL) {
print_cmd(shell_cmd);
shell_cmd = shell_cmd->next;
}
} else {
int i;
for (i = 1; i < argc; ++i) {
const char *cmd = argv[i];
shell_cmd = rtems_shell_lookup_cmd(cmd);
if (shell_cmd != NULL) {
print_cmd(shell_cmd);
} else {
error(cmd, ENOENT);
}
}
}
return 0;
}
rtems_shell_cmd_t rtems_shell_CMDLS_Command = {
.name = "cmdls",
.usage = "cmdls COMMAND...",
.topic = "misc",
.command = rtems_shell_main_cmdls
};