search

nabijaczleweli / cargo-update

A cargo subcommand for checking and applying updates to installed executables
MIT License
1.22k stars 42 forks source link

Maybe clarify 'downdate' a bit? #183

Closed HenkPoley closed 2 years ago

HenkPoley commented 2 years ago

"Downdate packages to match newest unyanked registry version." feels a bit.. technical.. Like, if you know what it means, you don't need to read the documentation.

I suppose it is when the current package version is no longer available, and there is no newer version, it will try to downgrade.

nabijaczleweli commented 2 years ago

And your proposed wording is?

By default we only allow updates, -d allows downdates. By default, therefore, a crate needs to be installed if the latest unyanked registry version is greater than the current one, with -d if it's different. If you subtract the trivial default you're left with "Allow downdates to match the latest unyanked version in the registry", which is the same as the manual and usage string.

HenkPoley commented 2 years ago

It is probably "fine". It is just that registry, unyanked and downdate are jargon.

So people who are not into writing package management, and in particular rust cargo packages, will not know these words.

It doesn't tell people what it does, unless they already know what it does.

HenkPoley commented 2 years ago

If I correctly understand what it does (and I am not sure), I would write/prepend it like this:

Allow downgrades if the current or a more recent version is no longer available online. Specifically, allow downdates to match the latest unyanked version in the registry.