• Home
Name Date Size #Lines LOC

..--

adv_scenarios/12-May-2024-738543

closing_chapters/12-May-2024-884713

doxygen/12-May-2024-2,3581,821

examples/12-May-2024-5,2133,321

html/12-May-2024-59,14457,250

introduction/12-May-2024-140103

prod_use/12-May-2024-282199

runtime_configuration/12-May-2024-1,5481,101

snippet/12-May-2024-748435

test_organization/12-May-2024-2,4701,795

test_output/12-May-2024-1,026768

testing_tools/12-May-2024-2,2151,559

tutorials/12-May-2024-227173

Jamfile.v2D12-May-20246.3 KiB155128

README.mdD12-May-20242.2 KiB6949

adv_scenarios.qbkD12-May-20242.8 KiB5343

doxygen_reference_generated_doc.xmlD12-May-2024273.6 KiB3,2862,181

test.qbkD12-May-202415 KiB254183

usage_recommendations.qbkD12-May-20246.8 KiB167118

usage_variants.qbkD12-May-20244.9 KiB10383

README.md

1This folder contains the documentation for the Boost.Test library.
2Any contribution or submission to the library should be accompanied by the corresponding documentation.
3
4The format of the documentation uses [Quickbook](http://www.boost.org/tools/quickbook/index.html).
5
6How to build the documentation
7==============================
8
9In order to generate the documentation, the following is needed:
10
11* Docbook
12* Doxygen
13* xsltproc
14
15Doxygen
16-------
17Part of the documentation needs [Doxygen](http://www.doxygen.org). `doxygen` should be accessible from the ``PATH``.
18
19Docbook
20-------
21Quickbook needs Docbook (XSL and XML) to be installed. Download and untar the docbook archives:
22
23* Docbook XSL that can be found here: http://sourceforge.net/projects/docbook/files/docbook-xsl/
24* Docbook DTD that can be found here: http://www.docbook.org/schemas/
25
26The directories `$docbook_xsl_directory` and `$docbook_dtd_directory`, respectively, will refer to the location
27of the deflated archive.
28
29Download xsltproc
30-----------------
31This program is needed by Docbook, in order to be able to transform XMLs into HTMLs.
32`xsltproc` should be accessible from the ``PATH``.
33
34Construct b2
35------------
36
37Simply by typing in a console at the root of the Boost repository:
38
39```
40> ./bootstrap.[sh|bat]
41```
42
43Build the documentation
44-----------------------
45
46Running the following commands will construct the documentation with `b2` and
47all the needed dependencies:
48
49````
50> cd $boost_root/libs/test/doc
51> ../../../b2 -sDOCBOOK_XSL_DIR=$docbook_xsl_directory -sDOCBOOK_DTD_DIR=$docbook_dtd_directory
52```
53
54It is possible to run directly
55```
56> ../../../b2
57```
58
59but this results in a download from the Internet of the Docbook XLS and DTD, which is much slower.
60
61Recommendations
62===============
63
64- Documentation is part of the "definition of done". A feature does not exist until it is implemented, tested, documented and reviewed.
65- It is highly recommended that each of your pull request comes with an updated documentation. Not doing so put this work on the shoulders
66  of the maintainers and as a result, it would be likely that the pull request is not addressed in a timely manner.
67- Please also update the changelog for referencing your contribution
68- Every file should come with a copyright notice on the very beginning
69