[PATCH 2/7] util: Tiny reword fix in comment

Martin Kletzander posted 7 patches 4 years, 2 months ago
[PATCH 2/7] util: Tiny reword fix in comment
Posted by Martin Kletzander 4 years, 2 months ago
Automatic "Ptr " -> " *" also wreaked havoc in comments.  Fix it and while at it
reword the sentence so it is clear that the object is newly allocated.

Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
---
 src/util/virpolkit.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/util/virpolkit.c b/src/util/virpolkit.c
index e90b3b871d15..86255a96760f 100644
--- a/src/util/virpolkit.c
+++ b/src/util/virpolkit.c
@@ -168,7 +168,7 @@ virPolkitAgentDestroy(virPolkitAgent *agent)
  *
  * Allocate and setup a polkit agent
  *
- * Returns a virCommand *on success and NULL on failure
+ * Returns newly allocated virPolkitAgent * on success and NULL on failure
  */
 virPolkitAgent *
 virPolkitAgentCreate(void)
-- 
2.34.0

Re: [PATCH 2/7] util: Tiny reword fix in comment
Posted by Ján Tomko 4 years, 2 months ago
On a Sunday in 2021, Martin Kletzander wrote:
>Automatic "Ptr " -> " *" also wreaked havoc in comments.  Fix it and while at it
>reword the sentence so it is clear that the object is newly allocated.
>
>Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
>---
> src/util/virpolkit.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano