ceph/src/boost/libs/tti/doc/build.txt

   1 (C) Copyright Edward Diener 2011-2013
   2 Distributed under the Boost Software License, Version 1.0.
   3 (See accompanying file LICENSE_1_0.txt or copy at
   4 http://www.boost.org/LICENSE_1_0.txt).
   5
   6 The library comes with full documentation with an index,
   7 in both HTML and PDF format. The HTML documentation is at
   8 tti\libs\tti\doc\html\index.html and the PDF documentation
   9 is at tti\libs\tti\doc\TypeTraitsIntrospection.pdf.
  10
  11 You can use the jamfile in the doc directory to regenerate
  12 the documentation for this library.
  13
  14 Add '--enable-index' to the command line to have an index
  15 with the documentation. Add 'pdf' on the command line to
  16 regenerate the PDF documentation.
  17
  18 You can use the jamfile in the test directory to
  19 run the tests for this library.
  20
  21 When running the tests you can use either of
  22 three main targets if you like. Executing the jamfile without a
  23 target, or specifying the target 'tti', will run tests for both
  24 basic TTI and for the variadic macro portion of TTI. You can run
  25 tests for only the basic TTI, which is the vast majority of TTI
  26 functionality, by specifying only the 'ttinovm' target when
  27 executing the jamfile. If you just want to run the tests for the
  28 variadic macro portion of TTI, specify the target as 'ttivm'.
  29
  30 You need only execute 'bjam' in the jamfile directories
  31 to regenerate the docs or run the test.
  32
  33 If you want to contact me directly, my name is
  34 Edward Diener and you can reach me at
  35 eld@tropicsoft.com. I am an independent computer
  36 consultant with my own company, I live in Atlanta, Georgia,
  37 and I am always looking for exciting projects on which to
  38 work for a living.
  39
  40 You can also of course use the Boost newsgroups
  41 to ask questions and make comments or suggestions
  42 about the library.