Re: [Xen-devel] [PATCH for-4.9] docs: fix configuration syntax in xl.cfg manpage

[Julien Grall <julien.grall@xxxxxxx>]

Hi Wei,

On 11/04/17 12:03, Wei Liu wrote:
> No quote is required when a string is provided as part of a spec string.
>
> Reported-by: Doug Freed <dwfreed@xxxxxxx>
> Signed-off-by: Wei Liu <wei.liu2@xxxxxxxxxx>
Documentation will always improve the release :). Unless there is a 
commit moratorium, consider that release-ack is not necessary.
Cheers,

> ---
> Cc: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
> ---
>  docs/man/xl.cfg.pod.5.in | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
> index 616dc093b0..13167ff2b6 100644
> --- a/docs/man/xl.cfg.pod.5.in
> +++ b/docs/man/xl.cfg.pod.5.in
> @@ -27,7 +27,8 @@ A value C<VALUE> is one of:
>
>  =item B<"STRING">
>
> -A string, surrounded by either single or double quotes.
> +A string, surrounded by either single or double quotes. But if the
> +STRING is part of a SPEC_STRING, the quotes should be omitted.
>
>  =item B<NUMBER>
>
> @@ -569,7 +570,7 @@ settings, from the following list:
>  Allow access to the display via the VNC protocol.  This enables the
>  other VNC-related settings.  The default is to enable this.
>
> -=item C<vnclisten="ADDRESS[:DISPLAYNUM]">
> +=item C<vnclisten=ADDRESS[:DISPLAYNUM]>
>
>  Specifies the IP address, and optionally VNC display number, to use.
>
> @@ -589,7 +590,7 @@ vnclisten string.
>  Requests that the VNC display setup search for a free TCP port to use.
>  The actual display used can be accessed with C<xl vncviewer>.
>
> -=item C<vncpasswd="PASSWORD">
> +=item C<vncpasswd=PASSWORD>
>
>  Specifies the password for the VNC server. If password is set to an
>  empty string, authentication on the VNC server will be disabled
> @@ -616,7 +617,7 @@ Enable OpenGL acceleration of the SDL display. Only effects 
> machines
>  using C<device_model_version="qemu-xen-traditional"> and only if the
>  device-model was compiled with OpenGL support. Disabled by default.
>
> -=item C<keymap="LANG">
> +=item C<keymap=LANG>
>
>  Configure the keymap to use for the keyboard associated with this
>  display. If the input method does not easily support raw keycodes
--
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel