[Spice-devel] [qxl] spiceqxl: Improve the Xspice and Xorg configuration option descriptions

[Frediano Ziglio]

> 
> On Mon, Oct 31, 2016 at 09:50:54PM +0100, Francois Gouget wrote:
> > Group the options more logically and improve their descriptions.
> > In the Xorg configuration, always show the default in the
> > commented-out sample.
> > 
> > Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
> > ---
> >  examples/spiceqxl.xorg.conf.example | 166
> >  +++++++++++++++++++-----------------
> >  scripts/Xspice                      |  57 ++++++-------
> >  2 files changed, 117 insertions(+), 106 deletions(-)
> > 
> > diff --git a/scripts/Xspice b/scripts/Xspice
> > index bf8112f..6d1afaf 100755
> > --- a/scripts/Xspice
> > +++ b/scripts/Xspice
> > @@ -59,37 +59,37 @@ parser.add_argument('--xsession', help='If given, will
> > run after Xorg launch.  S
> >  parser.add_argument('--config', default='spiceqxl.xorg.conf')
> >  # Don't use any options that are already used by Xorg (unless we must)
> >  # specifically, don't use -p and -s.
> > -parser.add_argument('--port', type=int, help='standard spice port')
> > +parser.add_argument('--port', type=int, help="Use the specified port as
> > Spice's regular unencrypted port.")
> > +parser.add_argument('--tls-port', type=int, help='Use the specified port
> > as a TLS (encrypted) port.', default=0)
> > +add_boolean('--disable-ticketing', help="Do not require a client
> > password.")
> > +parser.add_argument('--password', help="Set the password required to
> > connect to the server.")
> > +add_boolean('--sasl', help="Use SASL to authenticate to the server.")
> > +parser.add_argument('--x509-dir', help="Set the directory where the CA
> > certificate, server key and server certificate are searched for TLS, using
> > the same predefined names QEMU uses.")
> > +parser.add_argument('--cacert-file', help="Set the CA certificate file
> > location for TLS.")
> > +parser.add_argument('--x509-key-file', help="Set the server key file
> > location for TLS.")
> > +parser.add_argument('--x509-key-password', help="Set the server key's
> > password for TLS.")
> > +parser.add_argument('--x509-cert-file', help="Set the server certificate
> > file location for TLS.")
> > +parser.add_argument('--dh-file', help="Set the server DH file location for
> > TLS.")
> > +parser.add_argument('--tls-ciphers', help="Set the TLS ciphers preference
> > order.")
> > +add_boolean('--ipv4-only')
> > +add_boolean('--ipv6-only')
> 
> No help for these?
> 
> >  parser.add_argument('--exit-on-disconnect', action='store_true',
> >  help='Exit the X server when any client disconnects')
> >  parser.add_argument('--numheads', type=int, help='Number of virtual heads
> >  to create.')
> > -parser.add_argument('--deferred-fps', type=int, help='If given, render to
> > a buffer and send updates only this many times per second')
> > -parser.add_argument('--tls-port', type=int, help='spice tls port',
> > default=0)
> > -add_boolean('--disable-ticketing', help="do not require a client
> > password")
> > -add_boolean('--sasl', help="enable sasl")
> > -parser.add_argument('--x509-dir', help="x509 directory for tls")
> > -parser.add_argument('--cacert-file', help="ca certificate file for tls")
> > -parser.add_argument('--x509-cert-file', help="server certificate file for
> > tls")
> > -parser.add_argument('--x509-key-file', help="server key file for tls")
> > -parser.add_argument('--x509-key-password', help="key file password for
> > tls")
> > -parser.add_argument('--tls-ciphers')
> > -parser.add_argument('--dh-file')
> > -parser.add_argument('--password', help="set password required to connect
> > to server")
> >  parser.add_argument('--image-compression',
> >                      choices = ['off', 'auto_glz', 'auto_lz', 'quic',
> >                                 'glz', 'lz'],
> > -                    help='auto_glz by default')
> > +                    help="Set image compression.")
> >  parser.add_argument('--jpeg-wan-compression',
> >                      choices=wan_compression_options,
> > -                    help='auto by default')
> > +                    help="Set jpeg wan compression.")
> >  parser.add_argument('--zlib-glz-wan-compression',
> >                      choices=wan_compression_options,
> > -                    help='auto by default')
> > +                    help="Set zlib glz wan compression.")
> > +parser.add_argument('--deferred-fps', type=int, help='If non zero, the
> > driver will render all operations to the frame buffer, and keep track of a
> > changed rectangle list. The changed rectangles will be transmitted at the
> > rate requested (e.g. 10 frames per second). This can dramatically reduce
> > network bandwidth for some use cases.')
> >  # TODO - sound support
> >  parser.add_argument('--streaming-video', choices=['off', 'all', 'filter'],
> > -                    help='filter by default')
> > -parser.add_argument('--video-codecs', help="Sets a semicolon-separated
> > list of preferred video codecs to use. Each takes the form encoder:codec,
> > with spice:mjpeg being the default and other options being provided by
> > gstreamer for the mjpeg, vp8 and h264 codecs.")
> > -add_boolean('--ipv4-only')
> > -add_boolean('--ipv6-only')
> > +                    help='Set the streaming video method.')
> > +parser.add_argument('--video-codecs', help='Sets a semicolon-separated
> > list of preferred video codecs to use. Each takes the form encoder:codec,
> > with spice:mjpeg being the default and other options being provided by
> > gstreamer for the mjpeg, vp8 and h264 codecs.')
> >  parser.add_argument('--vdagent', action='store_true',
> >  dest='vdagent_enabled', default=False, help='launch vdagent & vdagentd.
> >  They provide clipboard & resolution automation')
> >  parser.add_argument('--vdagent-virtio-path', help='virtio socket path used
> >  by vdagentd')
> >  parser.add_argument('--vdagent-uinput-path', help='uinput socket path used
> >  by vdagent')
> > @@ -99,7 +99,7 @@ parser.add_argument('--vdagent-exec', help='path to
> > spice-vdagent (used with --v
> >  parser.add_argument('--vdagent-no-launch', default=True,
> >  action='store_false', dest='vdagent_launch', help='do not launch vdagent
> >  & vdagentd, used for debugging or if some external script wants to take
> >  care of that')
> >  parser.add_argument('--vdagent-uid', default=str(os.getuid()), help='set
> >  vdagent user id. changing it makes sense only in conjunction with
> >  --vdagent-no-launch')
> >  parser.add_argument('--vdagent-gid', default=str(os.getgid()), help='set
> >  vdagent group id. changing it makes sense only in conjunction with
> >  --vdagent-no-launch')
> > -parser.add_argument('--audio-fifo-dir', help="set fifo directory for
> > playback audio. designed to work with PulseAudio's module-pipe-sink")
> > +parser.add_argument('--audio-fifo-dir', help="If a directory is given, any
> > file in that directory will be read for audio data to be sent to the
> > client. This is designed to work with PulseAudio's module-pipe-sink.")
> >  

OT: looks like some option helps start with capital and others not.
How is the end result of --help ?

Frediano