[glib] GSettings schema docs: mention need for EXTRA_DIST



commit 30a856294613ab1119c0972b35bac5bbf3294692
Author: Ryan Lortie <desrt desrt ca>
Date:   Thu May 27 13:11:49 2010 -0400

    GSettings schema docs: mention need for EXTRA_DIST
    
    Mention that you will need to use EXTRA_DIST for your schema file if it
    is distributed with your project.

 docs/reference/gio/migrating-gconf.xml |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gio/migrating-gconf.xml b/docs/reference/gio/migrating-gconf.xml
index ae91424..8df80cd 100644
--- a/docs/reference/gio/migrating-gconf.xml
+++ b/docs/reference/gio/migrating-gconf.xml
@@ -248,6 +248,16 @@ gsettings_SCHEMAS = my.app.gschema.xml
       </para>
 
       <para>
+        This is not sufficient on its own.  You need to mention what the source
+        of the <filename>my.app.gschema.xml</filename> file is.  If the schema
+        file is distributed directly with your project's tarball then a mention
+        in <varname>EXTRA_DIST</varname> is appropriate.  If the schema file is
+        generated from another source then you will need the appropriate rule
+        for that, plus probably an item in <varname>EXTRA_DIST</varname> for the
+        source files used by that rule.
+      </para>
+
+      <para>
         One possible pitfall in doing schema conversion is that the default
         values in GSettings schemas are parsed by the #GVariant parser.
         This means that strings need to include quotes in the XML.  Also note



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]