667eeb11fb
MISRA Rule 5.7 requires uniqueness of tag identifiers. Shell is frequently problematic because many code uses `const struct shell *shell`. This causes CI noise every time one of these shell files is edited, so let's update all of them with `const struct shell *sh` instead. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
37 lines
726 B
C
37 lines
726 B
C
/*
|
|
* Copyright (c) 2018 Nordic Semiconductor ASA
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef SHELL_HELP_H__
|
|
#define SHELL_HELP_H__
|
|
|
|
#include <zephyr/shell/shell.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Function is printing command help string. */
|
|
void z_shell_help_cmd_print(const struct shell *sh,
|
|
const struct shell_static_entry *cmd);
|
|
|
|
/* Function is printing subcommands and help string. */
|
|
void z_shell_help_subcmd_print(const struct shell *sh,
|
|
const struct shell_static_entry *cmd,
|
|
const char *description);
|
|
|
|
/* Function returns true if str == -h or --help */
|
|
bool z_shell_help_request(const char *str);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SHELL_HELP__ */
|