Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Deprecate the rpma_conn_completion_*() functions #1212

Closed
janekmi opened this issue Aug 24, 2021 · 5 comments
Closed

Deprecate the rpma_conn_completion_*() functions #1212

janekmi opened this issue Aug 24, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation work-in-progress

Comments

@janekmi
Copy link

janekmi commented Aug 24, 2021

When #1080 will be merged it effectively makes a number of functions obsolete:

  • rpma_conn_completion_get()
  • rpma_conn_completion_wait()
  • rpma_conn_get_completion_fd()

Currently, we think the right thing to do is to:

  1. Mark these functions as deprecated.
  2. Delete them overall before the release after next.

NOTE: Along with marking these functions as deprecated, it will be helpful to add to the librpma(7) a note on how the end-user should interpret such a notice.

@janekmi janekmi added the documentation Improvements or additions to documentation label Aug 24, 2021
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 8, 2021
1) mark rpma_conn_completion_get(), rpma_conn_completion_wait()
   and rpma_conn_get_completion_fd() as deprecated.
2) add explanation for the deprecated tag.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 8, 2021
use the new APIs in librpma(7) instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
@yangx-jy
Copy link
Contributor

yangx-jy commented Sep 8, 2021

Hi @janekmi @grom72 @ldorau

Should I update all examples to use the new APIs?

@grom72
Copy link
Contributor

grom72 commented Sep 8, 2021

Yes, we should be prepared for deprecated API to be removed.

yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 8, 2021
1) mark rpma_conn_completion_get(), rpma_conn_completion_wait()
   and rpma_conn_get_completion_fd() as deprecated.
2) add explanation for the deprecated tag.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 8, 2021
use the new API calls in librpma(7) instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 8, 2021
use the new API calls in librpma(7) instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
@yangx-jy
Copy link
Contributor

yangx-jy commented Sep 8, 2021

Yes, we should be prepared for deprecated API to be removed.

OK, I will update all examples to use the new APIs this week.

yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 18, 2021
1) mark rpma_conn_completion_get(), rpma_conn_completion_wait()
   and rpma_conn_get_completion_fd() as deprecated.
2) add explanation for the deprecated tag.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Sep 18, 2021
use the new API calls instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
@janekmi
Copy link
Author

janekmi commented Sep 30, 2021

Extend deprecated functions documentation with examples showing the proper new way of using them

#1274

yangx-jy added a commit to yangx-jy/rpma that referenced this issue Oct 1, 2021
1) mark rpma_conn_completion_get(), rpma_conn_completion_wait()
   and rpma_conn_get_completion_fd() as deprecated.
2) add DEPRECATING section to explain the deprecated tag.
3) add DEPRECATED section to explain how to use new functions instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
yangx-jy added a commit to yangx-jy/rpma that referenced this issue Oct 1, 2021
use the new API calls instead.

Ref: pmem#1212

Signed-off-by: Xiao Yang <[email protected]>
@grom72
Copy link
Contributor

grom72 commented Feb 11, 2022

Fixed in #1529

@grom72 grom72 closed this as completed Feb 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation work-in-progress
Projects
None yet
Development

No branches or pull requests

3 participants