Re: [pve-devel] [RFC qemu-server v3 17/22] parse config: allow config keys with minus sign

[Fiona Ebner <f.ebner@proxmox.com>]

Am 11.04.24 um 19:50 schrieb Thomas Lamprecht:
> On 11/04/2024 11:29, Fiona Ebner wrote:
>> In preparation for the upcoming 'fleecing-images' key. To avoid mixing
>> of options with - and options with _, which is not very user-friendly,
>> it would be nice to add aliases for existing options with _. And
>> long-term, backup restore handlers could switch to the modern keys
>> with -.
> 
> a long-term way out could be to switch all formats over to using
> kebab-case and normalize through s/_/- here.
> 
> Writing that out again naturally need either checking if all nodes
> support the new format already actively, or adding support to it
> in a minor release now and then enable it on a major release.
> 
> All churn, but so is having an format mess.
> 
> I ponder about doing something like this for the API, but for endpoints
> not being backed by a config (schema) it would be less problematic
> w.r.t. accepting both variants for a while, but API docs showing only
> the new one and then making warnings noisier over the time of a full
> major release..
> 
> Anyhow, this on it's own would be fine by me, but in any case we
> should at least document why the formats are mixed would be good, users
> can be confused by it, and cannot know that most of the "bad" options
> isn't the fault from the devs currently mainly working on PVE.

Where would be a good place for this? In the appendix for the CLI in the
admin guide? What exactly is the reason, just that the underscore was
preferred when the project started out?

Or should I re-spin naming the option "fleecing_images"?