rust-lang / rust-lang/rustdoc-types

`rustc-hash` feature is non-additive.

Open
#43 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Rust
Stars
44
Forks
20
PR merge metrics
No merged PRs in 30d

Description

cargo features are supposed to be additive, but rustc-hash isn't.

Consider the case where:

  1. Crate a depends on rustdoc-types with default features
    • Crate a relies on the HashMap using the default hasher.
  2. Crate b depends on rustdoc-types with rustc-hash feature.
  3. Crate c depends on a and b
  • Cargo does feature unification, and builds a agains rustdoc-types with rustc-hash enabled.
  • a fails to compile.

Potential fixes

  1. Ignore this, and hope it doesn't effect anyone
  2. Implement our own BuildHasher type that doesn't expose the underlying hashing algo, so changing it is additive
  3. Drop the rustc-hash feature, and always use it.
    3.1. Drop the rustc-hash feature, and never use it.
  4. Make Crate generic over the hasher type.

I think it's fine to go with 1 for now, but I'm filling this issue so I don't forget this.

Originally reported by @noratrieb on fediverse

Caused by #42

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue concerns the rustc-hash Cargo feature and Cargo's feature unification, but it names no source files or tests. Start by tracing how the rustc-hash feature changes the HashMap hasher in rustdoc-types. Done requires choosing and implementing one of the listed approaches while preserving additive feature behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.