Backport lots of new features from the 1.41.0 branch.
[boost:cmake.git] / tools / build / CMake / docs / build / html / _sources / index.txt
1 .. boost-cmake documentation master file, created by
2    sphinx-quickstart on Mon May 11 08:53:19 2009.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6
7 Boost-CMake |release|
8 =====================
9
10 Boost.\ `CMake <http://www.cmake.org>`_ is an alternate
11 build system for boost, under development since boost version 1.35.
12 As of Boost version 1.38, boost.cmake can reliably build and
13 package boost.  
14
15 .. index:: Mailing List, IRC
16
17 **boost-cmake mailing list**    
18   http://lists.boost.org/mailman/listinfo.cgi/boost-cmake      
19 **IRC**             
20   ``#boost-cmake`` on the `freenode network <http://freenode.net>`_
21 **CMake/CTest regression testing of boost**
22   http://www.cdash.org/CDashPublic/index.php?project=Boost
23 **CMake home page** 
24   http://www.cmake.org
25
26 Users's guide
27 =============
28
29 .. toctree::
30    :maxdepth: 3
31
32    quickstart
33    build_configuration
34    build_variants
35    exported_targets
36    testing
37    individual_libraries
38    add_boost_library
39    add_compiled_library
40    adding_regression_tests
41    build_installer
42    external_dependencies
43    notes_by_version
44
45 .. modularize_library
46
47 Reference
48 =========
49
50 .. toctree::
51    :maxdepth: 1
52
53    reference/boost_library_project
54    reference/boost_module
55    reference/boost_add_library
56    reference/boost_add_executable
57    reference/boost_python_module
58    reference/boost_additional_test_dependencies
59    reference/boost_test_compile
60    reference/boost_test_compile_fail
61    reference/boost_test_run
62    reference/boost_test_run_fail
63
64 About this documentation
65 ========================
66
67 This documentation was created with `Sphinx
68 <http://sphinx.pocoo.org>`_.  
69
70 The source is in the restructuredtext files in subdirectory
71 ``tools/build/CMake/docs/source/``.  Hack on them (see the
72 `documentation for Sphinx <http://sphinx.pocoo.org/contents.html>`_).
73 When you're ready to see the html::
74
75   make html
76
77 Once you've written a ton of docs, push them someplace where I can see
78 them (or use ``git diff`` to send a patch).
79
80 Release checklist
81 =================
82
83 * Update ``BOOST_CMAKE_VERSION`` in toplevel ``CMakeLists.txt``
84 * Update notes by version in ``tools/build/CMake/docs/notes_by_version.rst``
85 * Reconfig cmake with ``BOOST_MAINTAINER`` set to ON
86 * Rebuild docs and commit
87 * Tag commit with ``BOOST_CMAKE_VERSION``
88 * ``make do-release``
89
90 Index
91 =====
92
93 :ref:`genindex`
94
95