xen/public: Correct the HYPERVISOR_dm_op() documentation to match reality
authorAndrew Cooper <andrew.cooper3@citrix.com>
Thu, 1 Jun 2017 13:09:30 +0000 (14:09 +0100)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Fri, 2 Jun 2017 10:26:37 +0000 (11:26 +0100)
The number of buffers is ahead of the buffer list in the argument list.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
Release-acked-by: Julien Grall <julien.grall@arm.com>
xen/include/public/hvm/dm_op.h

index 20c21b6e2a97d6b5643bd5baab0220e9fc27afcc..2a4c3d938d5aa1f1fd487737506b5394bcd419d6 100644 (file)
@@ -391,17 +391,17 @@ DEFINE_XEN_GUEST_HANDLE(xen_dm_op_buf_t);
 
 /* ` enum neg_errnoval
  * ` HYPERVISOR_dm_op(domid_t domid,
- * `                  xen_dm_op_buf_t bufs[],
- * `                  unsigned int nr_bufs)
+ * `                  unsigned int nr_bufs,
+ * `                  xen_dm_op_buf_t bufs[])
  * `
  *
  * @domid is the domain the hypercall operates on.
+ * @nr_bufs is the number of buffers in the @bufs array.
  * @bufs points to an array of buffers where @bufs[0] contains a struct
  * xen_dm_op, describing the specific device model operation and its
  * parameters.
  * @bufs[1..] may be referenced in the parameters for the purposes of
  * passing extra information to or from the domain.
- * @nr_bufs is the number of buffers in the @bufs array.
  */
 
 #endif /* __XEN_PUBLIC_HVM_DM_OP_H__ */