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 the repos #232

Closed
rukai opened this issue Jun 20, 2019 · 12 comments
Closed

Rename the repos #232

rukai opened this issue Jun 20, 2019 · 12 comments
Labels
area: ecosystem Help the connected projects grow and prosper type: question Further information is requested

Comments

@rukai
Copy link
Contributor

rukai commented Jun 20, 2019

After a discussion in the rust community discord I was reminded how confusing the wgpu naming is.

There are two main wgpu crates that people care about: wgpu and wgpu-native.
Currently they belong to these repos:

I propose we rename like this:

If we are open to changing crate names, then we could do this:

@m4b
Copy link
Contributor

m4b commented Jun 20, 2019

I also find this confusing, and keep forgetting the crate name for wgpu-rs is just wgpu; I propose that whatever names are chosen, their crate name == github repo name

@kvark
Copy link
Member

kvark commented Jun 20, 2019

I also find this confusing, and keep forgetting the crate name for wgpu-rs is just wgpu

Having the crate name without -rs suffix is totally normal, i.e. cgmath crate used to be hosted in "cgmath-rs" repo, which got renamed upon moving to "rustgb" org. There are still cgmath-rs forks found on github.

Renaming wgpu repo to wgpu-native would also be misleading, since it also contains the wgpu-remote.

I do admit that the state of things is not ideal today, and it's not obvious from the first sight where things are. I suggest we delay the discussion to the time where Gecko integration is happening, and keep the names unchanged till then.

It might be possible, for example, that the wgpu-remote implementation would not need to be synchronized back to Github (I doubt there is much contributor interest in this particular bit). So we'd be able to just have wgpu-native repository then.

@m4b
Copy link
Contributor

m4b commented Jun 20, 2019

Having the crate name without -rs suffix is totally normal,

This is an anti-pattern imho, and unfortunately keeps being perpetuated in rust crates. Just because people do it, doesn't mean they should; another example of this is foo-bar, where they use a dash in their crates.io name, and so the toml name, but code references must be underscored, because dashes aren't allowed in programmatic crate names.

Anyway, I'm risking derailing this on "normal" naming schemes, but you don't have to follow what is arguably "normal" or not, and I just think its clearer if the repo is named the same as the crate, that way there's zero ambiguity.

A similar pain point in ocaml: where the library name on opam (the package manager) isn't the same as the module name used in code, and it's just... annoying.

Anyway, just my two-cents.

@rukai
Copy link
Contributor Author

rukai commented Jun 20, 2019

If gecko integration is still a long way off, I think we should change the wgpu repo to wgpu-native now.
People aren't going to be put off that there is an extra crate (wgpu-remote) sitting there, that they dont care about.
They are currently very put off by the fact that the wgpu crate does not live in the repo named wgpu.

I agree that keeping the wgpu crate name and wgpu-rs repo name as is, is fine.

@m4b
Copy link
Contributor

m4b commented Jun 20, 2019

Yea I agree with @rukai, at very least it makes sense to figure out proper repo for wgpu-native

@kvark
Copy link
Member

kvark commented Jun 20, 2019

Repositories with multiple crates are the norm too. wgpu is one such repository. For as long as it has "wgpu-remote" crate, we can't rename the repository to "wgpu-native".

Integration with Gecko should have started a while ago. It's already delayed past the schedule. It's not a long way off.

@Lokathor
Copy link

Sure, a repo can have more than one crate.

However, when the wgpu crate exists and there's also a wgpu repo then people think "oh, same name, naturally that's the right repo". Then they look around and none of the right stuff is there and they get confused and angry.

So what shouldn't happen is that there's a repo named wgpu that doesn't hold the crate wgpu.

Here's some possible paths to fixing the situation and making it much more approachable to new users:

  • You could put all three crates (wgpu, wgpu-native, and wgpu-remote) into a single repo named wgpu and then explain in the readme that it's a multi-crate repository.
  • You could put all three crates each into their own repo and have their readme files point to the other sibling repos and explain what each crate is used for and that a normal rust user probably wants to use the rust wrapper wgpu crate.
  • You could put wgpu crate into wgpu repo and have wgpu-native and wgpu-remote be in a wgpu-impls crate or something
  • Any other renaming scheme that doesn't involve a wgpu repo existing but not being home of the wgpu crate.

@kvark
Copy link
Member

kvark commented Jun 26, 2019

@Lokathor this is reasonable. Note that we used to have everything in a single repo, but recently separated them, because some of the things are meant to be synchronized from Gecko.
My resolution so far is not rejecting your (in a large sense) proposals - is instead delaying the decision to rename the repo until it becomes more clear what the relationship with Gecko is.

One of the possible outcomes is: wgpu-remote gets completely moved to Gecko, community isn't interested in using it, so we don't sync it back to Github. Therefore, Github's project can be safely renamed to wgpu-native.

rofrol added a commit to rofrol/awesome-wgpu that referenced this issue Jan 15, 2020
@GabrielMajeri
Copy link
Contributor

Now that wgpu-native has been moved to its own repo, how does it affect this issue? Is the name sufficiently clear for the wgpu-core and wgpu-types crates from this repo?

@kvark
Copy link
Member

kvark commented May 4, 2020

I think there is still a bit of a desire (voiced by @grovesNL previously) to rename this repo to wgpu-core, hence the issue can be left open.

@rukai
Copy link
Contributor Author

rukai commented May 4, 2020

It looks like waiting paid off!
I agree with groves, I think we should now rename this repo to wgpu-core.

@cwfitzgerald cwfitzgerald added area: ecosystem Help the connected projects grow and prosper type: question Further information is requested labels Dec 1, 2020
kvark added a commit to kvark/wgpu that referenced this issue Jun 3, 2021
232: Update to latest wgpu, duplicate RequestAdapterOptions r=kvark a=kvark



Co-authored-by: Dzmitry Malyshau <kvarkus@gmail.com>
@cwfitzgerald
Copy link
Member

Post hal move, everything is in this one repo, so closing.

Patryk27 pushed a commit to Patryk27/wgpu that referenced this issue Nov 23, 2022
Have single place where advancing to next line
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: ecosystem Help the connected projects grow and prosper type: question Further information is requested
Projects
None yet
Development

No branches or pull requests

6 participants