-
Notifications
You must be signed in to change notification settings - Fork 167
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 _CryptoExtras to CryptoExtras #281
base: main
Are you sure you want to change the base?
Conversation
@@ -79,7 +79,8 @@ let package = Package( | |||
], | |||
products: [ | |||
.library(name: "Crypto", targets: ["Crypto"]), | |||
.library(name: "_CryptoExtras", targets: ["_CryptoExtras"]), | |||
.library(name: "_CryptoExtras", targets: ["CryptoExtras"]), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One for discussion - the README is set up that this library won't exist but I've left it here for discussion if we want to keep it to maintain backwards compatibility or not or release this with the upcoming major version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think retaining the backward compatibility is valuable: while the underscore is present, we've tried to avoid gratuitously breaking things and it'd be nice to do so here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I've updated the README. In terms of getting this to work with CMake do I need an shim for _CryptoExtras
that points to CryptoExtras
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think so.
One thing this PR doesn't currently change is the CMake files - will wait to hear if it should be a breaking or backwards compatible change first |
I'm going to suggest we slow-roll this until we've had the conversation about the best name for this module. |
Rename
_CryptoExtras
toCryptoExtras
Checklist
If you've made changes to
gyb
files.script/generate_boilerplate_files_with_gyb
and included updated generated files in a commit of this pull requestMotivation:
CryptoExtras is now depended on by a number of libraries and well used and well understood. This PR formalises this with the removal of the underscore to the product to denote it's now a 'real' library
Modifications:
Renamed the product
Result:
import _CryptoExtras
is nowimport CryptoExtras