Getting Started with Modular Boost Library Maintenance

This page describes the mechanics of maintaining a Boost library using Git and Modular Boost.

The intended audience is developers involved in the maintenance of existing Boost libraries.

Prerequisites

• A recent release of the Git command line client installed. See Getting Started with Git.
• A (free) ​GitHub account. See Getting Started with GitHub.
• A compiler and development environment installed and working smoothly.
• Modular Boost installed as described in Getting Started with Modular Boost.
• b2 in your path. That allows most of the command line examples given here to work as shown on both Windows and POSIX-like systems.

Verify Tests Working

Before making any changes to you library, which we will call mylib, be sure the test suite is working in the modular Boost environment:

cd modular-boost/libs/mylib
git checkout develop
git pull
cd test
b2

Fix a simple bug

These commands could be used for any Git project, modular or not, so hopefully you are already somewhat familiar with them:

cd /modular-boost/libs/mylib
git checkout develop
# make edits
# test as above
git commit -a -m "my bug fix"
git push

Simple bugs are usually fixed on the develop branch - there is usually no need to first create a bug-fix branch.