Skip to content

Undocumented feature flags #2994

Open
Open
@twilight-flower

Description

@twilight-flower

I just tried to build matrix-sdk as a dependency in my program with the following invocation in cargo.toml:

matrix-sdk = { version = "0.7.0", features = ["e2e-encryption"], default-features = false }

This led to the following error showing up in my terminal, upon attempted cargo run:

error: failed to run custom build command for `matrix-sdk v0.7.0`

Caused by:
  process didn't exit successfully: `C:\Users\Alyssa\Miscellanea\Programming\Rust\matrix-chat-exporter\target\debug\build\matrix-sdk-48c5aca6c0ec4c49\build-script-build` (exit code: 1)
  --- stderr

  ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
  ┃ error: one of the features 'native-tls' or 'rustls-tls' must be enabled ┃
  ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

...which is strange, because neither native-tls nor rustls-tls are listed as settable feature flags on the matrix-sdk crates.io page. So it seems like the documentation there is out-of-date, missing some feature flags which in fact exist (and, moreover, are required for a successful build).

(Adding rustls-tls to the features list, after seeing this error message, let me subsequently compile without further issue; my report is purely of a documentation problem, not of anything wrong on a deeper technical level.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedInterested in working on the project? These are great additions we'd like to have!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions