brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Fix OS X docs to install Ports in correct order

Browse Source 
The order in which the MacPorts are installed is important otherwise we open
the user up to a world of pain.
This patch also tweaks the OS X docs to follow the formatting of the rest of
the docs and to discuss the option of GtkDoc.

http://bugzilla.openedhand.com/show_bug.cgi?id=1865
This commit is contained in:
Joshua Lock 2009-11-05 15:31:56 +00:00 committed by Emmanuele Bassi
parent 4533e37744
commit 58f1dfcf35
1 changed files with 41 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/reference/clutter/building-clutter.xml
View File

@ -238,23 +238,40 @@
<section id='building-osx'>
<title>OSX</title>
<para>Currently the only way to install Clutter for developing
<para>
Before you start you should install XCode either from the OSX
installation disk or by downloading it from the Apple website.
</para>
<para>
Note: These instructions have only been tested on OS X 10.6
(a.k.a Snow Leopard)
</para>
<para>
Currently the only way to install Clutter for developing
applications, or hacking on Clutter itself, is to build it yourself.
The recommended route is to install the dependencies with
the <ulink href="http://www.macports.org/">MacPorts</ulink>
project, by simply invoking:</para>
project, by simply invoking:
</para>
<informalexample><programlisting>
$ sudo port install pango libpixman-devel cairo-devel
$ sudo port install libpixman-devel cairo-devel pango gtk-doc
</programlisting></informalexample>
<para>on a terminal, after installing and updating MacPorts.
<para>
on a terminal, after installing and updating MacPorts.
This should give you all of the required dependencies for building
Clutter 1.0.</para>
Clutter.
</para>
<para>
XCode should also be installed, either from the OSX installation
disk or downloading it from the Apple website.
It should be noted that building gtk-doc pulls in a lot of other
MacPorts dependencies and takes some considerable time. You can omit
this dependency so long as you disable documentation when you are
configuring the build with
<literal>--disable-gtk-doc --disable-docs</literal>
</para>
<para>
@ -268,17 +285,8 @@
</para>
<para>
GTK-Doc is not working on OSX, so API reference generation
should also be disabled when building Clutter, by using
the <literal>--disable-docs</literal> and
<literal>--disable-gtk-doc</literal> command line argument
to the configure script.
</para>
<para>
GTK introspection and shave support are untested on OSX so it is
also recommended that you disable these with the
<literal>--disable-shave</literal> and
GTK introspection is untested on OSX (as there isn't a MacPorts
package) so it is recommended that you disable this with the
<literal>--disable-introspection</literal>.
</para>
@ -288,8 +296,7 @@
</para>
<informalexample><programlisting>
./configure --disable-gtk-doc --disable-docs --disable-shave
--with-flavour=osx --disable-introspection --prefix=/opt
./configure --with-flavour=osx --disable-introspection --prefix=/opt
</programlisting></informalexample>
</section>