isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-26 10:00:45 -05:00
Code Issues 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

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

@ -237,24 +237,41 @@
</section> </section>
<section id='building-osx'> <section id='building-osx'>
<title>OSX</title> <title>OSX</title>
<para>Currently the only way to install Clutter for developing <para>
applications, or hacking on Clutter itself, is to build it yourself. Before you start you should install XCode either from the OSX
The recommended route is to install the dependencies with installation disk or by downloading it from the Apple website.
the <ulink href="http://www.macports.org/">MacPorts</ulink> </para>
project, by simply invoking:</para>
<informalexample><programlisting>
$ sudo port install pango libpixman-devel cairo-devel
</programlisting></informalexample>
<para>on a terminal, after installing and updating MacPorts.
This should give you all of the required dependencies for building
Clutter 1.0.</para>
<para> <para>
XCode should also be installed, either from the OSX installation Note: These instructions have only been tested on OS X 10.6
disk or downloading it from the Apple website. (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>
<informalexample><programlisting>
$ sudo port install libpixman-devel cairo-devel pango gtk-doc
</programlisting></informalexample>
<para>
on a terminal, after installing and updating MacPorts.
This should give you all of the required dependencies for building
Clutter.
</para>
<para>
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>
<para> <para>
@ -268,29 +285,19 @@
</para> </para>
<para> <para>
GTK-Doc is not working on OSX, so API reference generation GTK introspection is untested on OSX (as there isn't a MacPorts
should also be disabled when building Clutter, by using package) so it is recommended that you disable this with the
the <literal>--disable-docs</literal> and <literal>--disable-introspection</literal>.
<literal>--disable-gtk-doc</literal> command line argument
to the configure script.
</para> </para>
<para> <para>
GTK introspection and shave support are untested on OSX so it is If building on top of MacPorts, as recommended, the following
also recommended that you disable these with the configure command should suffice:
<literal>--disable-shave</literal> and
<literal>--disable-introspection</literal>.
</para>
<para>
If building on top of MacPorts, as recommended, the following
configure command should suffice:
</para> </para>
<informalexample><programlisting> <informalexample><programlisting>
./configure --disable-gtk-doc --disable-docs --disable-shave ./configure --with-flavour=osx --disable-introspection --prefix=/opt
--with-flavour=osx --disable-introspection --prefix=/opt </programlisting></informalexample>
</programlisting></informalexample>
</section> </section>
</section> </section>