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

Renaming rust-crypto crate to crypto #153

Closed
icorderi opened this issue Nov 23, 2014 · 13 comments · Fixed by #166
Closed

Renaming rust-crypto crate to crypto #153

icorderi opened this issue Nov 23, 2014 · 13 comments · Fixed by #166

Comments

@icorderi
Copy link

Hey, I wanted to suggest a rename of the rust-crypto crate to just crypto.

It can be done in the Cargo.toml leaving the package name intact by just renaming the crate.

[lib]
# name = "rust-crypto"
name = "crypto"
path = "src/rust-crypto/lib.rs"

All import calls would then be:

// extern crate "rust-crypto" as crypto; // old way
extern crate crypto; // new way

What do you think?

@marcusklaas
Copy link
Contributor

+1

@DaGenix
Copy link
Owner

DaGenix commented Dec 6, 2014

It looks like crypto is already taken on crates.io. According to http://www.reddit.com/r/rust/comments/2ocz69/package_naming_and_grouped_packages_cratesio_and/ it sounds like there will be a blog post soon on suggested crate naming conventations. One thing that I saw suggested a while ago was that the "rust-" prefix might be reserved for offical Rust projects. I forget who said it and where I saw it, however. So, I think it would make sense to postpone any renaming until at least that blog post is published to see what it says.

Anyway, I'm leaning toward the idea of renaming, both to avoid the annoying extern crate statement and to avoid any confusion or issues with the "rust-" prefix. With crypto already taken, I'm not sure what would be the best name if we do decide to rename. crypt seems like it would potentially cause confusion with crypto. rcrypt might work, but I'm not crazy about it either. I was looking for other possibilies when I kinda got the idea of going with something Rusty-er. Maybe patina - a protective covering over metal - which feels kinda fitting for a Rust crypto library.

I'm certainly open to other suggestions, of course.

@chrisballinger
Copy link

crypto-rs?

On Fri, Dec 5, 2014 at 11:46 PM, DaGenix notifications@github.com wrote:

It looks like crypto is already taken on crates.io. According to
http://www.reddit.com/r/rust/comments/2ocz69/package_naming_and_grouped_packages_cratesio_and/
it sounds like there will be a blog post soon on suggested crate naming
conventations. One thing that I saw suggested a while ago was that the
"rust-" prefix might be reserved for offical Rust projects. I forget who
said it and where I saw it, however. So, I think it would make sense to
postpone any renaming until at least that blog post is published to see
what it says.

Anyway, I'm leaning toward the idea of renaming, both to avoid the
annoying extern crate statement and to avoid any confusion or issues with
the "rust-" prefix. With crypto already taken, I'm not sure what would be
the best name if we do decide to rename. crypt seems like it would
potentially cause confusion with crypto. rcrypt might work, but I'm not
crazy about it either. I was looking for other possibilies when I kinda got
the idea of going with something Rusty-er. Maybe patina - a protective
covering over metal - which feels kinda fitting for a Rust crypto library.

I'm certainly open to other suggestions, of course.


Reply to this email directly or view it on GitHub
#153 (comment).

@klutzy
Copy link

klutzy commented Dec 7, 2014

It looks like crypto is already taken on crates.io.

rust-lang/crates.io#58 (comment)

@icorderi
Copy link
Author

icorderi commented Dec 8, 2014

@DaGenix waiting for a resolution on the naming schemes and whether we will have namespaced crates makes a lot of sense.

By the way, have you tried asking @mahkoh for the name? I checked his repos and there doesn't seem to be anything with crypto in it.

@emberian
Copy link
Contributor

Even if the package name is rust-crypto, the crate name doesn't need to match it. Having the crate name not be a valid identifier is really inconvenient.

@DaGenix
Copy link
Owner

DaGenix commented Dec 13, 2014

@cmr - so we could just change:

[lib]
name = "rust-crypto"
path = "src/rust-crypto/lib.rs"

to

[lib]
name = "rustcrypto"
path = "src/rust-crypto/lib.rs"

then re-plubish and that would fix it?

That seems very appealing to me - what does everything else think?

Does anyone know if changing the crate name of an already uploaded package to crates.io. been tested?

@DaGenix
Copy link
Owner

DaGenix commented Dec 13, 2014

@icorderi - I haven't talked with @mahkoh. If what I think @cmr is suggesting would work, that seems ideal to me since it would appear to fix the issue with a minimum of churn. If that won't work, I'll see if @mahkoh would be willing to let it go.

As a side note, if we can just change the crate name, what should we change it to? My first thought is rustcrypto since that seems easiest.

@emberian
Copy link
Contributor

I think "crypto" is a good name. Having "rust" in a crate name is
pointless, the fact that it's "rust" is implicit in the fact that extern crate is written in a .rs file. I don't know of any problems with crates.io
in this regard...

On Fri, Dec 12, 2014 at 10:36 PM, DaGenix notifications@github.com wrote:

@icorderi https://github.com/icorderi - I haven't talked with @mahkoh
https://github.com/mahkoh. If what I think @cmr https://github.com/cmr
is suggesting would work, that seems ideal to me since it would appear to
fix the issue with a minimum of churn. If that won't work, I'll see if
@mahkoh https://github.com/mahkoh would be willing to let it go.

As a side note, if we can just change the crate name, what should we
change it to? My first thought is rustcrypto since that seems easiest.


Reply to this email directly or view it on GitHub
#153 (comment).

http://octayn.net/

@icorderi
Copy link
Author

@DaGenix what @cmr suggested is the same thing I suggested at the beginning.
I think is makes sense to have the package rust-crypto while the lib is just crypto.

@DaGenix
Copy link
Owner

DaGenix commented Dec 16, 2014

@icorderi I'm really sorry - I completely misread what you were suggesting. I will not be getting a gold star for my reading comprehnsion this week.

@DaGenix
Copy link
Owner

DaGenix commented Dec 16, 2014

I opened #166 to do the renaming suggested here.

@DaGenix
Copy link
Owner

DaGenix commented Dec 16, 2014

Unless someone brings up a new issue to discuss regarding the renaming, I'll merge that PR in the next day or two and publish a new release to crates.io.

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.

6 participants