cargo publish with cargo.toml on windows doesn't normalize the content

[epage]

Problem

On case insensitive filesystems (which can include Windows and Mac), cargo allows cargo.toml to be used. When publishing, the case doesn't get normalize and we miss it when normalizing the content of the file (prepare_for_publish).

Once published

• crates.io won't be able to process the file
• the crate is unusable on systems with case-sensitive filesystems
• behavior might be off or flat out broken without normalization (e.g. workspace inheritance)

Steps

$ cargo new foo
$ cd foo
$ cargo package --list --allow-dirty
Cargo.lock
Cargo.toml
Cargo.toml.orig
src/main.rs
$ move Cargo.toml t
$ move t cargo.toml
$ cargo package --list --allow-dirty
Cargo.lock
Cargo.toml
src/main.rs

Note the lack of Cargo.toml.orig

Possible Solution(s)

Long term, I'd prefer we error, suggesting a rename if cargo.toml exists

To help people transition, we should warn first.

Alternatively

• we could normalize the file name
• we could detect this and error when loading manifests

Notes

See also

• Projects created on Windows with "cargo.toml" fail to run on Linux #11962
• Allow cargo.toml #45
• https://rust-lang.zulipchat.com/#narrow/stream/318791-t-crates-io/topic/broken.20crate.20files
• https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/.60cargo.2Etoml.60.20on.20case.20insensitive.20filesystems

Version

No response

[epage]

Based on the zulip conversation, a generally accepted path forward would be to normalize on publish. Doing that does not preclude us from other solution alternatices in the future.