mirror of
https://github.com/boostorg/test.git
synced 2026-02-16 01:42:11 +00:00
2a09f41176
* master: (54 commits) Closing issue 7894 Some more changelog Making the release name appear as well Change log update Removed postponed issue Update of the change log Change log already addressed Thread: merge [81791]-tools dir missing Spirit: merging from trunk upto rev. 61489 Merge r62426 from ^/trunk ------------------------------------------------------------------------ r62426 | jhunold | 2010-06-04 16:31:54 +0200 (Fr, 04 Jun 2010) | 2 lines Reverted an accidental commit. Merged changes from trunk (rev. 62450). Fixes #3876. merge into release merge into release merge memory fix. Fixes #2889 rm cmake from the release branch before it goes out broken. Policy dictates that you never commit to release, you commit to trunk and merge to release. Add basic copyright/license to keep cmake out of the inspection report Trunk version of Boost.Test finally being released Fixed broken merges from last commit; kept boost::next and boost::prior changes to BGL that went in by accident in that commit, though Fixed almost all tab and min/max issues found by inspect tool ... Conflicts: doc/closing_chapters/change_log.qbk
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