Skip to content
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.

Sign up for GitHub

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

Jump to bottom

sys/shell: document configs and add them to Kconfig #15918

Merged
merged 1 commit into from
Feb 4, 2021
Merged

sys/shell: document configs and add them to Kconfig #15918

merged 1 commit into from
Feb 4, 2021

Conversation

leandrolanzieri
Copy link
Contributor

Contribution description

This documents the compile time configurations of the shell interpreter module, and models them in Kconfig. Although the previous macros were not documented I marked them now as deprecated, favoring the CONFIG_ version of them.

Testing procedure

  • tests/test_tool, tests/shell should work as usual
  • The changed applications should work
  • You should be able to configure via menuconfig or CFLAGS
  • The deprecated macros should still work

Issues/PRs references

Part of #12888

@leandrolanzieri leandrolanzieri added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: sys Area: System Area: Kconfig Area: Kconfig integration labels Feb 3, 2021
miri64
miri64 reviewed Feb 3, 2021
View reviewed changes
sys/include/shell.h Outdated Show resolved Hide resolved
sys/include/shell.h Outdated Show resolved Hide resolved
sys/shell/shell.c Show resolved Hide resolved
miri64
miri64 reviewed Feb 3, 2021
View reviewed changes
sys/shell/Kconfig Outdated Show resolved Hide resolved
@miri64 miri64 added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: run tests If set, CI server will run tests on hardware for the labeled PR labels Feb 3, 2021
miri64
miri64 approved these changes Feb 3, 2021
View reviewed changes
Copy link
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

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

ACK. This introduces the new Kconfig options as advertised and deprecates the old macros. The code is straight forward, so I can confirm visually that it should work, but any issues should be picked up by Murdock. Please squash!

@leandrolanzieri
Copy link
Contributor Author

All green @miri64 !

@leandrolanzieri leandrolanzieri added this to the Release 2021.04 milestone Feb 4, 2021
@miri64 miri64 merged commit 8610f84 into RIOT-OS:master Feb 4, 2021
@leandrolanzieri leandrolanzieri deleted the pr/kconfig/sys_shell branch February 4, 2021 09:59
@leandrolanzieri
Copy link
Contributor Author

Thanks for reviewing !

@leandrolanzieri leandrolanzieri mentioned this pull request Feb 4, 2021
Merged
@leandrolanzieri leandrolanzieri added the Release notes: added Set on PRs that have been processed into the release notes for the current release. label Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@miri64 miri64 miri64 approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@cgundogan cgundogan Awaiting requested review from cgundogan

@fjmolinas fjmolinas Awaiting requested review from fjmolinas

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

@MichelRottleuthner MichelRottleuthner Awaiting requested review from MichelRottleuthner MichelRottleuthner is a code owner

@smlng smlng Awaiting requested review from smlng

Assignees
No one assigned
Labels
Area: Kconfig Area: Kconfig integration Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: run tests If set, CI server will run tests on hardware for the labeled PR Release notes: added Set on PRs that have been processed into the release notes for the current release. Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2021.04
Development

Successfully merging this pull request may close these issues.
2 participants
@leandrolanzieri @miri64