[PATCH] adding some notes for building

[Tiago Vignatti]

On 10/26/2011 12:00 PM, juan.j.zhao at intel.com wrote:
> From: Juan Zhao<juan.j.zhao at intel.com>
>
> Add some notes from building wayland on ubutntu1104
> ---
>   building.html |   35 ++++++++++++++++++++++++++++-------
>   1 files changed, 28 insertions(+), 7 deletions(-)
>
> diff --git a/building.html b/building.html
> index cdded78..e065a6c 100644
> --- a/building.html
> +++ b/building.html
> @@ -91,7 +91,7 @@ Other dependencies are development packages of xcb-dri2 and xcb-xfixes.</p>
>       $ make&amp;&amp; make install
>
>       $ git clone git://anongit.freedesktop.org/xorg/proto/glproto
> -    $ cd macros
> +    $ cd glproto
>       $ ./autogen.sh --prefix=$WLD
>       $ make&amp;&amp; make install
>
> @@ -173,8 +173,9 @@ libudev 136,
>   libdrm 2.4.23,
>   pixman-1,
>   cairo-gl 1.11.3,
> -glib-2.0, and
> -gobject-2.0.
> +glib-2.0,
> +gobject-2.0 and
> +libjpeg-turbo 1.1.1.
>   And optionally, for the pdf viewer:
>   poppler-glib and
>   gio-2.0.</p>
> @@ -187,17 +188,29 @@ gio-2.0.</p>
>   </pre>
>
>   <p>If DISPLAY is set, the wayland compositor will run under X in a
> -window and take input from X.  Otherwise it will run on the KMS
> -framebuffer and take input from evdev devices.  Pick a background
> +window and take input from X. Otherwise it will run on the KMS
> +framebuffer and take input from evdev devices. You should also set
> +EGL_PLATFORM and XDG_RUNTIME_DIR.</p>
> +<pre>     $ unset DISPLAY;export EGL_PLATFORM=drm         # Using drm backend for compositor
> +    $ export DISPLAY=:0.0;export EGL_PLATFORM=X11   # Using X11 backend for compositor
> +    $ export XDG_RUNTIME_DIR=$WLD/bin               # Using one DIR for the session connection between the server and client
> +</pre>
> +<p>Pick a background
>   image that you like and copy it to the Wayland source directory as
>   background.jpg or use the -b command line option:</p>
>
> -<pre>     $ ./compositor -b my-image.jpg
> +<pre>     $ ./wayland-compositor -b my-image.jpg
>   </pre>
>
>   <p>To run clients, switch to a different VT and run the client from
>   there.  Or run it under X and start up the clients from a terminal
> -window.  There are a few demo clients available, but they are all
> +window. Before runing it, you should set up the XDG_RUNTIME_DIR. You can

typo: running


> +also copy the client to the same place of the server's XDG_RUNTIME_DIR.</p>
> +
> +<pre>     $ export XDG_RUNTIME_DIR=$WLD/bin    # the same dir as the server side
> +</pre>
> +
> +<p>There are a few demo clients available, but they are all
>   pretty simple and mostly for testing specific features in the wayland
>   protocol:</p>
>
> @@ -226,6 +239,14 @@ EGL_LOG_LEVEL=debug
>   LIBGL_DEBUG=verbose
>   WAYLAND_DEBUG=1
>   </pre>
> +<p>In some platforms you may meet such problems:</p>
> +<pre>
> +failed to open xxxx/lib/dri/i915_dri.so: xxxx/lib/dri/i915_dri.so: undefined symbol: _glapi_Dispatch
> +</pre>
> +<p>This symbol is in libglapi.so. The glapi library is not loaded dynamically. You can preload it as you well.</p>
> +<pre>
> +    $ LD_PRELOAD=$WLD/lib/libglapi.so ./yourcommand
> +</pre>

instead xxxx we could use $PREFIX or even $WLD.

The rest of the changes look okay. As a quick remind, for wiki-alike 
pages, the challenge is to make it in a way that it becomes simple and 
useful at the same time. So we have to watch out to not bloat it much, 
fulfilling with rubbish and superficial things.


Cheers,

        Tiago