From: Andrea Bolognani <abologna@redhat.com>
Date: Thu, 3 Feb 2022 18:17:24 +0000 (+0100)
Subject: conf: Fix documentation for virDomainDefGetShortName()
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=5c0125b4f8f3a9ca13d345225108d2023d3c44df;p=libvirt.git

conf: Fix documentation for virDomainDefGetShortName()

The @unique argument didn't exist even when the function was
introduced in a042275a396e, and the @vm argument was not renamed
when the function was changed to take a virDomainDef* instead of
a virDomainObj* in 7ed6934f3b92.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
---

diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c
index 467f708350..d66496c9b7 100644
--- a/src/conf/domain_conf.c
+++ b/src/conf/domain_conf.c
@@ -30086,8 +30086,7 @@ virDomainDefHasMemballoon(const virDomainDef *def)
 
 /**
  * virDomainDefGetShortName:
- * @vm: Machine for which to get a name
- * @unique: Make sure the name is unique (use id as well)
+ * @def: domain definition
  *
  * Shorten domain name to avoid possible path length limitations.
  */