| | 1 | == Boost Sandbox == |
| | 2 | The Boost Sandbox (housed in the `sandbox` subdirectory of the Subversion repository) contains unreviewed code that is intended to eventually become a part of the Boost libraries. Because there are typically many projects in the sandbox at any one time (in various stages of development), the sandbox should be organized by project. Each project should have its own subdirectory inside `sandbox`. For example, a new XML library would reside in `sandbox/xml`. Inside that project-specific subdirectory, the project should be organized like any other Boost library, with a `boost` subdirectory (for headers) and `libs` subdirectory (for source code, build files, and documentation). Our hypothetical XML project would likely have the following structure: |
| | 3 | |
| | 4 | sandbox/xml/ |
| | 5 | boost/ - Contains xml.hpp, which includes all of the headers from xml/ |
| | 6 | xml/ - Contains Boost.XML headers |
| | 7 | libs/ |
| | 8 | xml/ |
| | 9 | build/ - Contains Jamfiles to build Boost.XML |
| | 10 | |
| | 11 | doc/ - Contains documentation for Boost.XML |
| | 12 | |
| | 13 | src/ - Contains Boost.XML compiled source files |
| | 14 | |
| | 15 | Many existing projects in the sandbox do not follow this structure, opting to place headers in `sandbox/boost` and supporting files in `sandbox/libs`. We encourage developers to migrate these projects to the project-centric organizational structure. |
| | 16 | |
| | 17 | Anyone interested in Boost development is welcome to work on code within the sandbox. Just follow the instructions for [BoostSubversion access the Boost Subversion Repository] to get a developer account to the sandbox. |
| | 18 | |
| | 19 | |
| | 20 | |
