Library format required for inclusion in Boost
Hi, I'd like to ask a few questions about what libraries that wish to be included into Boost must look like, and I would like to know whether libraries need to fulfill those requirements for the review or can do so later. Build system: integration with Boost.Build is necessary, additional CMake scripts is a plus. Documentation: the Boostbook toolchain seems recommended, but not necessary. Is that correct? How free are we? Does the documentation necessarily need to be generated with Boost.Build as well? Test system: something that the regression test suite can eat. What is that format? Is that restricted to Boost.Test run through Boost.Build?
AMDG On 03/22/2011 05:11 PM, Mathias Gaunard wrote:
I'd like to ask a few questions about what libraries that wish to be included into Boost must look like, and I would like to know whether libraries need to fulfill those requirements for the review or can do so later.
Personally, for build-system things, as long as it's basic enough that it's not too hard to set up the Jamfiles (which should be most libraries. Complicated configuration should not be the norm), I don't really care whether they're done before the review. It takes a bit of work to get it integrated into the trunk anyway.
Build system: integration with Boost.Build is necessary, additional CMake scripts is a plus.
Yep.
Documentation: the Boostbook toolchain seems recommended, but not necessary. Is that correct?
Yep.
How free are we? Does the documentation necessarily need to be generated with Boost.Build as well?
If it requires building, then it should use Boost.Build. If you just check in html, then no.
Test system: something that the regression test suite can eat. What is that format? Is that restricted to Boost.Test run through Boost.Build?
It doesn't have to use Boost.Test. It does need to use the Boost.Build testing modules (run, compile, compile-fail, etc.) and it needs to be run by status/Jamfile.v2 In Christ, Steven Watanabe
Message du 23/03/11 01:13 De : "Mathias Gaunard" A : boost@lists.boost.org Copie à : Objet : [boost] Library format required for inclusion in Boost
Hi,
I'd like to ask a few questions about what libraries that wish to be included into Boost must look like, and I would like to know whether libraries need to fulfill those requirements for the review or can do so later.
Build system: integration with Boost.Build is necessary, additional CMake scripts is a plus.
Documentation: the Boostbook toolchain seems recommended, but not necessary. Is that correct? How free are we? Does the documentation necessarily need to be generated with Boost.Build as well?
Test system: something that the regression test suite can eat. What is that format? Is that restricted to Boost.Test run through Boost.Build?
Hi Mathias, the experience show that there are not too much formal constraints, but been able to build with bjam seem to me one of the requirements as most of the boost community has already it installed, and provide a portable build. Note, that if the library is accepted you will need to move to Boost.Build, so if you have already do the step, the boost community will surely take it in account, or the contrary if you have not done it yet and you force them to install something to check your library. Respect to documentation it is enough to provide html files, of course, a lot of reveiwers like the look for the files generated using quickbook, others find also that the use of doxygen is a must. The main advantage I see is to been able to provide also a pdf file, but the same goal can be achieved by other means. For the test, I used to use Boost.Test, but I don't remember from when cygwin is no supported anymore. I have moved to the detail/lightweight.hpp file and I'm quite satisfied with. So resumming the form is not a pre-requisite but submitting a library that uses what other accepted libraries use can help: Boost,Build, QuickBook+Doxygen seems a good starting point. Of course, the library will be reviewed taking in account other factors that are much more important ;-) HTH,, Vicente
I'd like to ask a few questions about what libraries that wish to be included into Boost must look like, and I would like to know whether libraries need to fulfill those requirements for the review or can do so later.
Build system: integration with Boost.Build is necessary, additional CMake scripts is a plus.
Boost.Build yes, CMake no.
Documentation: the Boostbook toolchain seems recommended, but not necessary. Is that correct?
Yes.
How free are we? Does the documentation necessarily need to be generated with Boost.Build as well?
No... but IMO there are advantages to using the Quickbook/Docbook toolchain such as a unified look and feel, and automatic PDF releases.
Test system: something that the regression test suite can eat. What is that format? Is that restricted to Boost.Test run through Boost.Build?
No, anything that Boost.Build can eat, which means pretty much anything really. HTH, John.
participants (4)
-
John Maddock -
Mathias Gaunard -
Steven Watanabe -
Vicente BOTET