On Wed, Dec 01 2021, Jason Gunthorpe <jgg@xxxxxxxxxx> wrote: > On Wed, Dec 01, 2021 at 01:03:14PM -0700, Alex Williamson wrote: >> But if this document is suggesting the mlx5/QEMU interpretation is the >> only valid interpretations for driver authors, those clarifications >> should be pushed back into the uAPI header. > > Can we go the other way and move more of the uAPI header text here? Where should a userspace author look when they try to implement support for vfio migration? I think we need to answer that question first. Maybe we should separate "these are the rules that an implementation must obey" from "here's a more verbose description of how things work, and how you can arrive at a working implementation". The former would go into the header, while the latter can go into this document. (The generated documentation can be linked from the header file.)
