sys/shell: fix getopt() support #20209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixed broken Markdown code spans. Also added a code span around mention of getopt.
This patch adds details to the rationale behind the design of the argv/argc handling for shell command handlers. It also fixes a misspelling.
This patch adds the missing NULL terminator to the argv passed to shell command handlers. Without it, Newlib's getop() was intermittently causing hardfaults. Closer inspection of NewLib's code revealed that it relies in this NULL termination. ANSI-C also requires it of the argv passed to main().
This patch updates shell.c's doc that undersells the shells complexity. The comment seems to have been written prior to the shell's ability to parse command args and handle quoting sequences.
benpicco
added
the
CI: ready for build
benpicco
approved these changes
Dec 21, 2023
Always happy to contribute.
Yeah, I've been thrilled with using
:) Yep one of those problems that takes hours to figure out and 5 minutes to fix. To be honest, I thought that Newlib was to blame at first. Its getopt.c wasn't the cleanest in my opinion. Kind of amusing that I sometimes assume these well-known projects must be perfect. Then you go look, and realize it's authors are mere mortals too! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This patch adds the missing NULL terminator to the argv passed to shell command handlers. Without it, Newlib's getop() was intermittently causing hardfaults. Closer inspection of NewLib's code revealed that it relies in this NULL termination. ANSI-C also requires it of the argv passed to main().
Also included are some minor improvements to the documentation.
Testing procedure
For me
getopt()no longer causes hardfaults. Also code in shell.c now does what the doc in shell.h advertises that it does.Issues/PRs references