From e42ff0105d19be382f6c4e460c46ac9e18f92b25 Mon Sep 17 00:00:00 2001
From: Philip Withnall <withnall@endlessm.com>
Date: Mon, 8 Jan 2018 12:00:39 +0000
Subject: [PATCH] docs: Mention that we build with strict-aliasing disabled

Hopefully discouraging people from overriding that and building with it
enabled.

Pro-tip: GLib will break.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=791622
---
 docs/reference/glib/building.xml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/reference/glib/building.xml b/docs/reference/glib/building.xml
index 1652add67..57c3c8c7d 100644
--- a/docs/reference/glib/building.xml
+++ b/docs/reference/glib/building.xml
@@ -41,6 +41,13 @@
       <command>./configure --help</command> for information about
       the standard options.
     </para>
+    <para>
+      GLib is compiled with
+      <ulink url="https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html#index-fstrict-aliasing">strict aliasing</ulink>
+      disabled. It is strongly recommended that this is not re-enabled by
+      overriding the compiler flags, as GLib has not been tested with strict
+      aliasing and cannot be guaranteed to work.
+    </para>
     <para>
       The GTK+ documentation contains
       <ulink url="https://developer.gnome.org/gtk3/stable/gtk-building.html">further details</ulink>