Improve documentation around deprecations

diff --git a/docs/reference/glib/Makefile.am b/docs/reference/glib/Makefile.am
index beac383..154936b 100644 (file)
--- a/docs/reference/glib/Makefile.am
+++ b/docs/reference/glib/Makefile.am
@@ -64,7 +64,6 @@ content_files =                               \
        running.sgml                    \
        building.sgml                   \
        changes.sgml                    \
-       compiling.sgml                  \
        resources.sgml                  \
        regex-syntax.sgml               \
        version.xml                     \
@@ -74,6 +73,9 @@ content_files =                               \
        gvariant-varargs.xml            \
        gvariant-text.xml
 
+expand_content_files =                         \
+       compiling.sgml
+
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../gobject/html --extra-dir=$(srcdir)/../gio/html
 

diff --git a/docs/reference/glib/compiling.sgml b/docs/reference/glib/compiling.sgml
index fb43b09..56608cc 100644 (file)
--- a/docs/reference/glib/compiling.sgml
+++ b/docs/reference/glib/compiling.sgml
@@ -75,7 +75,7 @@ Deprecated GLib functions are annotated to make the compiler
 emit warnings when they are used (e.g. with gcc, you need to use
 the -Wdeprecated-declarations option). If these warnings are
 problematic, they can be turned off by defining the preprocessor
-symbol GLIB_DISABLE_DEPRECATION_WARNINGS by using the commandline
+symbol %GLIB_DISABLE_DEPRECATION_WARNINGS by using the commandline
 option <literal>-DGLIB_DISABLE_DEPRECATION_WARNINGS</literal>
 </para>
 

diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml
index 2c25b9e..74fc48a 100644 (file)
--- a/docs/reference/glib/glib-docs.sgml
+++ b/docs/reference/glib/glib-docs.sgml
@@ -32,7 +32,7 @@
 
     <xi:include href="building.sgml" />
     <xi:include href="cross.sgml" />
-    <xi:include href="compiling.sgml" />
+    <xi:include href="xml/compiling.sgml" />
     <xi:include href="running.sgml" />
     <xi:include href="changes.sgml" />
     <xi:include href="resources.sgml" />

diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 5f28216..ef1b562 100644 (file)
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -120,6 +120,7 @@ GLIB_VERSION_2_30
 GLIB_VERSION_2_32
 GLIB_VERSION_MIN_REQUIRED
 GLIB_VERSION_MAX_ALLOWED
+GLIB_DISABLE_DEPRECATION_WARNINGS
 </SECTION>
 
 <SECTION>

diff --git a/glib/docs.c b/glib/docs.c
index a7a6cde..a3d862c 100644 (file)
--- a/glib/docs.c
+++ b/glib/docs.c
@@ -2052,6 +2052,14 @@
  */
 
 /**
+ * GLIB_DISABLE_DEPRECATION_WARNINGS:
+ *
+ * A macro that should be defined before including the glib.h header.
+ * If it is defined, no compiler warnings will be produced for uses
+ * of deprecated GLib APIs.
+ */
+
+/**
  * G_GNUC_NORETURN:
  *
  * Expands to the GNU C <literal>noreturn</literal> function attribute