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.

Sign up for GitHub

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

Jump to bottom

Make feature flags consistent #717

Closed
7596ff opened this issue Feb 18, 2021 · 5 comments
Closed

Make feature flags consistent #717

7596ff opened this issue Feb 18, 2021 · 5 comments
Labels
c-all Affects all crates or the project as a whole m-breaking change Breaks the public API.
Milestone
0.5

Comments

@7596ff
Copy link
Contributor

7596ff commented Feb 18, 2021

No description provided.

@7596ff 7596ff added m-breaking change Breaks the public API. enhancement c-all Affects all crates or the project as a whole labels Feb 18, 2021
@7596ff 7596ff added this to the 0.4 milestone Feb 18, 2021
@7596ff
Copy link
Contributor Author

7596ff commented Feb 18, 2021

Related: #703

@zeylahellyer zeylahellyer mentioned this issue May 22, 2021
Merged
zeylahellyer added a commit that referenced this issue May 22, 2021
@zeylahellyer
enhancement!(gateway): rename zlib features (#829)
fc3c8ec 
Rename the two zlib features - `stock-zlib` and `simd-zlib` - for
consistency with other feature flags. These have been renamed to
`zlib-stock` and `zlib-simd` to properly namespace the feature flags.

Closes #717.

BREAKING CHANGES: The gateway's `stock-zlib` and `simd-zlib` feature
flags have been renamed to `zlib-stock` and `zlib-simd`, respectively.
@7596ff 7596ff modified the milestones: 0.4, 0.5 May 27, 2021
@7596ff
Copy link
Contributor Author

7596ff commented May 27, 2021

At present next, the feature flags are as follows:

gateway 
|- default
|  |- compression
|  |- rustls
|  `- flate2/zlib
|
|- compression
|  ` flate2
|
|- native
|  |- twilight-http/native
|  |- twilight-gateway-queue/native
|  `- tokio-tungstenite/native-tls
|
|- rustls
|  ` rustls-native-roots
|    |- twilight-http/rustls-native-roots
|    |- twilight-gateway-queue/rustls-native-roots
|    `- tokio-tungstenite/rustls-tls
|
|- rustls-webpki-roots
|  |- twilight-http/rustls-webpki-roots
|  |- twilight-gateway-queue/rustls-webpki-roots
|  `- tokio-tunstenite/rustls-tls
|
|- zlib-simd
|  |- compression
|  `- flate2/zlib-ng-compat
|
`- zlib-stock
   |- compression
   `- flate2/zlib
gateway-queue 
|- default
|  `- rustls
|
|- native
|  `- twilight-http/native
|
|- rustls
|  `- rustls-native-roots
|     `- twilight-http/rustls-native-roots
|
`- rustls-webpki-roots
   `- twilight-http/rustls-webpki-roots
http 
|- default
|  `- rustls
|
|- native
|  `- hyper-tls
|
|- rustls
|  `- rustls-native-roots
|     `- hyper-rustls/native-tokio
|
`- rustls-webpki-roots
   `- hyper-rustls/webpki-tokio
lavalink 
|- default
|  |- http-support
|  `- rustls
|
|- http-support
|  |- http
|  `- percent-encoding
|
|- native
|  `- tokio-tungstenite/native-tls
|
`- rustls
   `- tokio-tungstenite/rustls-tls

My only thought is that we can collapse gateway, gateway-queue and http's rustls feature down to rustls-native-roots, but I'm not sure how worth it this is to break people's feature sets, if all it does is simply things for us. Besides that, I can't think of anything else to make consistent, and if there's no discussion, I'll go ahead and close this issue in a few days.

@7596ff
Copy link
Contributor Author

7596ff commented May 27, 2021

Another thing I just thought of: we could prefix rustls and native with tls-, similar to zlib features' namespacing.

@7596ff
Copy link
Contributor Author

7596ff commented Jun 7, 2021

A few days turned into 11, but if no one else has comments, I'll close this in 3 days.

7596ff pushed a commit to 7596ff/twilight that referenced this issue Jun 7, 2021
@zeylahellyer @7596ff
enhancement!(gateway): rename zlib features (twilight-rs#829)
583d788 
Rename the two zlib features - `stock-zlib` and `simd-zlib` - for
consistency with other feature flags. These have been renamed to
`zlib-stock` and `zlib-simd` to properly namespace the feature flags.

Closes twilight-rs#717.

BREAKING CHANGES: The gateway's `stock-zlib` and `simd-zlib` feature
flags have been renamed to `zlib-stock` and `zlib-simd`, respectively.
@zeylahellyer
Copy link
Member

Another thing I just thought of: we could prefix rustls and native with tls-, similar to zlib features' namespacing.

I'd be for this

7596ff pushed a commit to 7596ff/twilight that referenced this issue Jun 13, 2021
@zeylahellyer @7596ff
enhancement!(gateway): rename zlib features (twilight-rs#829)
dfc505e 
Rename the two zlib features - `stock-zlib` and `simd-zlib` - for
consistency with other feature flags. These have been renamed to
`zlib-stock` and `zlib-simd` to properly namespace the feature flags.

Closes twilight-rs#717.

BREAKING CHANGES: The gateway's `stock-zlib` and `simd-zlib` feature
flags have been renamed to `zlib-stock` and `zlib-simd`, respectively.
7596ff pushed a commit to 7596ff/twilight that referenced this issue Jun 13, 2021
@zeylahellyer @7596ff
enhancement!(gateway): rename zlib features (twilight-rs#829)
b22fcfb 
Rename the two zlib features - `stock-zlib` and `simd-zlib` - for
consistency with other feature flags. These have been renamed to
`zlib-stock` and `zlib-simd` to properly namespace the feature flags.

Closes twilight-rs#717.

BREAKING CHANGES: The gateway's `stock-zlib` and `simd-zlib` feature
flags have been renamed to `zlib-stock` and `zlib-simd`, respectively.
@7596ff 7596ff closed this as completed in af58b94 Jun 13, 2021
@7596ff 7596ff reopened this Jun 13, 2021
@7596ff 7596ff closed this as completed Jun 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c-all Affects all crates or the project as a whole m-breaking change Breaks the public API.
Projects
None yet
Milestone
0.5
Development

No branches or pull requests
2 participants
@7596ff @zeylahellyer