[Spice-devel] [PATCH spice-gtk] option: deprecate a few esoteric options from --spice group

[Christophe Fergeau]

On Thu, Jun 15, 2017 at 04:13:12PM +0400, marcandre.lureau at redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau at redhat.com>
> 
> I propose to deprecate the options that have very unclear results, or
> that are unimplemented by drivers. They were added for historical
> reasons, mostly to match with spicec options, but aren't
> user-friendly. Some of them could be moved in spicy options or a new
> debug/tune option group. For now, mark them as deprecated so they can
> be removed in a future release.
> 
> Imho, --spice-preferred-compression is a good candidate too, although
> users may be more familiar with this option, at least the 'off' case
> may have a clear impact.
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau at redhat.com>
> ---
>  man/spice-client.pod | 8 ++++----
>  src/spice-option.c   | 8 ++++----
>  2 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/man/spice-client.pod b/man/spice-client.pod
> index 69ea84c..cf22636 100644
> --- a/man/spice-client.pod
> +++ b/man/spice-client.pod
> @@ -60,7 +60,7 @@ record, smartcard, usbredir.
>  
>  =item --spice-disable-effects=<wallpaper,font-smooth,animation,all>
>  
> -Disable guest display effects
> +Disable guest display effects - DEPRECATED
>  
>  This tells the SPICE client that it should attempt to disable some guest
>  features in order to lower bandwidth usage. This requires guest support,
> @@ -74,7 +74,7 @@ can be disabled.
>  
>  =item --spice-color-depth=<16,32>
>  
> -Guest display color depth
> +Guest display color depth - DEPRECATED
>  
>  This tells the SPICE client that it should attempt to force the guest OS
>  color depth. A lower color depth should lower bandwith usage. This requires
> @@ -164,13 +164,13 @@ should be used for smartcard emulation.

--spice-disable-effects/--spice-color-depth should still be supported by
Windows guests, the Windows agent has support for these, but I did not
test whether this had any real effect with win7 or newer.
I'm fine with deprecating the other ones.

Christophe

>  
>  =item --spice-cache-size=<bytes>
>  
> -Image cache size
> +Image cache size - DEPRECATED
>  
>  This option should only be used for testing/debugging.
>  
>  =item --spice-glz-window-size=<bytes>
>  
> -Glz compression history size
> +Glz compression history size - DEPRECATED
>  
>  This option should only be used for testing/debugging.
>  
> diff --git a/src/spice-option.c b/src/spice-option.c
> index c04e978..063f9db 100644
> --- a/src/spice-option.c
> +++ b/src/spice-option.c
> @@ -194,9 +194,9 @@ GOptionGroup* spice_get_option_group(void)
>          { "spice-secure-channels", '\0', 0, G_OPTION_ARG_CALLBACK, parse_secure_channels,
>            N_("Force the specified channels to be secured"), "<main,display,inputs,...,all>" },
>          { "spice-disable-effects", '\0', 0, G_OPTION_ARG_CALLBACK, parse_disable_effects,
> -          N_("Disable guest display effects"), "<wallpaper,font-smooth,animation,all>" },
> +          N_("Disable guest display effects (deprecated)"), "<wallpaper,font-smooth,animation,all>" },
>          { "spice-color-depth", '\0', 0, G_OPTION_ARG_CALLBACK, parse_color_depth,
> -          N_("Guest display color depth"), "<16,32>" },
> +          N_("Guest display color depth (deprecated)"), "<16,32>" },
>          { "spice-ca-file", '\0', 0, G_OPTION_ARG_FILENAME, &ca_file,
>            N_("Truststore file for secure connections"), N_("<file>") },
>          { "spice-host-subject", '\0', 0, G_OPTION_ARG_STRING, &host_subject,
> @@ -219,9 +219,9 @@ GOptionGroup* spice_get_option_group(void)
>          { "spice-usbredir-redirect-on-connect", '\0', 0, G_OPTION_ARG_STRING, &usbredir_redirect_on_connect,
>            N_("Filter selecting USB devices to redirect on connect"), N_("<filter-string>") },
>          { "spice-cache-size", '\0', 0, G_OPTION_ARG_INT, &cache_size,
> -          N_("Image cache size"), N_("<bytes>") },
> +          N_("Image cache size (deprecated)"), N_("<bytes>") },
>          { "spice-glz-window-size", '\0', 0, G_OPTION_ARG_INT, &glz_window_size,
> -          N_("Glz compression history size"), N_("<bytes>") },
> +          N_("Glz compression history size (deprecated)"), N_("<bytes>") },
>          { "spice-shared-dir", '\0', 0, G_OPTION_ARG_FILENAME, &shared_dir,
>            N_("Shared directory"), N_("<dir>") },
>          { "spice-preferred-compression", '\0', 0, G_OPTION_ARG_CALLBACK, parse_preferred_compression,
> -- 
> 2.13.1.395.gf7b71de06
> 
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/spice-devel/attachments/20170615/576d83c6/attachment.sig>