wiki:HeaderModularization

Header Modularization

Goals/Objectives/Needs/Wants

  1. Requires no Boost or user code changes.
  2. Single include path (-I...). Without a single include path, builds, IDE's, and other tools become unmanageable.
  3. Easy checkout, commit, merge, switch, and other source control operations. Implies no separate checkout, update, commit, switch, etc. post-processing step.)
  4. Works well regardless of build engine, not just with bjam or CMake.
  5. Doesn't break users existing scripts, IDE setups, etc. OK to break developers and release managers scripts.
  6. Easy library subset creation. (Ignoring the dependency problem; that's orthogonal.)
  7. Minimizes developer mistakes like failure to merge, commit, all files that changed.
  8. All maintenance occurs withing the library's libs/... directory. (Subset of previous entry, but important enough to list separately.)
  9. Easy scripting (inspect, unmerged changes, release management, etc.) (Previous entry goes a long way to achieve this.)
  10. Works well with out-of-the box subversion, bjam, CMake, installers, and other tools we are likely to use.
  11. Supports test-on-demand and test-library-against-different-branch.
  12. Doesn't waste disk space excessively.

Possible Approaches

  1. Status quo.
  2. svn:externals.
  3. Copy header directories to ../../boost via post-svn step.
  4. Move header directories to ../../boost via post-svn step.
  5. Forwarding headers (in svn).
  6. Forwarding headers via post-svn step.
  7. Symlinks from root/boost/... to boost-root/libs/... via post-svn step.
  8. Hard links from root/boost/... to boost-root/libs/... via post-svn step.
  9. Move (permanently) each library's root/libs/libname contents into root/boost/libname for the library.

Acknowledgements

Troy Straszheim, Vladimir Prus, Daniel James, Robert Ramey, Stefan Seefeld, and all the others who contributed modularization ideas.

Last modified 13 years ago Last modified on May 27, 2009, 5:07:04 PM
Note: See TracWiki for help on using the wiki.