Rename --pruning and --keep-blocks to be more similar to one another

[wirednkod]

This PR is renaming flags --keep-blocks and --prunning to --blocks-pruning and --state-prunning` accordingly. This makes the flags similar to each other and avoids confusion.

Fixes #11907

polkadot companion: paritytech/polkadot#5863
cumulus companion: paritytech/cumulus#1514

[shawntabrizi]

Is this backwards compatible?

[bkchr]

Is this backwards compatible?

No

[wirednkod]

Is this backwards compatible?

Should it be?

[bkchr]

Yes, sounds like a good idea. We should rename the in code variable and add some alias for the old names.

[kianenigma]

Yes, sounds like a good idea. We should rename the in code variable and add some alias for the old names.

and emit a warning if the old versions are being used about potential deprecation, then in a few months time we can remove the old name entirely.

[bkchr]

I don't think that we can find out if they are being passed. Okay, we could probably do it but it would be very complicated. Clap wouldn't show the alises in the --help. Meaning, the usage probably disappears automatically over time and keeping the alias will also not be that complicated.

[wirednkod]

Yes, sounds like a good idea. We should rename the in code variable and add some alias for the old names.

I added alias in clap instead of renaming the in code variable and it works just fine.
I agree, though, that renaming the variable, even if its a little bit more work, is valid in order not to leave traits of the past.

Now using both aliases the error message informs only for the new one:

➜  substrate ✗ ./target/release/substrate --dev --keep-blocks asfda
error: Invalid value "asfda" for '--blocks-pruning <COUNT>': invalid digit found in string

For more information try --help
➜  substrate ✗ ./target/release/substrate --dev --blocks-pruning asfda
error: Invalid value "asfda" for '--blocks-pruning <COUNT>': invalid digit found in string

[wirednkod]

@bkchr there is a test failing due to this. What can I do for this? Open a new PR in polkadot or... ?

[bkchr]

@bkchr there is a test failing due to this. What can I do for this? Open a new PR in polkadot or... ?

You need to create a companion.

[wirednkod]

@bkchr there is a test failing due to this. What can I do for this? Open a new PR in polkadot or... ?

You need to create a companion.

Done here

[shawntabrizi]

looks reasonable to me!

Thanks for keeping it backwards compatible

[bkchr]

@wirednkod missing cumulus companion.

[wirednkod]

cumulus companion: paritytech/cumulus#1514

Thank you @bkchr

Done here

[bkchr]

bot merge