[libvirt] [PATCH v2 1/2] qemu: Fix "boolen" typo in API doc

This also adjusts the argument name which should be 'isListen' in both cases rather than 'listen'. Signed-off-by: Christophe Fergeau <cfergeau@redhat.com> --- Changes since v1: - really fix 'boolen' typo src/qemu/qemu_command.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index f81d20e5f7..82675c5d4e 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -876,7 +876,7 @@ qemuBuildRBDSecinfoURI(virBufferPtr buf, /* qemuBuildTLSx509BackendProps: * @tlspath: path to the TLS credentials - * @listen: boolen listen for client or server setting + * @isListen: boolean listen for client or server setting * @verifypeer: boolean to enable peer verification (form of authorization) * @alias: alias for the TLS credentials object * @secalias: if one exists, the alias of the security object for passwordid @@ -917,7 +917,7 @@ qemuBuildTLSx509BackendProps(const char *tlspath, /* qemuBuildTLSx509CommandLine: * @cmd: Pointer to command * @tlspath: path to the TLS credentials - * @listen: boolen listen for client or server setting + * @isListen: boolean listen for client or server setting * @verifypeer: boolean to enable peer verification (form of authorization) * @certEncSecretAlias: alias of a 'secret' object for decrypting TLS private key * (optional) -- 2.21.0

There are 2 examples of use of <encryption> which uses a 'type' attribute rather than 'format' as documented in the XML schema: <define name='encryption'> <element name='encryption'> <attribute name='format'> <choice> <value>default</value> <value>qcow</value> <value>luks</value> </choice> </attribute> <interleave> <ref name='secret'/> <optional> <element name='cipher'> <ref name='keycipher'/> </element> <element name='ivgen'> <ref name='keyivgen'/> </element> </optional> </interleave> </element> </define> This also matches what virStorageEncryptionParseNode() is doing. Signed-off-by: Christophe Fergeau <cfergeau@redhat.com> --- docs/formatdomain.html.in | 2 +- docs/formatstorage.html.in | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 0e3799061d..4052eb2528 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -2761,7 +2761,7 @@ <write_iops_sec>100000</write_iops_sec> </iotune> <boot order='2'/> - <encryption type='...'> + <encryption format='...'> ... </encryption> <shareable/> diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 2a7604d136..dd2f27e54c 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -761,7 +761,7 @@ <mtime>1341930622.047245868</mtime> <ctime>1341930622.047245868</ctime> </timestamps> - <encryption type='...'> + <encryption format='...'> ... </encryption> <compat>1.1</compat> -- 2.21.0

On Wed, Mar 27, 2019 at 12:21:25PM +0100, Christophe Fergeau wrote:
There are 2 examples of use of <encryption> which uses a 'type' attribute rather than 'format' as documented in the XML schema:
<define name='encryption'> <element name='encryption'> <attribute name='format'> <choice> <value>default</value> <value>qcow</value> <value>luks</value> </choice> </attribute> <interleave> <ref name='secret'/> <optional> <element name='cipher'> <ref name='keycipher'/> </element> <element name='ivgen'> <ref name='keyivgen'/> </element> </optional> </interleave> </element> </define>
This also matches what virStorageEncryptionParseNode() is doing.
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com> --- docs/formatdomain.html.in | 2 +- docs/formatstorage.html.in | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
Reviewed-by: Ján Tomko <jtomko@redhat.com> Jano

Please use --cover-letter for series with two or more patches for neater alignment of e-mails. On Wed, Mar 27, 2019 at 12:21:24PM +0100, Christophe Fergeau wrote:
This also adjusts the argument name which should be 'isListen' in both cases rather than 'listen'.
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com> --- Changes since v1: - really fix 'boolen' typo
src/qemu/qemu_command.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index f81d20e5f7..82675c5d4e 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -876,7 +876,7 @@ qemuBuildRBDSecinfoURI(virBufferPtr buf,
/* qemuBuildTLSx509BackendProps: * @tlspath: path to the TLS credentials - * @listen: boolen listen for client or server setting + * @isListen: boolean listen for client or server setting
Both the rename and the typo fix could be qualified as trivial. However the description does not make much sense to me.
* @verifypeer: boolean to enable peer verification (form of authorization)
peer verification is also used for authentication, as of commit 441d3eb6d1be940a67ce45a286602a967601b157 (tag: CVE-2017-1000256) Jano
* @alias: alias for the TLS credentials object * @secalias: if one exists, the alias of the security object for passwordid @@ -917,7 +917,7 @@ qemuBuildTLSx509BackendProps(const char *tlspath, /* qemuBuildTLSx509CommandLine: * @cmd: Pointer to command * @tlspath: path to the TLS credentials - * @listen: boolen listen for client or server setting + * @isListen: boolean listen for client or server setting * @verifypeer: boolean to enable peer verification (form of authorization) * @certEncSecretAlias: alias of a 'secret' object for decrypting TLS private key * (optional) -- 2.21.0
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list

Hey, On Wed, Mar 27, 2019 at 01:32:44PM +0100, Ján Tomko wrote:
Please use --cover-letter for series with two or more patches for neater alignment of e-mails.
On Wed, Mar 27, 2019 at 12:21:24PM +0100, Christophe Fergeau wrote:
This also adjusts the argument name which should be 'isListen' in both cases rather than 'listen'.
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com> --- Changes since v1: - really fix 'boolen' typo
src/qemu/qemu_command.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index f81d20e5f7..82675c5d4e 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -876,7 +876,7 @@ qemuBuildRBDSecinfoURI(virBufferPtr buf,
/* qemuBuildTLSx509BackendProps: * @tlspath: path to the TLS credentials - * @listen: boolen listen for client or server setting + * @isListen: boolean listen for client or server setting
Both the rename and the typo fix could be qualified as trivial. However the description does not make much sense to me.
To me neither. Maybe this? * @isListen: boolean indicating if this is a client or server TLS credentials
* @verifypeer: boolean to enable peer verification (form of authorization)
peer verification is also used for authentication, as of commit 441d3eb6d1be940a67ce45a286602a967601b157 (tag: CVE-2017-1000256)
Just need to append /authentication to the end? * @verifypeer: boolean to enable peer verification (form of authorization/authentication) Christophe
participants (2)
-
Christophe Fergeau
-
Ján Tomko