[PATCH] Documentation for the prepare_lock_surface event description, is incorrect

[Bryce Harrington]

On Thu, Jul 09, 2015 at 01:46:46PM -0400, Christopher Michael wrote:
> Here is an updated patch which changes the wording to match what
> Giulio offered.
> 
> Documentation for the prepare_lock_surface event description is
> incorrect. The summary says "Tell the client..." however the full-text
> description says "tell the shell..."
> 
> Signed-off-by: Chris Michael <cp.michael at samsung.com>
> ---
>  protocol/desktop-shell.xml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/protocol/desktop-shell.xml b/protocol/desktop-shell.xml
> index fb0b748..6ec9dfa 100644
> --- a/protocol/desktop-shell.xml
> +++ b/protocol/desktop-shell.xml
> @@ -44,7 +44,7 @@
> 
>      <event name="prepare_lock_surface">
>        <description summary="tell the client to create, set the lock
> surface">
> -	Tell the shell we want it to create and set the lock surface, which is
> +	Tell the client we want it to create and set the lock surface, which is
>  	a GUI asking the user to unlock the screen. The lock surface is
>  	announced with 'set_lock_surface'. Whether or not the shell actually

This second instance of 'shell' I believe should also be made 'client'
for consistency.

Bryce

>  	implements locking, it MUST send 'unlock' request to let the normal
> -- 
> 2.4.4
> 
> 
> 
> On 07/09/2015 01:34 PM, Christopher Michael wrote:
> >On 07/09/2015 01:33 PM, Giulio Camuffo wrote:
> >>2015-07-09 20:12 GMT+03:00 Jasper St. Pierre <jstpierre at mecheye.net>:
> >>>The shell is a client. Both are technically correct, but I'm fine with
> >>>this change if it makes things easier to read. We do use the terms
> >>>"shell" and "client" way too much. :)
> >>
> >>Imho this makes it a bit harder to read, as shell can mean either the
> >>client or the shell code in the compositor, while client is just that.
> >>
> >
> >If preferred, I can change the patch to fix the actual full-text
> >description instead. Currently, the summary line says 'client' and the
> >full-text says shell.
> >
> >>>
> >>>On Thu, Jul 9, 2015 at 10:07 AM, Christopher Michael
> >>><cpmichael at osg.samsung.com> wrote:
> >>>>Documentation for the prepare_lock_surface event description
> >>>>  is incorrect as it says to "tell the client to create..." however
> >>>>it is
> >>>>  actually the shell which creates the lock surface.
> >>>>
> >>>>
> >>>>Signed-off-by: Chris Michael <cp.michael at samsung.com>
> >>>>---
> >>>>  protocol/desktop-shell.xml | 2 +-
> >>>>  1 file changed, 1 insertion(+), 1 deletion(-)
> >>>>
> >>>>diff --git a/protocol/desktop-shell.xml b/protocol/desktop-shell.xml
> >>>>index fb0b748..147e50d 100644
> >>>>--- a/protocol/desktop-shell.xml
> >>>>+++ b/protocol/desktop-shell.xml
> >>>>@@ -43,7 +43,7 @@
> >>>>      </event>
> >>>>
> >>>>      <event name="prepare_lock_surface">
> >>>>-      <description summary="tell the client to create, set the lock
> >>>>surface">
> >>>>+      <description summary="tell the shell to create, set the lock
> >>>>surface">
> >>>>         Tell the shell we want it to create and set the lock
> >>>>surface, which
> >>>>is
> >>>>         a GUI asking the user to unlock the screen. The lock
> >>>>surface is
> >>>>         announced with 'set_lock_surface'. Whether or not the shell
> >>>>actually
> >>>>--
> >>>>2.4.4
> >>>>_______________________________________________
> >>>>wayland-devel mailing list
> >>>>wayland-devel at lists.freedesktop.org
> >>>>http://lists.freedesktop.org/mailman/listinfo/wayland-devel
> >>>
> >>>
> >>>
> >>>--
> >>>   Jasper
> >>>_______________________________________________
> >>>wayland-devel mailing list
> >>>wayland-devel at lists.freedesktop.org
> >>>http://lists.freedesktop.org/mailman/listinfo/wayland-devel
> >
> >_______________________________________________
> >wayland-devel mailing list
> >wayland-devel at lists.freedesktop.org
> >http://lists.freedesktop.org/mailman/listinfo/wayland-devel
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel