Message ID | 20230619171437.357374-3-alex.bennee@linaro.org |
---|---|
State | New |
Headers | show |
Series | docs/devel: improve API documentation for QOM | expand |
On 19/6/23 19:14, Alex Bennée wrote: > Mention that QOM-ified devices already have support for registering > the description. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> > --- > include/migration/vmstate.h | 9 ++++++++- > 1 file changed, 8 insertions(+), 1 deletion(-) Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
On 6/19/23 19:14, Alex Bennée wrote: > Mention that QOM-ified devices already have support for registering > the description. > > Signed-off-by: Alex Bennée<alex.bennee@linaro.org> > --- > include/migration/vmstate.h | 9 ++++++++- > 1 file changed, 8 insertions(+), 1 deletion(-) Reviewed-by: Richard Henderson <richard.henderson@linaro.org> r~
On Mon, Jun 19, 2023 at 06:14:34PM +0100, Alex Bennée wrote: > Mention that QOM-ified devices already have support for registering > the description. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Acked-by: Peter Xu <peterx@redhat.com>
Alex Bennée <alex.bennee@linaro.org> wrote: > Mention that QOM-ified devices already have support for registering > the description. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Juan Quintela <quintela@redhat.com> I really remove that function in a future series (well, I substitute it with vmstate_register_id() and vmstate_register_any(), but the comment applies to the new versions also). Later, Juan.
diff --git a/include/migration/vmstate.h b/include/migration/vmstate.h index 084f5e784a..35579b2c1f 100644 --- a/include/migration/vmstate.h +++ b/include/migration/vmstate.h @@ -1209,7 +1209,14 @@ int vmstate_register_with_alias_id(VMStateIf *obj, uint32_t instance_id, int required_for_version, Error **errp); -/* Returns: 0 on success, -1 on failure */ +/** + * vmstate_register() - legacy function to register state serialisation description + * + * New code shouldn't be using this function as QOM-ified devices have + * dc->vmsd to store the serialisation description. + * + * Returns: 0 on success, -1 on failure + */ static inline int vmstate_register(VMStateIf *obj, int instance_id, const VMStateDescription *vmsd, void *opaque)
Mention that QOM-ified devices already have support for registering the description. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> --- include/migration/vmstate.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-)