intel/blorp: Satisfy HIZ_CCS fast-clear alignments
[mesa.git] / docs / install.html
index 8b349c40b9da23b7d2433cbe636b0405675f8528..ec186fb84af2ecc993bd48ded39596307d829ab2 100644 (file)
@@ -8,7 +8,7 @@
 <body>
 
 <div class="header">
-  <h1>The Mesa 3D Graphics Library</h1>
+  The Mesa 3D Graphics Library
 </div>
 
 <iframe src="contents.html"></iframe>
   <li><a href="#prereq-general">General prerequisites</a>
   <li><a href="#prereq-dri">For DRI and hardware acceleration</a>
   </ul>
-<li><a href="#autoconf">Building with autoconf (Linux/Unix/X11)</a>
+<li><a href="#meson">Building with meson</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 id="prereq-general">1. Prerequisites for building</h2>
+
+<h3>1.1 General</h3>
+
+<h4>Build system</h4>
 
-<h2>1.1 General</h2>
 <ul>
-<li><a href="http://www.python.org/">Python</a> - Python is required.
-Version 2.6.4 or later should work.
+<li><a href="https://mesonbuild.com">meson</a> is required when building on *nix platforms and is supported on windows.
+<li><a href="http://www.scons.org/">SCons</a> is an alternative for building on
+Windows and Linux.
 </li>
-<br>
-<li><a href="http://www.makotemplates.org/">Python Mako module</a> -
-Python Mako module is required. Version 0.3.4 or later should work.
+<li>Android Build system when building as native Android component. Meson
+is used when when building ARC.
 </li>
-</br>
-<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.)
+</ul>
+
+<h4>Compiler</h4>
+<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>
+
+
+<h4>Third party/extra tools.</h4>
+
+<ul>
+<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.
+</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>
-<br>
-<li>lex / yacc - for building the GLSL compiler.
-<br>
-<br>
-On Linux systems, flex and bison are used.
-Versions 2.5.35 and 2.4.1, respectively, (or later) should work.
-<br>
-<br>
+<li>lex / yacc - for building the Mesa IR and GLSL compiler.
+<p>
+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>.
-</li>
-<br>
-<li>For building on Windows, Microsoft Visual Studio 2013 or later is required.
-</li>
+</p>
 </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 For DRI and hardware acceleration</h3>
+<h3 id="prereq-dri">1.2 Requirements</h3>
 
 <p>
-The following are required for DRI-based hardware acceleration with Mesa:
+The requirements depends on the features selected at configure stage.
+Check/install the respective -devel package as prompted by the configure error
+message.
 </p>
 
-<ul>
-<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">
-dri2proto</a> version 2.6 or later
-<li><a href="http://dri.freedesktop.org/libdrm/">libDRM</a> latest version
-<li>Xorg server version 1.5 or later
-<li>Linux 2.6.28 or later
-</ul>
 <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 python-mako
+  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>
 
+<h2 id="meson">2. Building with meson</h2>
 
+<p><string>Meson &6t;= 0.46.0 is required</string></p>
 
-<h1 id="autoconf">2. Building with autoconf (Linux/Unix/X11)</h1>
+<p>
+Meson is the latest build system in mesa, it is currently able to build for
+*nix systems like Linux and BSD, macOS, Haiku, and Windows.
+</p>
 
 <p>
-The primary method to build Mesa on Unix systems is with autoconf.
+The general approach is:
 </p>
+<pre>
+  meson builddir/
+  ninja -C builddir/
+  sudo ninja -C builddir/ install
+</pre>
+
+<p>On windows you can also use the visual studio backend</p>
+<pre>
+  meson builddir --backend=vs
+  cd builddir
+  msbuild mesa.sln /m
+</pre>
 
 <p>
-The general approach is the standard:
+Please read the <a href="meson.html">detailed meson instructions</a>
+for more information
 </p>
+
+<p>On windows you can also use the visual studio backend</p>
 <pre>
-  ./configure
-  make
-  sudo make install
+  meson builddir --backend=vs
+  cd builddir
+  msbuild mesa.sln /m
 </pre>
+
 <p>
-But please read the <a href="autoconf.html">detailed autoconf instructions</a>
-for more details.
+Please read the <a href="meson.html">detailed meson instructions</a>
+for more information
 </p>
 
 
 
-<h1 id="scons">3. Building with SCons (Windows/Linux)</h1>
+<h2 id="scons">3. Building with SCons (Windows/Linux)</h2>
 
 <p>
 To build Mesa with SCons on Linux or Windows do
@@ -139,25 +176,33 @@ This will create:
 </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>
+<h2 id="android">4. Building with AOSP (Android)</h2>
 
 <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>
+<h2 id="libs">5. Library Information</h2>
 
 <p>
 When compilation has finished, look in the top-level <code>lib/</code>
@@ -165,18 +210,17 @@ When compilation has finished, look in the top-level <code>lib/</code>
 You'll see a set of library files similar to this:
 </p>
 <pre>
-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*
+lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -&gt; libGL.so.1*
+lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -&gt; 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          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*
+lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -&gt; libOSMesa.so.6*
+lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -&gt; libOSMesa.so.6.1.060100*
 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 </pre>
 
 <p>
-<b>libGL</b> is the main OpenGL library (i.e. Mesa).
-<br>
-<b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
+<b>libGL</b> is the main OpenGL library (i.e. Mesa), while <b>libOSMesa</b>
+is the OSMesa (Off-Screen) interface library.
 </p>
 
 <p>
@@ -195,10 +239,10 @@ versions of libGL and device drivers.
 </p>
 
 
-<h1 id="pkg-config">6. Building OpenGL programs with pkg-config</h1>
+<h2 id="pkg-config">6. Building OpenGL programs with pkg-config</h2>
 
 <p>
-Running <code>make install</code> will install package configuration files
+Running <code>ninja install</code> will install package configuration files
 for the pkg-config utility.
 </p>
 
@@ -214,8 +258,6 @@ For example, compiling and linking a GLUT application can be done with:
    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 </pre>
 
-<br>
-
 </div>
 </body>
 </html>