Skip to content

sys/shell: expose readline() #21505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged

Conversation

derMihai
Copy link
Contributor

Contribution description

For interactive shell commands, readline() is very useful as it provides robust line fetching from the console and is already externally linked. This PR just declares it in shell.h

Testing procedure

Nothing to be tested.

@github-actions github-actions bot added the Area: sys Area: System label May 23, 2025
Copy link
Contributor

@Teufelchen1 Teufelchen1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Easy!
I would be happy to merge it as is but if you feel like fixing the static test errors that would be nice.

@derMihai derMihai force-pushed the mir/export_readline branch from 8c9c4c8 to b149bfb Compare May 23, 2025 08:39
@Teufelchen1 Teufelchen1 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 23, 2025
@riot-ci
Copy link

riot-ci commented May 23, 2025

Murdock results

✔️ PASSED

b149bfb sys/shell: expose readline()

Success Failures Total Runtime
10363 0 10363 14m:19s

Artifacts

@Teufelchen1 Teufelchen1 added this pull request to the merge queue May 23, 2025
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label May 23, 2025
* @return EOF, if the end of the input stream was reached.
* @return -ENOBUFS if the buffer size was exceeded.
*/
int readline(char *buf, size_t size);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
int readline(char *buf, size_t size);
int shell_read_line(char *buf, size_t size);

as we usually prefix all functions with their module name?

Merged via the queue into RIOT-OS:master with commit 584e14b May 23, 2025
28 checks passed
@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants