[PATCH wayland-protocols] xdg_shell: add missing <description> tags to the 'state' enum entries

Derek Foreman derekf at osg.samsung.com
Mon Nov 9 09:14:32 PST 2015


On 08/11/15 09:58 PM, Peter Hutterer wrote:
> The scanner parses CDATA in <entry> but lets it disappear otherwise. To have
> descriptive text associated with the <entry>, we need a <description> tag -
> and that must have a summary attribute. The current scanner doesn't handle
> <description> however, so to get the summary printed in the output file we
> still need the summary attribute in the entry tag too.

Kinda gross.  wayland.xml seems to get this wrong all over the place?
(wrt missing summary= in some sections)

Should we be teaching the scanner about <description> to avoid the need
for duplication?

> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>

Reviewed-by: Derek Foreman <derekf at osg.samsung.com>

> ---
>  unstable/xdg-shell/xdg-shell-unstable-v5.xml | 34 +++++++++++++++++-----------
>  1 file changed, 21 insertions(+), 13 deletions(-)
> 
> diff --git a/unstable/xdg-shell/xdg-shell-unstable-v5.xml b/unstable/xdg-shell/xdg-shell-unstable-v5.xml
> index 64346fb..127992b 100644
> --- a/unstable/xdg-shell/xdg-shell-unstable-v5.xml
> +++ b/unstable/xdg-shell/xdg-shell-unstable-v5.xml
> @@ -340,23 +340,31 @@
>          0x1000 - 0x1FFF: GNOME
>        </description>
>        <entry name="maximized" value="1" summary="the surface is maximized">
> -        The surface is maximized. The window geometry specified in the configure
> -        event must be obeyed by the client.
> +	<description summary="the surface is maximized">
> +	  The surface is maximized. The window geometry specified in the configure
> +	  event must be obeyed by the client.
> +	</description>
>        </entry>
>        <entry name="fullscreen" value="2" summary="the surface is fullscreen">
> -        The surface is fullscreen. The window geometry specified in the configure
> -        event must be obeyed by the client.
> +	<description summary="the surface is fullscreen">
> +	  The surface is fullscreen. The window geometry specified in the configure
> +	  event must be obeyed by the client.
> +	</description>
>        </entry>
> -      <entry name="resizing" value="3">
> -        The surface is being resized. The window geometry specified in the
> -        configure event is a maximum; the client cannot resize beyond it.
> -        Clients that have aspect ratio or cell sizing configuration can use
> -        a smaller size, however.
> +      <entry name="resizing" value="3" summary="the surface is being resized">
> +	<description summary="the surface is being resized">
> +	  The surface is being resized. The window geometry specified in the
> +	  configure event is a maximum; the client cannot resize beyond it.
> +	  Clients that have aspect ratio or cell sizing configuration can use
> +	  a smaller size, however.
> +	</description>
>        </entry>
> -      <entry name="activated" value="4">
> -        Client window decorations should be painted as if the window is
> -        active. Do not assume this means that the window actually has
> -        keyboard or pointer focus.
> +      <entry name="activated" value="4" summary="the surface is now activated">
> +	<description summary="the surface is now activated">
> +	  Client window decorations should be painted as if the window is
> +	  active. Do not assume this means that the window actually has
> +	  keyboard or pointer focus.
> +	</description>
>        </entry>
>      </enum>
>  
> 



More information about the wayland-devel mailing list