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

Potentially rename some of the crates for clarity #824

Open
afranchuk opened this issue Mar 27, 2023 · 2 comments
Open

Potentially rename some of the crates for clarity #824

afranchuk opened this issue Mar 27, 2023 · 2 comments

Comments

@afranchuk
Copy link
Collaborator

I think some of the crates in the project could have better names, especially since #816 will be adding another crate. Changing crate names causes confusion for current consumers, however keeping poor names can cause confusion for future consumers: either decision has a downside.

This is my proposal (as if #816 occurred, anything omitted stays the same):

crate new name reasoning
minidump-processor (non-stackwalk logic) minidump-processor encompasses all the extra things this does
minidump-processor (stackwalk logic) minidump-stackwalk it's the stackwalk function
minidump-stackwalk minidump-analyzer it does much more than just stack walking

The mozilla minidump-analyzer crate (not in this project) could have another more specific name, like minidump-stack-info.

@gabrielesvelto
Copy link
Collaborator

Now that I've cut a new release I think we can proceed with this. We might aim for a 1.0.0 release which will break some things WRT the current setup but will also guarantee future stability. One thing I'd like to do first is figure out who are our non-Mozilla downstream users and how this would affect them (if at all).

@afranchuk
Copy link
Collaborator Author

Using the public information on crates.io, the external consumers look to be:
https://crates.io/crates/witchcraft-server
https://crates.io/crates/udbg
https://crates.io/crates/minidumper
https://crates.io/crates/minidump-debugger (assuming this doesn't fall into the "Mozilla" category)

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

No branches or pull requests

2 participants