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

UCT/DOC: document uct_ep_disconnect return codes #4586

Merged
merged 3 commits into from
Jan 8, 2020
Merged

UCT/DOC: document uct_ep_disconnect return codes #4586

merged 3 commits into from
Jan 8, 2020

Conversation

evgeny-leksikov
Copy link
Contributor

What

Document uct_ep_disconnect return codes

Why ?

To make clearer specially handled errors

@shamisp
Copy link
Contributor

shamisp commented Dec 16, 2019

@tonycurtis @bbenton - please take a look. Overall, looks good to me.

@tonycurtis
Copy link
Contributor

tonycurtis commented Dec 16, 2019 via email

@mellanox-github
Copy link
Contributor

Mellanox CI: PASSED on 25 workers (click for details)

Note: the logs will be deleted after 23-Dec-2019

Agent/Stage Status
_main ✔️ SUCCESS
hpc-arm-cavium-jenkins_W0 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W1 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W2 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W3 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W0 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W1 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W2 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W3 ✔️ SUCCESS
hpc-test-node-gpu_W0 ✔️ SUCCESS
hpc-test-node-gpu_W1 ✔️ SUCCESS
hpc-test-node-gpu_W2 ✔️ SUCCESS
hpc-test-node-gpu_W3 ✔️ SUCCESS
hpc-test-node-legacy_W0 ✔️ SUCCESS
hpc-test-node-legacy_W1 ✔️ SUCCESS
hpc-test-node-legacy_W2 ✔️ SUCCESS
hpc-test-node-legacy_W3 ✔️ SUCCESS
hpc-test-node-new_W0 ✔️ SUCCESS
hpc-test-node-new_W1 ✔️ SUCCESS
hpc-test-node-new_W2 ✔️ SUCCESS
hpc-test-node-new_W3 ✔️ SUCCESS
r-vmb-ppc-jenkins_W0 ✔️ SUCCESS
r-vmb-ppc-jenkins_W1 ✔️ SUCCESS
r-vmb-ppc-jenkins_W2 ✔️ SUCCESS
r-vmb-ppc-jenkins_W3 ✔️ SUCCESS

@mellanox-github
Copy link
Contributor

Mellanox CI: PASSED on 25 workers (click for details)

Note: the logs will be deleted after 23-Dec-2019

Agent/Stage Status
_main ✔️ SUCCESS
hpc-arm-cavium-jenkins_W0 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W1 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W2 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W3 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W0 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W1 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W2 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W3 ✔️ SUCCESS
hpc-test-node-gpu_W0 ✔️ SUCCESS
hpc-test-node-gpu_W1 ✔️ SUCCESS
hpc-test-node-gpu_W2 ✔️ SUCCESS
hpc-test-node-gpu_W3 ✔️ SUCCESS
hpc-test-node-legacy_W0 ✔️ SUCCESS
hpc-test-node-legacy_W1 ✔️ SUCCESS
hpc-test-node-legacy_W2 ✔️ SUCCESS
hpc-test-node-legacy_W3 ✔️ SUCCESS
hpc-test-node-new_W0 ✔️ SUCCESS
hpc-test-node-new_W1 ✔️ SUCCESS
hpc-test-node-new_W2 ✔️ SUCCESS
hpc-test-node-new_W3 ✔️ SUCCESS
r-vmb-ppc-jenkins_W0 ✔️ SUCCESS
r-vmb-ppc-jenkins_W1 ✔️ SUCCESS
r-vmb-ppc-jenkins_W2 ✔️ SUCCESS
r-vmb-ppc-jenkins_W3 ✔️ SUCCESS

@alinask
Copy link
Contributor

alinask commented Dec 17, 2019

@evgeny-leksikov is the concept of locally and remotely connected ep clear to a user..?
i'm not sure we use this terminology in the api. maybe add an explanation of what it means?

@evgeny-leksikov
Copy link
Contributor Author

@evgeny-leksikov is the concept of locally and remotely connected ep clear to a user..?
i'm not sure we use this terminology in the api. maybe add an explanation of what it means?

There are mentions of remote peer/side in the func description, also I tried to explain it referring to corresponding callbacks, do you think need to add something else?

@alinask
Copy link
Contributor

alinask commented Dec 17, 2019

@evgeny-leksikov is the concept of locally and remotely connected ep clear to a user..?
i'm not sure we use this terminology in the api. maybe add an explanation of what it means?

There are mentions of remote peer/side in the func description, also I tried to explain it referring to corresponding callbacks, do you think need to add something else?

There are mentions of remote peer but not of a remote connected ep. IMHO it would be better to explain.
Also, should we mention that UCS_ERR_NOT_CONNECTED and UCS_INPROGRESS are returned on repeating calls to this function?

@evgeny-leksikov
Copy link
Contributor Author

There are mentions of remote peer but not of a remote connected ep. IMHO it would be better to explain.

@yosefe WDTY? IMO it's clear from whole the description

Also, should we mention that UCS_ERR_NOT_CONNECTED and UCS_INPROGRESS are returned on repeating calls to this function?

I don't think so because such calls don't have side effect except notification to user.

@shamisp
Copy link
Contributor

shamisp commented Dec 17, 2019

@alinask made valid point. Probably you can state that the disconnect request was initiated, but the remote peer didn't respond on the request and callback registered under XXX has not been invoked to process the request

@shamisp
Copy link
Contributor

shamisp commented Dec 17, 2019

I'm sure @tonycurtis can come up with more compelling clarification :)

@tonycurtis
Copy link
Contributor

tonycurtis commented Dec 17, 2019 via email

@evgeny-leksikov
Copy link
Contributor Author

@tonycurtis thank you!

Also a query whether the @ref should be to the type names?

I think this is pretty useful because goxygen generates valid link to the type thich is documented how to use it in correct way.

@mellanox-github
Copy link
Contributor

Mellanox CI: PASSED on 25 workers (click for details)

Note: the logs will be deleted after 26-Dec-2019

Agent/Stage Status
_main ✔️ SUCCESS
hpc-arm-cavium-jenkins_W0 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W1 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W2 ✔️ SUCCESS
hpc-arm-cavium-jenkins_W3 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W0 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W1 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W2 ✔️ SUCCESS
hpc-arm-hwi-jenkins_W3 ✔️ SUCCESS
hpc-test-node-gpu_W0 ✔️ SUCCESS
hpc-test-node-gpu_W1 ✔️ SUCCESS
hpc-test-node-gpu_W2 ✔️ SUCCESS
hpc-test-node-gpu_W3 ✔️ SUCCESS
hpc-test-node-legacy_W0 ✔️ SUCCESS
hpc-test-node-legacy_W1 ✔️ SUCCESS
hpc-test-node-legacy_W2 ✔️ SUCCESS
hpc-test-node-legacy_W3 ✔️ SUCCESS
hpc-test-node-new_W0 ✔️ SUCCESS
hpc-test-node-new_W1 ✔️ SUCCESS
hpc-test-node-new_W2 ✔️ SUCCESS
hpc-test-node-new_W3 ✔️ SUCCESS
r-vmb-ppc-jenkins_W0 ✔️ SUCCESS
r-vmb-ppc-jenkins_W1 ✔️ SUCCESS
r-vmb-ppc-jenkins_W2 ✔️ SUCCESS
r-vmb-ppc-jenkins_W3 ✔️ SUCCESS

@alinask
Copy link
Contributor

alinask commented Dec 25, 2019

@tonycurtis Can you please review?

@evgeny-leksikov evgeny-leksikov mentioned this pull request Dec 26, 2019
Merged
@shamisp
Copy link
Contributor

shamisp commented Jan 7, 2020

@tonycurtis ?

@shamisp
Copy link
Contributor

shamisp commented Jan 7, 2020

I'm 👍

@tonycurtis
Copy link
Contributor

tonycurtis commented Jan 8, 2020 via email

@shamisp shamisp merged commit 230daff into openucx:master Jan 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yosefe yosefe yosefe approved these changes

@alinask alinask Awaiting requested review from alinask

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@evgeny-leksikov @shamisp @tonycurtis @mellanox-github @alinask @yosefe