From 8c9c0eb38be4300b72b68af6a50d6468a0475501 Mon Sep 17 00:00:00 2001
From: Corbin Simpson <cds@corbinsimpson.com>
Date: Mon, 30 Nov 2020 22:10:43 -0800
Subject: [PATCH] doc/builders/packages/opengl: Convert to CommonMark.
 (#105485)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* doc/builders/packages/opengl: Convert to CommonMark.

* Update doc/builders/packages/opengl.section.md

NVIDIA™

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* Update doc/builders/packages/opengl.section.md

NVIDIA™

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>
---
 doc/builders/packages/index.xml         |  2 +-
 doc/builders/packages/opengl.section.md | 15 +++++++++++++++
 doc/builders/packages/opengl.xml        |  9 ---------
 3 files changed, 16 insertions(+), 10 deletions(-)
 create mode 100644 doc/builders/packages/opengl.section.md
 delete mode 100644 doc/builders/packages/opengl.xml

diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml
index 3007c297c16..ba59ceb016b 100644
--- a/doc/builders/packages/index.xml
+++ b/doc/builders/packages/index.xml
@@ -15,7 +15,7 @@
  <xi:include href="linux.xml" />
  <xi:include href="locales.xml" />
  <xi:include href="nginx.xml" />
- <xi:include href="opengl.xml" />
+ <xi:include href="opengl.section.xml" />
  <xi:include href="shell-helpers.xml" />
  <xi:include href="steam.xml" />
  <xi:include href="cataclysm-dda.section.xml" />
diff --git a/doc/builders/packages/opengl.section.md b/doc/builders/packages/opengl.section.md
new file mode 100644
index 00000000000..6866bf89221
--- /dev/null
+++ b/doc/builders/packages/opengl.section.md
@@ -0,0 +1,15 @@
+# OpenGL {#sec-opengl}
+
+OpenGL support varies depending on which hardware is used and which drivers are available and loaded.
+
+Broadly, we support both GL vendors: Mesa and NVIDIA.
+
+## NixOS Desktop
+
+The NixOS desktop or other non-headless configurations are the primary target for OpenGL libraries and applications. The current solution for discovering which drivers are available is based on [libglvnd](https://gitlab.freedesktop.org/glvnd/libglvnd). `libglvnd` performs "vendor-neutral dispatch", trying a variety of techniques to find the system's GL implementation. In practice, this will be either via standard GLX for X11 users or EGL for Wayland users, and supporting either NVIDIA or Mesa extensions.
+
+## Nix on GNU/Linux
+
+If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of `libglvnd` and `mesa.drivers` in `LD_LIBRARY_PATH`. For Mesa drivers, the Linux kernel version doesn't have to match nixpkgs.
+
+For proprietary video drivers you might have luck with also adding the corresponding video driver package.
diff --git a/doc/builders/packages/opengl.xml b/doc/builders/packages/opengl.xml
deleted file mode 100644
index dfd64b18858..00000000000
--- a/doc/builders/packages/opengl.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<section xmlns="http://docbook.org/ns/docbook"
-         xmlns:xlink="http://www.w3.org/1999/xlink"
-         xml:id="sec-opengl">
- <title>OpenGL</title>
-
- <para>
-  Packages that use OpenGL have NixOS desktop as their primary target. The current solution for loading the GPU-specific drivers is based on <literal>libglvnd</literal> and looks for the driver implementation in <literal>LD_LIBRARY_PATH</literal>. If you are using a non-NixOS GNU/Linux/X11 desktop with free software video drivers, consider launching OpenGL-dependent programs from Nixpkgs with Nixpkgs versions of <literal>libglvnd</literal> and <literal>mesa.drivers</literal> in <literal>LD_LIBRARY_PATH</literal>. For proprietary video drivers you might have luck with also adding the corresponding video driver package.
- </para>
-</section>