search

kornelski / cargo-deb

A cargo subcommand that generates Debian packages from information in Cargo.toml
https://lib.rs/cargo-deb
MIT License
404 stars 48 forks source link

Mention in warnings that README contents are used if description field is missing #99

Open s-burris opened 1 year ago

s-burris commented 1 year ago

In manifest_check_config() in manifest.rs, a warning is displayed if the description is not set in Cargo.toml.

Currently this appears as warning: description field is missing in Cargo.toml but I recommend including info about the usage of README's contents such as: warning: description field is missing in Cargo.toml, using README.md text instead

Why? Non-public codebases may have READMEs that contain information not intended for public consumption. Currently, cargo-deb will include it in deb packages quietly.

Additionally, README.md contents typically appear long and ugly (in e.g. apt info), so I believe a warning is warranted in the case of public codebases as well.