Re: [boost] Review request: auto-index tool

Subject: Re: [boost] Review request: auto-index tool
From: Bryce Lelbach (admin_at_[hidden])
Date: 2011-01-21 13:03:11

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Fri, 21 Jan 2011 16:35:08 -0000
John Maddock <boost.regex_at_[hidden]> wrote:

> FYI the code in Trunk for math/type_traits/spirit makes auto-index use 
> entirely optional: if you build with "bjam --enable-index" then you need to 
> have built and installed auto-index, otherwise the indexes just get 
> completely ignored and don't appear in the output.

John, docs for ^, if you want 'em: 

Index: auto_index.qbk
===================================================================
- --- auto_index.qbk	(revision 68353)
+++ auto_index.qbk	(working copy)
@@ -183,6 +183,19 @@
         defaults to "section", but could equally be "appendix" or "chapter" or some other block level element that has a formal title.]]
 ]
 
+It is possible to make the use of auto-index optional in Boost.Build, to allow
+users who do not have auto-index installed to build your documentation. One
+method of setting up optional auto-index support is to place all auto-index
+configuration in a the body of a bjam if statement:
+
+  if --enable-index in  [ modules.peek : ARGV ]
+  {
+     using auto-index ;
+     project : requirements
+          <auto-index>on
+          <auto-index-script>index.idx
+          ;
+  }
 
 [h4 Step 3: Add indexes to your documentation]
 
- -- 
Bryce Lelbach aka wash
boost-spirit.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)

iEYEARECAAYFAk05yl8ACgkQ9cB/V3/s9EwfXQCgqfDURZ09Bo7oUt4IsBZAoBEz
X3EAnjq1z591SmBFAsIVFBm3spdRSseL
=KBvH
-----END PGP SIGNATURE-----