Re: [PATCH v3] machine: add missing doc for memory-backend option

From: Michal Privoznik <mprivozn@redhat.com>
To: Igor Mammedov <imammedo@redhat.com>, qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, pkrempa@redhat.com, pbonzini@redhat.com
Subject: Re: [PATCH v3] machine: add missing doc for memory-backend option
Date: Wed, 27 Jan 2021 11:40:45 +0100	[thread overview]
Message-ID: <5786708e-002c-f919-5586-d8d09d40bb0f@redhat.com> (raw)
In-Reply-To: <20210121161504.1007247-1-imammedo@redhat.com>

On 1/21/21 5:15 PM, Igor Mammedov wrote:
> Add documentation for '-machine memory-backend' CLI option and
> how to use it.
> 
> And document that x-use-canonical-path-for-ramblock-id,
> is considered to be stable to make sure it won't go away by accident.
> 
> x- was intended for unstable/iternal properties, and not supposed to
> be stable option. However it's too late to rename (drop x-)
> it as it would mean that users will have to mantain both
> x-use-canonical-path-for-ramblock-id (for QEMU 5.0-5.2) versions
> and prefix-less for later versions.
> 
> Signed-off-by: Igor Mammedov <imammedo@redhat.com>
> ---
> v2:
>   - add doc that x-use-canonical-path-for-ramblock-id is considered stable,
>       (Peter Krempa <pkrempa@redhat.com>)
> v3:
>   - s/x-use-canonical-path-for-ramblock-id=on/x-use-canonical-path-for-ramblock-id=off/
>       (Michal Privoznik <mprivozn@redhat.com>)
>   - add to commit message why x- prefix is preserved
>   - drop clause about x-use-canonical-path-for-ramblock-id being stable
>     from help section, but keep it in code comment above
>     x-use-canonical-path-for-ramblock-id property. It's sufficient
>     to prevent option being changed/removed by accident.
>       (Peter Maydell <peter.maydell@linaro.org>)
> ---
>   backends/hostmem.c | 10 ++++++++++
>   qemu-options.hx    | 26 +++++++++++++++++++++++++-
>   2 files changed, 35 insertions(+), 1 deletion(-)

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Michal