[Boost-commit] svn:boost r48119 - sandbox/tools/profile_templates/doc

From: steven_at_[hidden]
Date: 2008-08-12 23:01:36

Author: steven_watanabe
Date: 2008-08-12 23:01:35 EDT (Tue, 12 Aug 2008)
New Revision: 48119
URL: http://svn.boost.org/trac/boost/changeset/48119

Log:
Initial docs
Added:
   sandbox/tools/profile_templates/doc/
   sandbox/tools/profile_templates/doc/Jamfile.v2   (contents, props changed)
   sandbox/tools/profile_templates/doc/template_profile.qbk   (contents, props changed)

Added: sandbox/tools/profile_templates/doc/Jamfile.v2
==============================================================================
--- (empty file)
+++ sandbox/tools/profile_templates/doc/Jamfile.v2	2008-08-12 23:01:35 EDT (Tue, 12 Aug 2008)
@@ -0,0 +1,13 @@
+# Jamfile.v2
+#
+# Copyright (c) 2008
+# Steven Watanabe
+#
+# Distributed under the Boost Software License, Version 1.0. (See
+# accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt
+
+import quickbook ;
+using boostbook ;
+
+boostbook standalone : template_profile.qbk ;

Added: sandbox/tools/profile_templates/doc/template_profile.qbk
==============================================================================
--- (empty file)
+++ sandbox/tools/profile_templates/doc/template_profile.qbk	2008-08-12 23:01:35 EDT (Tue, 12 Aug 2008)
@@ -0,0 +1,43 @@
+[article Template Profiler
+    [quickbook 1.4]
+    [authors [Watanabe, Steven]]
+    [copyright 2008 Steven Watanabe]
+    [license]
+    [license
+      Distributed under the Boost Software License, Version 1.0.
+      (See accompanying file LICENSE_1_0.txt or copy at
+      [@http://www.boost.org/LICENSE_1_0.txt])
+    ]
+    [purpose Count template instantiations]
+]
+
+[section Usage]
+
+In order to use the template profiler, create
+a Jamfile which contains the following:
+
+[pre
+import template-profile ;
+template-profile foo : foo.cpp ;
+]
+
+[note You will need to make sure that the tool's root
+directory is in BOOST_BUILD_PATH
+]
+
+[endsect]
+
+[section Internals]
+
+The template profiler can be broken down into
+the following steps.
+
+# Preprocess the source
+# Run the preprocessor's output through preprocess.pl
+  which adds code that generates a warning at the beginning
+  of every class and function.
+# compile the result and capture the compiler's output
+# Parse the compiler's output, searching for the warnings
+  inserted in stage 2.
+
+[endsect]