[libvirt] [PATCH 0/3] Better documentation of migration APIs and flags

[Jiri Denemark]

We have 6 public APIs for migration: virDomainMigrate,
virDomainMigrate2, virDomainMigrate3, virDomainMigrateToURI,
virDomainMigrateToURI2, and virDomainMigrateToURI3. Each of them was
documented separately, but the documentation was not consistent. Some
APIs documented individual flags, some didn't do that. Some notes about
specific behavior were not added to all APIs. And so on. Since the newer
versions provide a superset of the functionality of the older ones
mainly adding new parameters, it doesn't really make sense to keep 6
(ideally) almost identical copies of the same documentation.

To get out of this mess this patch set moves documentation of individual
migration flags directly to libvirt-domain.h, where the flags are
defined. And the documentation of virDomainMigrate{,ToURI}{,2} is
reduced to point to the *3 APIs with a description of how old parameters
are mapped to the new ones.

Jiri Denemark (3):
  Enhance documentation of virDomainMigrateFlags
  Consolidate documentation of virDomainMigrate{,ToURI}{,2,3}
  docs: Update news

 docs/news.html.in                |   2 +
 include/libvirt/libvirt-domain.h | 153 ++++++++++++++---
 src/libvirt-domain.c             | 348 ++++-----------------------------------
 3 files changed, 170 insertions(+), 333 deletions(-)

-- 
2.11.0.rc2