docs: add release notes for 18.3.2
[mesa.git] / docs / install.html
index 53164973205f9f5fb43972330198db23f72dd38a..b6a75baeeb9341664213bf622c8d3609fb2e47ec 100644 (file)
@@ -7,6 +7,13 @@
 </head>
 <body>
 
+<div class="header">
+  <h1>The Mesa 3D Graphics Library</h1>
+</div>
+
+<iframe src="contents.html"></iframe>
+<div class="content">
+
 <h1>Compiling and Installing</h1>
 
 <ol>
   <li><a href="#prereq-general">General prerequisites</a>
   <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
   </ul>
+<li><a href="#meson">Building with meson</a>
 <li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
 <li><a href="#scons">Building with SCons (Windows/Linux)</a>
-<li><a href="#other">Building for other systems</a>
+<li><a href="#android">Building with AOSP (Android)</a>
 <li><a href="#libs">Library Information</a>
 <li><a href="#pkg-config">Building OpenGL programs with pkg-config</a>
 </ol>
 <h1 id="prereq-general">1. Prerequisites for building</h1>
 
 <h2>1.1 General</h2>
+
+<p>
+Build system.
+</p>
+
 <ul>
-<li>lex / yacc - for building the GLSL compiler.
-On Linux systems, flex and bison are used.
-Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
-<br>
-<br>
-On Windows with MinGW, install flex and bison with:
-<pre>mingw-get install msys-flex msys-bison</pre>
+<li><a href="https://mesonbuild.com">meson</a> is recommended when building on *nix platforms.
+<li>Autoconf is another option when building on *nix platforms.
+<li><a href="http://www.scons.org/">SCons</a> is required for building on
+Windows and optional for Linux (it's an alternative to autoconf/automake or meson.)
 </li>
-<li>python - Python is needed for building the Gallium components.
-Version 2.6.4 or later should work.
-<br>
-<br>
-To build OpenGL ES 1.1 and 2.0 you'll also need
-<a href="http://xmlsoft.org/sources/win32/python/libxml2-python-2.7.7.win32-py2.7.exe">libxml2-python</a>.
+<li>Android Build system when building as native Android component. Autoconf
+is used when when building ARC.
 </li>
 </ul>
 
 
-<h3 id="prereq-dri">1.2 For DRI and hardware acceleration</h3>
+<p>
+The following compilers are known to work, if you know of others or you're
+willing to maintain support for other compiler get in touch.
+</p>
+
+<ul>
+<li>GCC 4.2.0 or later (some parts of Mesa may require later versions)
+<li>clang - exact minimum requirement is currently unknown.
+<li>Microsoft Visual Studio 2015 or later is required, for building on Windows.
+</ul>
+
 
 <p>
-The following are required for DRI-based hardware acceleration with Mesa:
+Third party/extra tools.
+<br>
+<strong>Note</strong>: These should not be required, when building from a release tarball. If
+you think you've spotted a bug let developers know by filing a
+<a href="bugs.html">bug report</a>.
 </p>
 
+
 <ul>
-<li><a href="http://xorg.freedesktop.org/releases/individual/proto/"
-target="_parent">dri2proto</a> version 2.6 or later
-<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
-version 2.4.33 or later
-<li>Xorg server version 1.5 or later
-<li>Linux 2.6.28 or later
+<li><a href="https://www.python.org/">Python</a> - Python is required.
+When building with scons 2.7 is required.
+When building with meson 3.5 or newer is required.
+When building with autotools 2.7, or 3.5 or later are required.
+</li>
+<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
+Python Mako module is required. Version 0.8.0 or later should work.
+</li>
+<li>lex / yacc - for building the Mesa IR and GLSL compiler.
+<div>
+On Linux systems, flex and bison versions 2.5.35 and 2.4.1, respectively,
+(or later) should work.
+On Windows with MinGW, install flex and bison with:
+<pre>mingw-get install msys-flex msys-bison</pre>
+For MSVC on Windows, install
+<a href="http://winflexbison.sourceforge.net/">Win flex-bison</a>.
+</div>
 </ul>
+<p><strong>Note</strong>: Some versions can be buggy (eg. flex 2.6.2) so do try others if things fail.</p>
+
+
+<h3 id="prereq-dri">1.2 Requirements</h3>
+
+<p>
+The requirements depends on the features selected at configure stage.
+Check/install the respective -devel package as prompted by the configure error
+message.
+</p>
+
 <p>
-If you're using a fedora distro the following command should install all
-the needed dependencies:
+Here are some common ways to retrieve most/all of the dependencies based on
+the packaging tool used by your distro.
 </p>
+
 <pre>
-  sudo yum install flex bison imake libtool xorg-x11-proto-devel libdrm-devel \
-  gcc-c++ xorg-x11-server-devel libXi-devel libXmu-devel libXdamage-devel git \
-  expat-devel llvm-devel
+  zypper source-install --build-deps-only Mesa # openSUSE/SLED/SLES
+  yum-builddep mesa # yum Fedora, OpenSuse(?)
+  dnf builddep mesa # dnf Fedora
+  apt-get build-dep mesa # Debian and derivatives
+  ... # others
 </pre>
 
+<h1 id="meson">2. Building with meson</h1>
+
+<p>
+Meson is the latest build system in mesa, it is currently able to build for
+*nix systems like Linux and BSD, and will be able to build for windows as well.
+</p>
 
+<p>
+The general approach is:
+</p>
+<pre>
+  meson builddir/
+  ninja -C builddir/
+  sudo ninja -C builddir/ install
+</pre>
+<p>
+Please read the <a href="meson.html">detailed meson instructions</a>
+for more information
+</p>
 
-<H1 id="autoconf">2. Building with autoconf (Linux/Unix/X11)</H1>
+<h1 id="autoconf">3. Building with autoconf (Linux/Unix/X11)</h1>
 
 <p>
-The primary method to build Mesa on Unix systems is with autoconf.
+Although meson is recommended, another supported way to build on *nix systems
+is with autoconf.
 </p>
 
 <p>
@@ -92,7 +157,7 @@ for more details.
 
 
 
-<H1 id="scons">3. Building with SCons (Windows/Linux)</H1>
+<h1 id="scons">4. Building with SCons (Windows/Linux)</h1>
 
 <p>
 To build Mesa with SCons on Linux or Windows do
@@ -111,36 +176,43 @@ by -debug for debug builds.
 To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
 </p>
 <pre>
-    scons platform=windows toolchain=crossmingw machine=x86 mesagdi libgl-gdi
+    scons platform=windows toolchain=crossmingw machine=x86 libgl-gdi
 </pre>
 <p>
 This will create:
 </p>
 <ul>
-<li>build/windows-x86-debug/mesa/drivers/windows/gdi/opengl32.dll &mdash; Mesa + swrast, binary compatible with Windows's opengl32.dll 
-<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll 
+<li>build/windows-x86-debug/gallium/targets/libgl-gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe (or llvmpipe), binary compatible with Windows's opengl32.dll
 </ul>
 <p>
 Put them all in the same directory to test them.
+
+Additional information is available in <a href="README.WIN32">README.WIN32</a>.
+
 </p>
 
 
 
-<H1 id="other">4. Building for other systems</H1>
+<h1 id="android">5. Building with AOSP (Android)</h1>
 
 <p>
-Documentation for other environments (some may be very out of date):
+Currently one can build Mesa for Android as part of the AOSP project, yet
+your experience might vary.
 </p>
 
-<UL>
-<li><A HREF="README.VMS">README.VMS</A> - VMS
-<LI><A HREF="README.CYGWIN">README.CYGWIN</A> - Cygwin
-<LI><A HREF="README.WIN32">README.WIN32</A> - Win32
-</UL>
+<p>
+In order to achieve that one should update their local manifest to point to the
+upstream repo, set the appropriate BOARD_GPU_DRIVERS and build the
+libGLES_mesa library.
+</p>
 
+<p>
+FINISHME: Improve on the instructions add references to Rob H repos/Jenkins,
+Android-x86 and/or other resources.
+</p>
 
 
-<H1 id="libs">5. Library Information</H1>
+<h1 id="libs">6. Library Information</h1>
 
 <p>
 When compilation has finished, look in the top-level <code>lib/</code>
@@ -151,9 +223,6 @@ You'll see a set of library files similar to this:
 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
-lrwxrwxrwx    1 brian    users          11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
-lrwxrwxrwx    1 brian    users          20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
--rwxr-xr-x    1 brian    users      549269 Mar 26 07:53 libGLU.so.1.3.060100*
 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
@@ -162,8 +231,6 @@ lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSM
 <p>
 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 <br>
-<b>libGLU</b> is the OpenGL Utility library.
-<br>
 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 </p>
 
@@ -174,7 +241,6 @@ If you built the DRI hardware drivers, you'll also see the DRI drivers:
 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i965_dri.so
 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
--rwxr-xr-x   1 brian users 16050488 Jul 21 12:11 r300_dri.so
 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 </pre>
 
@@ -184,7 +250,7 @@ versions of libGL and device drivers.
 </p>
 
 
-<H1 id="pkg-config">6. Building OpenGL programs with pkg-config</H1>
+<h1 id="pkg-config">7. Building OpenGL programs with pkg-config</h1>
 
 <p>
 Running <code>make install</code> will install package configuration files
@@ -205,6 +271,6 @@ For example, compiling and linking a GLUT application can be done with:
 
 <br>
 
-
+</div>
 </body>
 </html>