mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: update docs (format and search path).

Browse source 
Remove obsolete xml registry cache extension. Tell that content and location is
internal detail. Docuemnt the plugin search order.
This commit is contained in:
Stefan Kost 2010-06-09 12:06:52 +03:00
parent 012cf2862f
commit fdbf9239b3
1 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
gst/gstregistry.c
View file

@ -36,7 +36,7 @@
* but the "default registry" is the only object that has any meaning to the
* core.
*
* The registry.xml file is actually a cache of plugin information. This is
* The registry file is actually a cache of plugin information. This is
* unlike versions prior to 0.10, where the registry file was the primary source
* of plugin information, and was created by the gst-register command.
*
@ -45,13 +45,33 @@
* or wants to search for a feature that satisfies given criteria, the primary
* means of doing so is to load every plugin and look at the resulting
* information that is gathered in the default registry. Clearly, this is a time
* consuming process, so we cache information in the registry.xml file.
* consuming process, so we cache information in the registry file. The format
* and location of the cache file is internal to gstreamer.
*
* On startup, plugins are searched for in the plugin search path. This path can
* be set directly using the GST_PLUGIN_PATH environment variable. The registry
* file is loaded from ~/.gstreamer-$GST_MAJORMINOR/registry-$ARCH.xml or the
* file listed in the GST_REGISTRY env var. The only reason to change the
* registry location is for testing.
* On startup, plugins are searched for in the plugin search path. The following
* locations are checked in this order:
* <itemizedlist>
* <listitem>
* <para>location from --gst-plugin-path commandline option.</para>
* </listitem>
* <listitem>
* <para>the GST_PLUGIN_PATH environment variable.</para>
* </listitem>
* <listitem>
* <para>the GST_PLUGIN_SYSTEM_PATH environment variable.</para>
* </listitem>
* <listitem>
* <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
* default locations are:
* <filename>~/.gstreamer-$GST_MAJORMINOR/plugins/</filename>
* and <filename>$prefix/libs/gstreamer-$GST_MAJORMINOR/</filename>.
* </para>
* </listitem>
* </itemizedlist>
* The registry cache file is loaded from
* <filename>~/.gstreamer-$GST_MAJORMINOR/registry-$ARCH.bin</filename> or the
* file listed in the GST_REGISTRY env var. One reason to change the registry
* location is for testing.
*
* For each plugin that is found in the plugin search path, there could be 3
* possibilities for cached information: