2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-25 06:42:22 +00:00
Files
test/doc
Raffi Enficiaud 40439a6593 Merge branch 'develop' into local/new_filtering_merge
* develop: (62 commits)
  Fixing tests on GCCs
  Fixing test on GCCs
  Fixing the tests of this file for GCCs
  Fix collection test on Gccs
  Adding support for C++11 to old gcc compilers as well Fixing issues with arrays
  Fixing counter for r-value ref supported but std::vector still lacking the proper constructor
  Once for all the "Mismatch at" instead of "Mismatch in" for every type of collection
  silence a warning in gcc 4.5
  Revert "introduce fpc::tolerance_based to be used instead of if_floating_point. This should allow us to extend tolerance based comparisons t omore types"
  Revert "introduce fpc::tolerance_based to be used instead of is_floating_point. This should allow us to extend tolerance based comparisons t omore types"
  introduce fpc::tolerance_based to be used instead of is_floating_point. This should allow us to extend tolerance based comparisons t omore types
  introduce fpc::tolerance_based to be used instead of if_floating_point. This should allow us to extend tolerance based comparisons t omore types
  remove executable from header
  remove executable form header
  fix MSVC-12 tests
  ENABLE new test tools fix few leftovers from implementation of new FPV comparisons restore test case in test_fp_comparisons.cpp
  test to clear the error on CrystaX runners
  some doc
  const of the elements of the table
  Trying to fix the array problem on Clang 3.4
  ...

Conflicts:
	doc/examples.qbk
	doc/test_organization/decorators.qbk
	doc/test_organization/parametric_test_case_generation.qbk
	include/boost/test/data/monomorphic/fwd.hpp
	include/boost/test/data/monomorphic/generators/random.hpp
	include/boost/test/data/monomorphic/singleton.hpp
	include/boost/test/tools/floating_point_comparison.hpp
	test/test_files/test_tools_test.pattern
2015-03-25 22:19:11 +01:00
..
2015-01-08 14:01:46 +01:00
2015-02-11 14:22:13 -05:00
2015-02-11 14:22:13 -05:00
2015-02-03 02:14:06 +01:00
2015-02-03 02:46:52 +01:00
ras
2015-03-17 00:44:17 +01:00
2015-01-06 01:22:36 +01:00
2015-02-03 02:59:03 +01:00
2015-01-03 19:45:01 +01:00
2015-01-04 20:44:51 +01:00
2015-01-09 10:50:10 +01:00
2015-01-06 01:24:03 +01:00

This folder contains the documentation for the Boost.Test library. 
Any contribution or submission to the library should be accompanied by the corresponding documentation. 

The format of the documentation uses [http://www.boost.org/tools/quickbook/index.html Quickbook]. 

How to build the documentation
==============================


Install Doxygen
---------------
Part of the documentation needs [http://www.doxygen.org Doxygen]. Download and install it. `doxygen` should be accessible from the terminal.

Download Docbook
----------------
Quickbook needs docbook to be installed. Download and untar the docbook archives:

* Docbook XSL that can be found here: 
* Docbook XML that can be found here:

These two archives are supposed to be untarred to `$docbook_xsl_directory` and `$docbook_xml_directory` respectively. 


Download xsltproc
-----------------
This program is needed by docbook, in order to be able to transform XMLs into HTMLs.
`xsltproc` should be accessible from the command line. 


Construct bjam
--------------

Simply by typing in a terminal:
``
> cd $boost_root
> ./bootstrap.[sh|bat]

``

Build the documentation
-----------------------

``
> cd $boost_root/libs/test/doc
> ../../../b2 -sDOCBOOK_XSL_DIR=$docbook_xsl_directory -sDOCBOOK_DTD_DIR=$docbook_xml_directory
``


Recommendations
---------------

- Documentation is part of the "definition of done". A feature does not exist until it is implemented, tested, documented and reviewed. 
- It is highly recommended that each of your pull request comes with an updated documentation. Not doing so put this work on the shoulders
  of the maintainers and as a result, it would be likely that the pull request is not addressed in a timely manner.
- Please also update the changelog for referencing your contribution
- Every file should come with a copyright notice on the very beginning