conf: Fix documentation for virDomainDefGetShortName()

[libvirt PATCH] conf: Fix documentation for virDomainDefGetShortName()

Andrea Bolognani posted 1 patch 2 years, 2 months ago

Download mbox

Test syntax-check failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20220203182042.429604-1-abologna@redhat.com

src/conf/domain_conf.c | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)

Expand all Fold all

[libvirt PATCH] conf: Fix documentation for virDomainDefGetShortName()

Posted by Andrea Bolognani 2 years, 2 months ago

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>
---
 src/conf/domain_conf.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

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.
  */
-- 
2.34.1

Re: [libvirt PATCH] conf: Fix documentation for virDomainDefGetShortName()

Posted by Martin Kletzander 2 years, 2 months ago

On Thu, Feb 03, 2022 at 07:20:42PM +0100, Andrea Bolognani wrote:
>The @unique argument didn't exist even when the function was
>introduced in a042275a396e, and the @vm argument was not renamed

No need to point fingers, really O:-)

>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>

>---
> src/conf/domain_conf.c | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
>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.
>  */
>-- 
>2.34.1
>