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

[Pekka Paalanen]

On Fri, 10 Jul 2015 15:31:03 -0700
Bryce Harrington <bryce at osg.samsung.com> wrote:

> On Fri, Jul 10, 2015 at 09:33:46AM -0400, Christopher Michael wrote:
> > Thanks for the review. I've included an updated patch which fixes
> > the second 'shell' mentioned in the descrption to be 'client'.
> > 
> > 
> > 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>
> Reviewed-by: Bryce Harrington <bryce at osg.samsung.com>

Acked-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>

Thanks,
pq


> > ---
> >  protocol/desktop-shell.xml | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/protocol/desktop-shell.xml b/protocol/desktop-shell.xml
> > index fb0b748..dd81574 100644
> > --- a/protocol/desktop-shell.xml
> > +++ b/protocol/desktop-shell.xml
> > @@ -44,9 +44,9 @@
> > 
> >      <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
> > +	announced with 'set_lock_surface'. Whether or not the client actually
> >  	implements locking, it MUST send 'unlock' request to let the normal
> >          desktop resume.
> >        </description>
> > -- 
> > 2.4.4