[libvirt] [PATCH 05/11] conf: Add function description for virDomainDefPostParse

[John Ferlan]

On 9/20/18 1:44 PM, Marc Hartmayer wrote:
> Signed-off-by: Marc Hartmayer <mhartmay at linux.ibm.com>
> Reviewed-by: Boris Fiuczynski <fiuczy at linux.ibm.com>
> ---
>  src/conf/domain_conf.c | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
> index a3f2fcb0a001..3c307d325a89 100644
> --- a/src/conf/domain_conf.c
> +++ b/src/conf/domain_conf.c
> @@ -5215,6 +5215,19 @@ virDomainDefPostParseCheckFailure(virDomainDefPtr def,
>  }
>  
>  
> +/**
> + * virDomainDefPostParse:
> + * @def: domain definition
> + * @caps: driver capabilities object
> + * @parseFlags: virDomainDefParseFlags
> + * @xmlopt: XML parser option object
> + * @parseOpaque: opaque data and it might be NULL (for QEMU driver it's qemuCaps)
> + *
> + * This function does various common and hypervisor specific auto
> + * generation, verification, and validation.

I think this is a good start. I'd really like to see what the
"expectations" are for various @parseFlags. By far one of the more
confusing things. Also while we're at it - @parseOpaque details and/or
assumptions w/r/t whether it should be provided or not.

I also note a few callers use the comment "/* callback to fill driver
specific domain aspects */", so that maybe good to pull in...

John

> + *
> + * Returns 0 on success, -1 on error
> + */
>  int
>  virDomainDefPostParse(virDomainDefPtr def,
>                        virCapsPtr caps,
>