Prasanna Kumar Kalever <prasanna.kale...@redhat.com> writes:
> Added documentation describing relation between GlusterServer and
> SocketAddress qapi schemas.
>
> Thanks to Markus Armbruster <arm...@redhat.com>
>
> Signed-off-by: Prasanna Kumar Kalever <prasanna.kale...@redhat.com>
> ---
> qapi/block-core.json | 9 +++++++++
> 1 file changed, 9 insertions(+)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 5e2d7d7..5305562 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -2121,6 +2121,15 @@
> #
> # @tcp: host address and port number
> #
> +# GlusterServer vs. SocketAddress
Suggest:
# This is similar to SocketAddress, only simpler:
> +#
> +# 1. GlusterServer is a flat union, SocketAddress is a simple union.
> +# A flat union is nicer over simple for the reason it avoids
> +# nesting (i.e. more {}) on the wire.
Perhaps "nicer than simple because it"
> +#
> +# 2. GlusterServer lacks case 'fd', since gluster doesn't let you
> +# pass in a file descriptor.
> +#
Suggest:
# GlusterServer is actually not Gluster-specific, and could be
# compatibily evolved into a replacement for SocketAddress.
> # Since: 2.7
> ##
> { 'union': 'GlusterServer',
