Re: [PATCH v2] documentation: untrue statement in GetVersion() method description
On Thu, Sep 12, 2024 at 03:26:27PM +0200, Stepan Zobal wrote:
In the end of virConnectGetVersion() description there is written:
"not with a Read-Only connection"
which isn't true after I tried virConnectOpenReadOnly() with virConnectGetVersion()
and it clearly shows the version correctly.
Some details useful for future contributions:
- Many projects usually don't use very long lines, most clients wrap the
commit message similarly to an e-mail.
- Use the subject to say what the patch does, not what you have found,
i.e. use "Fix a bug with blahblah" and "Remove unused parameter"
rather than "a bug with blahblah" and "unused parameter".
- Work in suggestions from previous reviews, they might include commit
message suggestions too.
I tweaked the commit message and pushed it now
Reviewed-by: Martin Kletzander <mkletzan(a)redhat.com>
Signed-off-by: Stepan Zobal <szobal(a)redhat.com>
---
Removed another unnecessary comment about virConnectGetVersion() method.
Nice that you mentioned it in the notes, but it won't get included in
the commit message. Good for diffs between versions, not for
adjustments of the commit message itself.
Thanks for your first libvirt contribution!!!
src/libvirt-host.c | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/src/libvirt-host.c b/src/libvirt-host.c
index e67b36812e..b3a6421a7f 100644
--- a/src/libvirt-host.c
+++ b/src/libvirt-host.c
@@ -179,9 +179,7 @@ virConnectGetType(virConnectPtr conn)
* @conn: pointer to the hypervisor connection
* @hvVer: return value for the version of the running hypervisor (OUT)
*
- * Get the version level of the Hypervisor running. This may work only with
- * hypervisor call, i.e. with privileged access to the hypervisor, not
- * with a Read-Only connection.
+ * Get the version level of the Hypervisor running.
*
* Returns -1 in case of error, 0 otherwise. if the version can't be
* extracted by lack of capacities returns 0 and @hvVer is 0, otherwise
--
2.46.0
Attachments:
- signature.asc (application/pgp-signature — 833 bytes)