[Spice-devel] [PATCH spice-server] spice-char: Add some documentation to SpiceCharDeviceInterface

[Christophe de Dinechin]

Thank you for that. Looks good after two minor grammatical fixes.

> On 22 Mar 2018, at 11:12, Frediano Ziglio <fziglio at redhat.com> wrote:
> 
> Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> ---
> server/spice-char.h | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
> 
> diff --git a/server/spice-char.h b/server/spice-char.h
> index 1a8a031d..4d780eb7 100644
> --- a/server/spice-char.h
> +++ b/server/spice-char.h
> @@ -40,9 +40,30 @@ typedef enum {
> struct SpiceCharDeviceInterface {
>     SpiceBaseInterface base;
> 
> +    /* Set the state of the device.
> +     * connected should be 0 or 1.
> +     * Setting state to 0 cause the device to be disabled.

Maybe document uses cases for that function?

Why does the function return a void? Can’t fail? Can you always change the state? (Does not look like an open/close to me)

> +     */
>     void (*state)(SpiceCharDeviceInstance *sin, int connected);
> +
> +    /* Write some bytes to the character device.
> +     * Returns bytes copied from buf or a value < 0 on errors.
> +     * Function can return a value < len, even 0.
> +     * errno is not determined after calling this function.
> +     * Function should be implemented as no-blocking.
> +     * A len < 0 cause indeterminate results.

cause -> causes

I suspect this is not an atomic operation, so you may have written some stuff even if the result is < 0?


> +     */
>     int (*write)(SpiceCharDeviceInstance *sin, const uint8_t *buf, int len);
> +
> +    /* Read some bytes from the character device.
> +     * Returns bytes copied into buf or a value < 0 on errors.
> +     * Function can return 0 if no data is available or len is 0.
> +     * errno is not determined after calling this function.
> +     * Function should be implemented as no-blocking.
> +     * A len < 0 cause indeterminate results.

cause -> causes

> +     */
>     int (*read)(SpiceCharDeviceInstance *sin, uint8_t *buf, int len);
> +
>     void (*event)(SpiceCharDeviceInstance *sin, uint8_t event);
>     spice_char_device_flags flags;
> };
> -- 
> 2.14.3
> 
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel