From bfb98081c448458cd05a7870eab45e654eac0a92 Mon Sep 17 00:00:00 2001
From: Andrew Featherstone <andrew.featherstone@cantab.net>
Date: Mon, 21 Jul 2014 23:36:03 +0100
Subject: Adds basic documentation of the CheckTypeSize method.

---
 doc/scons.mod      |  1 +
 doc/user/sconf.xml | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/doc/scons.mod b/doc/scons.mod
index be2dc24..72dc7ff 100644
--- a/doc/scons.mod
+++ b/doc/scons.mod
@@ -277,6 +277,7 @@
 <!ENTITY CheckLib "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckLib</function>">
 <!ENTITY CheckLibWithHeader "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckLibWithHeader</function>">
 <!ENTITY CheckType "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckType</function>">
+<!ENTITY CheckTypeSize "<function xmlns='http://www.scons.org/dbxsd/v1.0'>CheckTypeSize</function>">
 <!ENTITY TryAction "<function xmlns='http://www.scons.org/dbxsd/v1.0'>TryAction</function>">
 <!ENTITY TryBuild "<function xmlns='http://www.scons.org/dbxsd/v1.0'>TryBuild</function>">
 <!ENTITY TryCompile "<function xmlns='http://www.scons.org/dbxsd/v1.0'>TryCompile</function>">
diff --git a/doc/user/sconf.xml b/doc/user/sconf.xml
index ff39b6b..214569d 100644
--- a/doc/user/sconf.xml
+++ b/doc/user/sconf.xml
@@ -282,6 +282,26 @@ env = conf.Finish()
     </sconstruct>
 
   </section>
+  <section>
+  <title>Checking the size of a datatype</title>
+    <para>
+    Check the size of a datatype by using the &CheckTypeSize; method:
+    </para>
+    
+    <sconstruct>
+env = Environment()
+conf = Configure(env)
+int_size = conf.CheckTypeSize('unsigned int')
+print 'sizeof unsigned int is', int_size
+env = conf.Finish()
+    </sconstruct>
+    
+    <screen>
+% <userinput>scons -Q</userinput>
+sizeof unsigned int is 4
+scons: `.' is up to date.
+    </screen>
+  </section>
 
   <section>
   <title>Adding Your Own Custom Checks</title>
-- 
cgit v0.12