Difference between pages "Template:Ebuild" and "Package:Eselect (OpenGL)"

(Difference between pages)
 
 
Line 1: Line 1:
<noinclude>
 
This is the "Ebuild" template.
 
It should be called in the following format:
 
<pre>
 
 
{{Ebuild
 
{{Ebuild
|Summary=
+
|Summary=A Gentoo/Funtoo utility that allows the active OpenGL implementation on a system to be switched between a variety of installed options.
|CatPkg=
+
|CatPkg=app-admin/eselect-opengl
 
|Maintainer=
 
|Maintainer=
|Homepage=
 
 
}}
 
}}
</pre>
+
== Introduction ==
Edit the page to see the template text.
+
 
</noinclude><includeonly>__NOTOC__<div style="float: right; clear: both; width: 30%; padding: 1em; margin-left: 1em; margin-bottom: 1em; border-radius: 10px; border: 1px solid #ddd; background-color: #efefef;" id="eb_infobox">
+
Eselect (OpenGL) (also called <tt>eselect-opengl</tt>) is a module for [[Package:Eselect|Eselect]] that allows the OpenGL implementation on a Funtoo Linux or Gentoo Linux system to be switched between a variety of installed OpenGL implementations. It functions by creating an <tt>env.d</tt> file at <tt>/etc/env.d/03opengl</tt> which contains OpenGL settings, as well as managing symbolic links to OpenGL libraries and headers.  
<b><tt>[[CatPkg::{{{CatPkg|}}}]]</tt></b>
+
 
<hr>{{#vardefine:cat|{{#explode:{{{CatPkg}}}|/|0}}}}{{#vardefine:pkg|{{#explode:{{{CatPkg}}}|/|1}}}}{{#get_web_data:url=http://ports.funtoo.org/packages.xml|format=xml|use xpath|data=repo_id=/packages/category[@name='{{#var:cat}}']/package[@name='{{#var:pkg}}']/@repository}}{{#vardefine:repoid|{{#if:{{#external_value:repo_id}}|{{#external_value:repo_id}}|gentoo}}}}{{#set:RepoID={{#var:repoid}}}}
+
=== Sample env.d File ===
<table border="0" width="100%">
+
 
{{#if: {{{Maintainer|}}} |<tr><td><i>Current Maintainer(s):</i></td><td>{{#arraymaptemplate:{{{Maintainer|}}}|MaintainerDisplay|,|<br>}}</td></tr> |}}{{#if: {{{Homepage|}}} |<tr><td></td><td>[[Homepage::{{{Homepage|}}}|Homepage]]</td></tr> |}}<tr><td><i>Source Repository:</i></td><td>{{#ask:[[Category:Repositories]] [[Repository ID::{{#var:repoid}}]]}}</td></tr></table><hr>
+
A sample <tt>env.d</tt> file for a multilib system with xorg-x11 OpenGL implementation may look like this:
<b>Summary:</b> [[Summary::{{{Summary|}}}]]
+
 
</div>
+
{{file|name=/etc/env.d/03opengl|desc=An example env.d file for eselect-opengl|body=
{{#get_web_data:url=http://ports.funtoo.org/packages.xml|format=xml|use xpath|data=use=/packages/category[@name='{{#var:cat}}']/package[@name='{{#var:pkg}}']/@use}}
+
# Configuration file for eselect
{{#set:Use={{#external_value:use}}}}
+
# This file has been automatically generated.
{{#if: {{#external_value:use}}|<div style="float: right; clear: both; width: 30%; padding: 1em; margin-left: 1em; margin-bottom: 1em; border-radius: 10px; border: 1px solid #ddd; background-color: #efefef;" id="eb_infobox">
+
LDPATH="/usr/lib32/opengl/xorg-x11/lib:/usr/lib64/opengl/xorg-x11/lib"
== Use Flags ==
+
OPENGL_PROFILE="xorg-x11"
{{#arraymaptemplate:{{#external_value:use}}|ExternUse|,|}}
+
</div>
+
 
}}
 
}}
<div id="ebuild_header"><div id="ebuild_logo" style="padding-bottom: 1em;">[[File:ebuild.png|link=|frameless]]</div><div id="ebuild_title">
+
 
= {{PAGENAME}} =
+
== Implementation ==
</div></includeonly>
+
 
 +
Eselect-opengl is implemented as a single bash-based [[Package:Eselect|Eselect]] module approximately 10K in size, installed at <tt>/usr/share/eselect/modules/opengl.eselect</tt>. One interfaces with this module via the main <tt>eselect</tt> command:
 +
 
 +
<console>
 +
# ##i##eselect opengl help
 +
Manage the OpenGL implementation used by your system
 +
Usage: eselect opengl <action> <options>
 +
 
 +
##g##Standard actions:
 +
  help                      Display help text
 +
  usage                    Display usage information
 +
  version                  Display version information
 +
 
 +
##g##Extra actions:
 +
  list                      List the available OpenGL implementations.
 +
  set <target>              Select the OpenGL implementation.
 +
    <target>                  The profile to activate
 +
    --use-old                If an implementation is already set, use that one instead
 +
    --prefix=<val>           Set the source prefix (default: /usr)
 +
    --dst-prefix=<val>        Set the destination prefix (default: /usr)
 +
    --ignore-missing          Ignore missing files when setting a new implementation
 +
  show                      Print the current OpenGL implementation.
 +
</console>
 +
 
 +
== What is Switched ==
 +
 
 +
Using <tt>eselect opengl set</tt> causes the following symbolic links to be updated to point to the files corresponding to the OpenGL implementation that you chose:
 +
 
 +
* ''Libraries'' (32-bit and 64-bit):
 +
** <tt>/usr/lib(64)/libGL.so.*</tt>
 +
** <tt>/usr/lib(64)/libEGL.so.*</tt>
 +
** <tt>/usr/lib/(32|64|)/libGLESv1.so.*</tt>
 +
** <tt>/usr/lib/(32|64|)/libGLESv2.so.*</tt>
 +
* ''C Headers'':
 +
** <tt>/usr/include/GL/*</tt>
 +
** <tt>/usr/include/EGL/*</tt>
 +
** <tt>/usr/include/KHR/*</tt>
 +
* <tt>/usr/lib(64|)/xorg/modules/extensions/libglx.so</tt>
 +
 
 +
The symbolic links point to an installed OpenGL implementation, stored inside <tt>/usr/lib(32|64|)/opengl/(implementation-name)</tt>. These files are structured as follows:
 +
 
 +
* <tt>/usr/lib/opengl/(implementation-name)/lib</tt>
 +
* <tt>/usr/lib/opengl/(implementation-name)/include/(GL|EGL|KHR)</tt>
 +
* <tt>/usr/lib/opengl/(implementation-name)/extensions/libglx.so</tt>
 +
 
 +
On multilib systems, ebuilds that provide an OpenGL implementation install 32-bit libraries in <tt>/usr/lib32/opengl/(implementation name)/lib</tt> and 64-bit libraries in <tt>/usr/lib64/opengl/(implementation name)/lib</tt>.
 +
 
 +
== Criticisms ==
 +
 
 +
=== Violation of Build Consistency ===
 +
 
 +
As documented in {{Bug|FL-1309}}, sometimes packages fail to merge when the "wrong" eselect opengl implementation is selected. This violates Portage's ability to consistently build a package from source, assuming all its dependencies are satisfied. This could be classified as a design bug -- eselect-opengl is functioning as intended, but its underlying theory of operation is not correct.
 +
 
 +
== eselect-opengl-1.3* experiment ==
 +
 
 +
=== Introduction ===
 +
 
 +
As a result of {{Bug|FL-1309}}, an experimental solution was implemented in eselect-opengl-1.3*. With this version, all packages are built unconditionally against xorg-x11 OpenGL implementation and the other implementations are used only in runtime.
 +
 
 +
The rationale for this design change is that:
 +
# There should be a consistent and repeatable build/linking process for all OpenGL applications.
 +
# AMD and NVIDIA implementations of OpenGL are designed to be more of a "drop-in" runtime replacement for xorg-x11, rather than a standalone replacement for xorg-x11, and thus appear to exhibit more build-time bugs.
 +
 
 +
=== Implementation ===
 +
 
 +
The new version of eselect-opengl switched two files:
 +
* an env.d file <tt>000opengl</tt> specifying <tt>LDPATH</tt> for the run-time implementation override,
 +
* an xorg.conf.d file overriding the ModulePath for custom glx xorg modules.
 +
 
 +
The env.d file has the same contents as the original one, except that the name was changed to ensure that the additional linker paths are added before the system paths where xorg-x11 libraries are installed.
 +
 
 +
The xorg.conf.d sets ModulePaths for non-xorg module replacements (such as the nvidia glx module), if necessary.
 +
 
 +
=== Issues ===
 +
 
 +
The widespread testing of eselect-opengl-1.3* has proven some issues with the new design:
 +
 
 +
# xorg-server is unable to handle multiple occurences of <code>Files</code> section gracefully. Therefore, eselect-opengl's generated xorg.conf.d file collides with many user-defined configurations. This has been patched locally and the patch is awaiting upstream review)
 +
# There are rumors of arm mali's prioprietary OpenGL implementations requiring applications to be built against its own GLES headers.
 +
 
 +
{{EbuildFooter}}

Latest revision as of 08:00, March 1, 2015

app-admin/eselect-opengl


Source Repository:Repository:Gentoo Portage Tree


Summary: A Gentoo/Funtoo utility that allows the active OpenGL implementation on a system to be switched between a variety of installed options.


News

Drobbins

Perl Updates

Gentoo has bumped perl from 5.20 to 5.22. Be sure to run perl-cleaner --all after the upgrade.
2015-07-25 by Drobbins
Drobbins

ARM Rebuild

ARM systems will use new stage3's that are not compatible with earlier versions.
2015-06-27 by Drobbins
Drobbins

ABI X86 64 and 32

Funtoo Linux has new 32-bit compatibility libraries inherited from Gentoo. Learn about them here.
2015-06-18 by Drobbins
More...

Eselect (OpenGL)

Tip

We welcome improvements to this page. To edit this page, Create a Funtoo account. Then log in and then click here to edit this page. See our editing guidelines to becoming a wiki-editing pro.

Introduction

Eselect (OpenGL) (also called eselect-opengl) is a module for Eselect that allows the OpenGL implementation on a Funtoo Linux or Gentoo Linux system to be switched between a variety of installed OpenGL implementations. It functions by creating an env.d file at /etc/env.d/03opengl which contains OpenGL settings, as well as managing symbolic links to OpenGL libraries and headers.

Sample env.d File

A sample env.d file for a multilib system with xorg-x11 OpenGL implementation may look like this:

/etc/env.d/03opengl - An example env.d file for eselect-opengl
# Configuration file for eselect
# This file has been automatically generated.
LDPATH="/usr/lib32/opengl/xorg-x11/lib:/usr/lib64/opengl/xorg-x11/lib"
OPENGL_PROFILE="xorg-x11"

Implementation

Eselect-opengl is implemented as a single bash-based Eselect module approximately 10K in size, installed at /usr/share/eselect/modules/opengl.eselect. One interfaces with this module via the main eselect command:

# eselect opengl help
Manage the OpenGL implementation used by your system
Usage: eselect opengl <action> <options>

Standard actions:
  help                      Display help text
  usage                     Display usage information
  version                   Display version information

Extra actions:
  list                      List the available OpenGL implementations.
  set <target>              Select the OpenGL implementation.
    <target>                  The profile to activate
    --use-old                 If an implementation is already set, use that one instead
    --prefix=<val>            Set the source prefix (default: /usr)
    --dst-prefix=<val>        Set the destination prefix (default: /usr)
    --ignore-missing          Ignore missing files when setting a new implementation
  show                      Print the current OpenGL implementation.

What is Switched

Using eselect opengl set causes the following symbolic links to be updated to point to the files corresponding to the OpenGL implementation that you chose:

  • Libraries (32-bit and 64-bit):
    • /usr/lib(64)/libGL.so.*
    • /usr/lib(64)/libEGL.so.*
    • /usr/lib/(32|64|)/libGLESv1.so.*
    • /usr/lib/(32|64|)/libGLESv2.so.*
  • C Headers:
    • /usr/include/GL/*
    • /usr/include/EGL/*
    • /usr/include/KHR/*
  • /usr/lib(64|)/xorg/modules/extensions/libglx.so

The symbolic links point to an installed OpenGL implementation, stored inside /usr/lib(32|64|)/opengl/(implementation-name). These files are structured as follows:

  • /usr/lib/opengl/(implementation-name)/lib
  • /usr/lib/opengl/(implementation-name)/include/(GL|EGL|KHR)
  • /usr/lib/opengl/(implementation-name)/extensions/libglx.so

On multilib systems, ebuilds that provide an OpenGL implementation install 32-bit libraries in /usr/lib32/opengl/(implementation name)/lib and 64-bit libraries in /usr/lib64/opengl/(implementation name)/lib.

Criticisms

Violation of Build Consistency

As documented in FL-1309, sometimes packages fail to merge when the "wrong" eselect opengl implementation is selected. This violates Portage's ability to consistently build a package from source, assuming all its dependencies are satisfied. This could be classified as a design bug -- eselect-opengl is functioning as intended, but its underlying theory of operation is not correct.

eselect-opengl-1.3* experiment

Introduction

As a result of FL-1309, an experimental solution was implemented in eselect-opengl-1.3*. With this version, all packages are built unconditionally against xorg-x11 OpenGL implementation and the other implementations are used only in runtime.

The rationale for this design change is that:

  1. There should be a consistent and repeatable build/linking process for all OpenGL applications.
  2. AMD and NVIDIA implementations of OpenGL are designed to be more of a "drop-in" runtime replacement for xorg-x11, rather than a standalone replacement for xorg-x11, and thus appear to exhibit more build-time bugs.

Implementation

The new version of eselect-opengl switched two files:

  • an env.d file 000opengl specifying LDPATH for the run-time implementation override,
  • an xorg.conf.d file overriding the ModulePath for custom glx xorg modules.

The env.d file has the same contents as the original one, except that the name was changed to ensure that the additional linker paths are added before the system paths where xorg-x11 libraries are installed.

The xorg.conf.d sets ModulePaths for non-xorg module replacements (such as the nvidia glx module), if necessary.

Issues

The widespread testing of eselect-opengl-1.3* has proven some issues with the new design:

  1. xorg-server is unable to handle multiple occurences of Files section gracefully. Therefore, eselect-opengl's generated xorg.conf.d file collides with many user-defined configurations. This has been patched locally and the patch is awaiting upstream review)
  2. There are rumors of arm mali's prioprietary OpenGL implementations requiring applications to be built against its own GLES headers.