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

ssl: help message refers to nonexistent function #8709

Merged
merged 1 commit into from
Aug 13, 2024

Conversation

lemenkov
Copy link
Contributor

@lemenkov lemenkov commented Aug 9, 2024

No such function - ssl_handshake. Obviously the intention was to refer to handshake

Copy link
Contributor

github-actions bot commented Aug 9, 2024

CT Test Results

    5 files    202 suites   1h 34m 41s ⏱️
2 374 tests 2 273 ✅ 101 💤 0 ❌
6 331 runs  5 337 ✅ 994 💤 0 ❌

Results for commit 86da67e.

♻️ 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

@IngelaAndin IngelaAndin self-requested a review August 9, 2024 14:42
@IngelaAndin IngelaAndin self-assigned this Aug 9, 2024
@IngelaAndin IngelaAndin added the team:PS Assigned to OTP team PS label Aug 9, 2024
@IngelaAndin IngelaAndin changed the base branch from master to maint August 9, 2024 14:43
@IngelaAndin IngelaAndin changed the base branch from maint to master August 9, 2024 14:43
@IngelaAndin
Copy link
Contributor

IngelaAndin commented Aug 9, 2024

@lemenkov could you please rebase it on maint so that this can be fixed in OTP-27 track too.

@lemenkov
Copy link
Contributor Author

lemenkov commented Aug 9, 2024

@IngelaAndin sure will do in a moment

@lemenkov lemenkov force-pushed the typo_undefined_function branch from c38e811 to 2ff97e1 Compare August 9, 2024 16:04
@lemenkov lemenkov changed the base branch from master to maint August 9, 2024 16:05
@IngelaAndin IngelaAndin added the testing currently being tested, tag is used by OTP internal CI label Aug 9, 2024
@IngelaAndin
Copy link
Contributor

IngelaAndin commented Aug 12, 2024

@lemenkov Thanks, when I was checking this for merge I however realized that the typo was actually that there was an _ instead of a : and that ssl: was missing in the the clause for cipher_suites. We think that including the module always even when it is the same is clearer and the information is sometimes also used in a non module context and then it is really nice that it exists. So could you please make your PR like this instead?

-removed({ssl_accept, '_', 
          "use ssl:handshake/1,2,3 instead"}).
-removed({cipher_suites, 0, 
          "use ssl:cipher_suites/2,3 instead"}).
-removed({cipher_suites, 1, 
          "use ssl:cipher_suites/2,3 instead"}).
-removed([{negotiated_next_protocol,1,
           "use ssl:negotiated_protocol/1 instead"}]).
-removed([{connection_info,1,
           "use ssl:connection_information/[1,2] instead"}]).

Where the three first clauses are the changed ones.

@lemenkov
Copy link
Contributor Author

Heh, @IngelaAndin you already invested more time on this task than me :)
Sure, I'll fix it in a moment.

@lemenkov lemenkov force-pushed the typo_undefined_function branch 3 times, most recently from 79a55f5 to ac383ed Compare August 12, 2024 14:25
* One help message refers to nonexistent functions.
* Unify function formats in help messages (use Mod:Fun/Arity everywhere
  where possible).

Signed-off-by: Peter Lemenkov <[email protected]>
@lemenkov lemenkov force-pushed the typo_undefined_function branch from ac383ed to 86da67e Compare August 12, 2024 16:49
@IngelaAndin IngelaAndin merged commit b4da873 into erlang:maint Aug 13, 2024
19 checks passed
@IngelaAndin
Copy link
Contributor

@lemenkov thanks for fixing all the places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:PS Assigned to OTP team PS testing currently being tested, tag is used by OTP internal CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants