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

Rename shim-client to shim-proto #1

Closed
jiangliu opened this issue Dec 11, 2021 · 3 comments · Fixed by #14
Closed

Rename shim-client to shim-proto #1

jiangliu opened this issue Dec 11, 2021 · 3 comments · Fixed by #14

Comments

@jiangliu
Copy link
Contributor

The shim-client provides message and trait definitions for both server and client, so it would be great to rename it as shim-proto.

@mxpv
Copy link
Member

mxpv commented Dec 11, 2021

You mean directory name or crate name?
Crate itself named containerd-shim-client (I used containerd- prefix everywhere for clarity that this is relevant for containerd).
I don't mind having containerd-shim-proto, the only cons I see is that this crate is already published on crates.io, so renaming might be a bit confusing to users which one is correct to use.

@jiangliu
Copy link
Contributor Author

You mean directory name or crate name? Crate itself named containerd-shim-client (I used containerd- prefix everywhere for clarity that this is relevant for containerd). I don't mind having containerd-shim-proto, the only cons I see is that this crate is already published on crates.io, so renaming might be a bit confusing to users which one is correct to use.

I mean to rename the crate name. It's great to share "containerd-" prefix for all crates from the rust-extensions project. I prefer "containerd-shim-proto" over "containerd-shim-client" because

  1. it's a library instead of a binary
  2. it contains code for both server and client.

But it's true that it may cause some confusions:(

@jiangliu
Copy link
Contributor Author

Seems cargo yank may help here:
https://doc.rust-lang.org/cargo/reference/publishing.html#cargo-yank

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants