Re: [Qemu-devel] [PATCH] docs/devel/migration.txt: keep functions consistent with the code

[Daniel P. Berrange]

On Tue, Dec 05, 2017 at 07:58:16PM +0000, Dr. David Alan Gilbert wrote:
> * Jay Zhou (address@hidden) wrote:
> > Since the commit 11808bb0c422134bf09119f4aa22c59b0ce84bf3 removed
> > the put_buffer callback and using an iovec based write handler instead,
> > the docs should be sync with the code too.
> > 
> > Signed-off-by: Jay Zhou <address@hidden>
> 
> Lets check with Dan (added to cc) since he wrote 11808bb;
> it might be best just to rever to migration/qemu-file.h for an
> explanation of each function.

The updates look ok, but I tend to think this entire section of
migrate.txt should be deleted, in favour of the inline APIs
docs in mijgration/qemu-file.h   As a developer the header file
is where I would look for this kind of API description. The
migration.txt can just point epople to the header file for API
docs.


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|