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.

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

Fix up the built-in help text in the shell #8573

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

richcarl
Copy link
Contributor

Sort the entries for readability. Document the exit/0 builtin. Move the code for the builtins help to the shell module itself to make it easier to keep it in sync. Move text for hcb() and ht() functions to the c module since they are not shell builtins.

Sort the entries for readability. Document the exit/0 builtin.
Move the code for the builtins help to the shell module itself to
make it easier to keep it in sync. Move text for hcb() and ht()
functions to the c module since they are not shell builtins.
Copy link
Contributor

github-actions bot commented Jun 13, 2024

CT Test Results

    2 files     95 suites   35m 26s ⏱️
2 142 tests 2 093 ✅ 48 💤 1 ❌
2 451 runs  2 400 ✅ 50 💤 1 ❌

For more details on these failures, see this check.

Results for commit 83b8f12.

♻️ This comment has been updated with latest results.

To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass.

See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally.

Artifacts

// Erlang/OTP Github Action Bot

@rickard-green rickard-green added the team:VM Assigned to OTP team VM label Jun 17, 2024
@frazze-jobb frazze-jobb self-assigned this Jun 17, 2024
Copy link
Contributor

@frazze-jobb frazze-jobb left a comment

Choose a reason for hiding this comment

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

I will remove the comment before submitting

@@ -1327,6 +1370,7 @@ local_func(tf, [{atom,_,A}], Bs, _Shell, _RT, FT, _Lf, _Ef) ->
local_func(tf, [_], _Bs, _Shell, _RT, _FT, _Lf, _Ef) ->
erlang:raise(error, function_clause, [{shell,tf,1}]);
local_func(rd, [{string, _, TypeDef}], Bs, _Shell, RT, FT, _Lf, _Ef) ->
%% currently not documented in help()
Copy link
Contributor

Choose a reason for hiding this comment

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

this is one that should only be used internally, so are td and fd

@frazze-jobb frazze-jobb added the testing currently being tested, tag is used by OTP internal CI label Jul 5, 2024
@frazze-jobb frazze-jobb merged commit 14bbc87 into erlang:master Jul 8, 2024
14 of 16 checks passed
@richcarl richcarl deleted the shell-help-cleanup branch July 8, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:VM Assigned to OTP team VM testing currently being tested, tag is used by OTP internal CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants