]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
doc: restrict virDomain{Attach,Detach}Device to active domains
authorJim Fehlig <jfehlig@novell.com>
Thu, 14 Jan 2010 01:24:51 +0000 (18:24 -0700)
committerJim Fehlig <jfehlig@novell.com>
Mon, 8 Feb 2010 17:28:21 +0000 (10:28 -0700)
virDomain{Attach,Detach}Device is now only permitted on active
domains.  Explicitly state this restriction in the API
documentation.

V2: Only change doc, dropping the hunk that forced the restriction
    in libvirt frontend.

src/libvirt.c

index 8a9ee20ddf70c039044238ec25b06d9b411f4ac5..292ca2164b02c705df23e22377e8abcc1b678627 100644 (file)
@@ -5121,7 +5121,8 @@ error:
  * @domain: pointer to domain object
  * @xml: pointer to XML description of one device
  *
- * Create a virtual device attachment to backend.
+ * Create a virtual device attachment to backend.  This function,
+ * having hotplug semantics, is only allowed on an active domain.
  *
  * Returns 0 in case of success, -1 in case of failure.
  */
@@ -5164,7 +5165,8 @@ error:
  * @domain: pointer to domain object
  * @xml: pointer to XML description of one device
  *
- * Destroy a virtual device attachment to backend.
+ * Destroy a virtual device attachment to backend.  This function,
+ * having hot-unplug semantics, is only allowed on an active domain.
  *
  * Returns 0 in case of success, -1 in case of failure.
  */