Commit 14f2a81b authored by Erik Faye-Lund's avatar Erik Faye-Lund 🍼 Committed by Marge Bot
Browse files

docs: drop open-coded toc for articles



Sphinx already provides a proper table-of-contents, so we don't need to
roll our own.
Reviewed-by: Eric Engestrom's avatarEric Engestrom <eric@engestrom.ch>
Part-of: <!4630>
parent d6be994e
Development Notes
=================
- `Adding Extensions <#extensions>`__
.. _extensions:
Adding Extensions
-----------------
......
......@@ -3,16 +3,6 @@ Frequently Asked Questions
Last updated: 19 September 2018
Index
-----
#. `High-level Questions and Answers <#part1>`__
#. `Compilation and Installation Problems <#part2>`__
#. `Runtime / Rendering Problems <#part3>`__
#. `Developer Questions <#part4>`__
.. _part1:
1. High-level Questions and Answers
-----------------------------------
......@@ -129,8 +119,6 @@ is an OpenGL subset library for TI graphing calculators.
There may be other open OpenGL implementations, but Mesa is the most
popular and feature-complete.
.. _part2:
2. Compilation and Installation Problems
----------------------------------------
......@@ -205,8 +193,6 @@ Mesa with
``meson configure --prefix=/usr --libdir=xxx -D dri-drivers-path=xxx``
and then install with ``sudo ninja install``.
.. _part3:
3. Runtime / Rendering Problems
-------------------------------
......@@ -270,8 +256,6 @@ Programming Guide - "OpenGL Correctness Tips". Basically, applying a
translation of (0.375, 0.375, 0.0) to your coordinates will fix the
problem.
.. _part4:
4. Developer Questions
----------------------
......
......@@ -7,19 +7,6 @@ Compiling and Installing
meson
#. `Prerequisites for building <#prereq-general>`__
- `General prerequisites <#prereq-general>`__
- `For DRI and hardware acceleration <#prereq-dri>`__
#. `Building with meson <#meson>`__
#. `Building with SCons (Windows/Linux) <#scons>`__
#. `Building with AOSP (Android) <#android>`__
#. `Library Information <#libs>`__
#. `Building OpenGL programs with pkg-config <#pkg-config>`__
.. _prereq-general:
1. Prerequisites for building
-----------------------------
......@@ -73,8 +60,6 @@ Third party/extra tools.
Some versions can be buggy (eg. flex 2.6.2) so do try others
if things fail.
.. _prereq-dri:
1.2 Requirements
~~~~~~~~~~~~~~~~
......@@ -93,8 +78,6 @@ on the packaging tool used by your distro.
apt-get build-dep mesa # Debian and derivatives
... # others
.. _meson:
2. Building with meson
----------------------
......@@ -122,8 +105,6 @@ On windows you can also use the visual studio backend
Please read the `detailed meson instructions <meson.html>`__ for more
information
.. _scons:
3. Building with SCons (Windows/Linux)
--------------------------------------
......@@ -154,8 +135,6 @@ This will create:
Put them all in the same directory to test them. Additional information
is available in `README.WIN32 <README.WIN32>`__.
.. _android:
4. Building with AOSP (Android)
-------------------------------
......@@ -169,8 +148,6 @@ the libGLES_mesa library.
FINISHME: Improve on the instructions add references to Rob H
repos/Jenkins, Android-x86 and/or other resources.
.. _libs:
5. Library Information
----------------------
......@@ -202,8 +179,6 @@ If you built the DRI hardware drivers, you'll also see the DRI drivers:
If you built with Gallium support, look in lib/gallium/ for
Gallium-based versions of libGL and device drivers.
.. _pkg-config:
6. Building OpenGL programs with pkg-config
-------------------------------------------
......
Compilation and Installation Using Meson
========================================
- `Introduction <#intro>`__
- `Basic Usage <#basic>`__
- `Advanced Usage <#advanced>`__
- `Cross-compilation and 32-bit builds <#cross-compilation>`__
.. _intro:
1. Introduction
---------------
......@@ -74,8 +67,6 @@ Then install meson using pip
You may need to add the python3 scripts directory to your path for
meson.
.. _basic:
2. Basic Usage
--------------
......@@ -173,8 +164,6 @@ visual studio integration or you just like msbuild, passing
want to use ICL or clang-cl with the vsbackend you will need meson
0.52.0 or greater. Older versions always use the microsoft compiler.
.. _advanced:
3. Advanced Usage
-----------------
......@@ -415,8 +404,6 @@ For those coming from autotools be aware of the following:
are disabled. This is unrelated to the ``buildtype``; setting the
latter to ``release`` will not turn off assertions.
.. _cross-compilation:
4. Cross-compilation and 32-bit builds
--------------------------------------
......
Releasing Process
=================
- `Overview <#overview>`__
- `Release schedule <#schedule>`__
- `Cherry-pick and test <#pickntest>`__
- `Staging branch <#stagingbranch>`__
- `Making a branchpoint <#branch>`__
- `Making a new release <#release>`__
- `Announce the release <#announce>`__
- `Update Gitlab Issues <#gitlab>`__
Overview
--------
......@@ -170,8 +161,6 @@ Notes:
regressions.
- The branch history is not stable and it **will** be rebased,
.. _branch:
Making a branchpoint
--------------------
......@@ -210,8 +199,6 @@ needed. For example: files being overwritten on install, etc. Happens
extremely rarely - we had only one case so far (see commit
2ced8eb136528914e1bf4e000dea06a9d53c7e04).
.. _release:
Making a new release
--------------------
......@@ -223,8 +210,6 @@ Get latest source files
Ensure the latest code is available - both in your local master and the
relevant branch.
.. _basictesting:
Perform basic testing
~~~~~~~~~~~~~~~~~~~~~
......@@ -333,8 +318,6 @@ looks correct and push:
git push origin master X.Y
.. _announce:
Announce the release
--------------------
......@@ -343,8 +326,6 @@ Use the generated template during the releasing process.
Again, pay attention to add a note to warn about a final release in a
series, if that is the case.
.. _gitlab:
Update gitlab issues
--------------------
......
......@@ -4,17 +4,6 @@ Shading Language
This page describes the features and status of Mesa's support for the
`OpenGL Shading Language <https://opengl.org/documentation/glsl/>`__.
Contents
- `Environment variables <#envvars>`__
- `GLSL 1.40 support <#support>`__
- `Unsupported Features <#unsup>`__
- `Implementation Notes <#notes>`__
- `Programming Hints <#hints>`__
- `Stand-alone GLSL Compiler <#standalone>`__
- `Compiler Implementation <#implementation>`__
- `Compiler Validation <#validation>`__
.. _envvars:
Environment Variables
......@@ -74,8 +63,6 @@ which compiler developers can use to gather statistics about shaders
Notably, this captures linked GLSL shaders - with all stages together -
as well as ARB programs.
.. _support:
GLSL Version
------------
......@@ -88,8 +75,6 @@ Several GLSL extensions are also supported:
- GL_ARB_fragment_coord_conventions
- GL_ARB_shader_bit_encoding
.. _unsup:
Unsupported Features
--------------------
......@@ -106,8 +91,6 @@ supported in Mesa:
All other major features of the shading language should function.
.. _notes:
Implementation Notes
--------------------
......@@ -127,8 +110,6 @@ Implementation Notes
These issues will be addressed/resolved in the future.
.. _hints:
Programming Hints
-----------------
......@@ -145,8 +126,6 @@ Programming Hints
float x = inversesqrt(y);
.. _standalone:
Stand-alone GLSL Compiler
-------------------------
......@@ -180,8 +159,6 @@ Options include
any header or separator
- **--version** - [Mandatory] define the GLSL version to use
.. _implementation:
Compiler Implementation
-----------------------
......@@ -194,8 +171,6 @@ The final vertex and fragment programs may be interpreted in software
(see prog_execute.c) or translated into a specific hardware architecture
(see drivers/dri/i915/i915_fragprog.c for example).
.. _validation:
Compiler Validation
-------------------
......
Submitting Patches
==================
- `Basic guidelines <#guidelines>`__
- `Patch formatting <#formatting>`__
- `Testing Patches <#testing>`__
- `Submitting Patches <#submit>`__
- `Reviewing Patches <#reviewing>`__
- `Nominating a commit for a stable branch <#nominations>`__
- `Criteria for accepting patches to the stable branch <#criteria>`__
- `Sending backports for the stable branch <#backports>`__
- `Git tips <#gittips>`__
.. _guidelines:
Basic guidelines
----------------
......@@ -259,8 +247,6 @@ project. The submitter is expected to evaluate whether they have an
appropriate amount of review feedback from people who also understand
the code before merging their patches.
.. _nominations:
Nominating a commit for a stable branch
---------------------------------------
......@@ -281,8 +267,6 @@ nomination request.
The current patch status can be observed in the `staging
branch <releasing.html#stagingbranch>`__.
.. _thetag:
The stable tag
~~~~~~~~~~~~~~
......@@ -375,8 +359,6 @@ staging/year.quarter branch, not on the year.quarter branch, per the
stable branch policy. Assigning the MR to release maintainer for said
branch or mentioning them is helpful, but not required.
.. _gittips:
Git tips
--------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment