[PATCH wayland-web v0] rephrasing the index.html to be more acurate

[Pekka Paalanen]

On Thu, 19 Nov 2015 14:26:14 -0800
Bryce Harrington <bryce at osg.samsung.com> wrote:

> On Thu, Nov 19, 2015 at 06:51:52PM +0100, Benoit Gschwind wrote:
> > Hello,
> > 
> > I tryed to rephrase the index.html to be more acurate. I used Wayland,
> > LibWayland and Weston as wording just because they are my favorite, but it
> > does not match the name of repository.
> > 
> > Note also that I'm not navite english speaker/writer, thus my vocabulary, my
> > syntax and my grammatical skills are limited (just in case it is not 
> > obvious ;) )
> 
> Cool thanks, I can lend a hand a bit on the grammar front, see what you
> think of my copyedits below...
>  
> > Best regards
> > 
> > ---
> >  index.html | 41 ++++++++++++++++++++++++++---------------
> >  1 file changed, 26 insertions(+), 15 deletions(-)
> > 
> > diff --git a/index.html b/index.html
> > index a9ebcaa..aaa4562 100644
> > --- a/index.html
> > +++ b/index.html
> > @@ -12,21 +12,32 @@
> >  
> >  <h2>Wayland</h2>
> >  
> > -<p>Wayland is intended as a simpler replacement for X, easier to develop
> > -and maintain.  GNOME and KDE are expected to be ported to it.</p>
> > -
> > -<p>Wayland is a protocol for a compositor to talk to its clients as
> > -well as a C library implementation of that protocol.  The compositor
> > -can be a standalone display server running on Linux kernel modesetting
> > -and evdev input devices, an X application, or a wayland client itself.
> > -The clients can be traditional applications, X servers (rootless or
> > -fullscreen) or other display servers.</p>
> > -
> > -<p>Part of the Wayland project is also the Weston reference
> > -implementation of a Wayland compositor.  Weston can run as an X client
> > -or under Linux KMS and ships with a few demo clients.  The Weston
> > -compositor is a minimal and fast compositor and is suitable for many
> > -embedded and mobile use cases.  </p>
> 
> (I'm not sure what the right capitalization should be for LibWayland.
> libWayland maybe?  I'm leaving it alone for this review iteration but
> it may need changed.)
> 
> <p>Wayland intends to replace the X11 protocol. The aim is to be easier
> to use, improve on the X11 protocol, and perform better.  GNOME and KDE
> are expected to implement this protocol in their own servers.  The
> Wayland project produces 3 principle components: Wayland, LibWayland and
> Weston.</p>

Hi,

when I talk about libwayland, I spell it as libwayland to follow the
installed file names. By libwayland I refer to the set of libraries
built from the Wayland repository. IOW, I use it as a short for "the
Wayland libraries".

I think libWayland and LibWayland look horrible, we never use
camel-case anywhere.

> <p>Wayland is a protocol for sharing screens and input devices between
> concurent clients.  It defines the way servers and clients talks to each
> other.  The server is reponsible for setting up screens and input
> devices, and for displaying the final images that the user sees on the
> screen.  We term this server a 'compositor'.

Could you add the term "display server" somewhere?

> <p>LibWayland is a reference library that implements the Wayland
> protocol.  This library is intended to help developers implement
> compositors and clients.  This library is split into a client-side part
> and a server-side part.

I wouldn't say libwayland implements the Wayland protocol, clients and
servers need to do that. Libwayland primarily implements the IPC
mechanism and offers a low-level IPC API (for other language bindings)
and C bindings for Wayland protocol.

> <p>Weston is a reference compositor that use LibWayland to talk with its
> clients.  It can run under Linux's Kernel Mode Setting (KMS) as a
> stand-alone compositor, or it can run as X client.  In the later case,
> Weston creates a virtual screen that is drawn in an X window and creates
> virtual input devices taken from the X server; this works similarly to
> Xnest or Xephyr.  Weston also includes a few proof-of-concept clients
> such as weston-flower, weston-gears, and weston-terminal.</p>
> 
> 
> I think we may want another copyedit cycle or two on the above, but see
> what you think of these changes first.

Btw. what was the main reason to start rewording this? Was it to
explain the difference of the protocol and the libraries?
Does the Weston paragraph really need rewriting?

What do we want to communicate better with these changes?


Thanks,
pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 811 bytes
Desc: not available
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20151120/6370f3c7/attachment.sig>