docs: Fix location of plugins and registry in home directories
authorWilliam Manley <will@williammanley.net>
Tue, 11 Feb 2014 16:30:31 +0000 (16:30 +0000)
committerSebastian Dröge <sebastian@centricular.com>
Tue, 11 Feb 2014 19:56:48 +0000 (20:56 +0100)
Fixes out of date documentation left over since 0.10.  In 1.0 plugins are
stored in $XDG_DATA_HOME and the registry in $XDG_CACHE_HOME conformant
with the XDG Base Directory Specification[1].

[1]: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

https://bugzilla.gnome.org/show_bug.cgi?id=724132

docs/gst/running.xml
gst/gstregistry.c

index 9b4a36b..67ac4fa 100644 (file)
@@ -46,7 +46,7 @@ plug-ins in the user's home directory, or rather the user's "data home"
 directory according to the xdg base dir specification. Usually this will be
 a directory called
 <filename>plugins</filename> inside the
-<filename>.local/share/.gstreamer-&GST_API_VERSION;</filename> directory in
+<filename>.local/share/gstreamer-&GST_API_VERSION;</filename> directory in
 the user's home directory by default, though this search path may change if
 the XDG_DATA_HOME environment variable is set.
     </para>
index 0830395..dfd87d0 100644 (file)
  *   <listitem>
  *     <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
  *       default locations are:
- *       <filename>~/.gstreamer-$GST_API_VERSION/plugins/</filename>
+ *       <filename>$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/</filename>
  *       and <filename>$prefix/libs/gstreamer-$GST_API_VERSION/</filename>.
+ *       <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
+ *       <filename>$XDG_DATA_HOME</filename></ulink> defaults to
+ *       <filename>$HOME/.local/share</filename>.
  *     </para>
  *   </listitem>
  * </itemizedlist>
  * The registry cache file is loaded from
- * <filename>~/.gstreamer-$GST_API_VERSION/registry-$ARCH.bin</filename> or the
- * file listed in the GST_REGISTRY env var. One reason to change the registry
- * location is for testing.
+ * <filename>$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin</filename>
+ * (where
+ * <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
+ * <filename>$XDG_CACHE_HOME</filename></ulink> defaults to
+ * <filename>$HOME/.cache</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: