[libvirt] [PATCH 2/3] Consolidate documentation of virDomainMigrate{, ToURI}{, 2, 3}

[Peter Krempa]

On Fri, Nov 25, 2016 at 11:51:42 +0100, Jiri Denemark wrote:
> Only the latest APIs are fully documented and the documentation of the
> older variants (which are just limited versions of the new APIs anyway)
> points to the newest APIs.
> 
> Signed-off-by: Jiri Denemark <jdenemar at redhat.com>
> ---
>  src/libvirt-domain.c | 348 ++++++---------------------------------------------
>  1 file changed, 36 insertions(+), 312 deletions(-)
> 
> diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
> index f9f5a4696..e0c69dbe7 100644
> --- a/src/libvirt-domain.c
> +++ b/src/libvirt-domain.c

[...]

> @@ -3984,19 +3837,6 @@ virDomainMigrate2(virDomainPtr domain,

This hunk corresponds to virDomainMigrate3 documentation ... 

>   * VIR_MIGRATE_TUNNELLED and VIR_MIGRATE_PEER2PEER are not supported by this
>   * API, use virDomainMigrateToURI3 instead.
>   *
> - * If you want to copy non-shared storage within migration you
> - * can use either VIR_MIGRATE_NON_SHARED_DISK or
> - * VIR_MIGRATE_NON_SHARED_INC as they are mutually exclusive.
> - *
> - * Users should note that implementation of VIR_MIGRATE_OFFLINE
> - * flag in some drivers does not copy storage or any other file
> - * based storage (e.g. UEFI variable storage).
> - *
> - * Enabling the VIR_MIGRATE_POSTCOPY flag tells libvirt to enable post-copy
> - * migration.  Use virDomainMigrateStartPostCopy to switch migration into
> - * the post-copy mode.  See virDomainMigrateStartPostCopy for more details
> - * about post-copy.
> - *
>   * There are many limitations on migration imposed by the underlying
>   * technology - for example it may not be possible to migrate between
>   * different processors even with the same architecture, or between

The deletion of the stuff above is okay, but the function docs miss the
same pointer to the fully documented function. Looks like this was a
pre-existing problem but you could fix it with this patch.

ACK with the above tweak. Safe for freeze.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20161129/be65b5d0/attachment-0001.sig>