• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1Boost Graph Library
2===================
3
4A generic interface for traversing graphs, using C++ templates.
5
6The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/graph/doc/index.html).
7
8## Support, bugs and feature requests ##
9
10Bugs and feature requests can be reported through the [Trac issue tracker](https://svn.boost.org/trac/boost/query?component=graph&desc=1&order=id)
11(see [open issues](https://svn.boost.org/trac/boost/query?status=!closed&component=graph&desc=1&order=id) and
12[closed issues](https://svn.boost.org/trac/boost/query?status=closed&component=graph&col=id&col=summary&col=status&col=owner&col=type&col=milestone&col=version&desc=1&order=id)). [Here](http://lists.boost.org/Archives/boost/2015/04/221780.php) is why Trac is still in use.
13
14You can submit your changes through a [pull request](https://github.com/boostorg/graph/pulls). One of the maintainers will take a look (remember that it can take some time).
15
16There is no mailing-list specific to Boost Graph, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [graph].
17
18
19## Development ##
20
21Clone the whole boost project, which includes the individual Boost projects as submodules ([see boost+git doc](https://github.com/boostorg/boost/wiki/Getting-Started)):
22
23    git clone https://github.com/boostorg/boost
24    cd boost
25    git submodule update --init
26
27The Boost Graph Library is located in `libs/graph/`.
28
29Boost Graph Library is mostly made of headers but also contains some compiled components. Here are the build commands:
30
31    ./bootstrap.sh            <- compile b2
32    ./b2 headers              <- just installs headers
33    ./b2                      <- build compiled components
34
35**Note:** The Boost Graph Library cannot currently be built outside of Boost itself.
36
37### Running tests ###
38First, make sure you are in `libs/graph/test`.
39You can either run all the 300+ tests listed in `Jamfile.v2` or run a single test:
40
41    ../../../b2                        <- run all tests
42    ../../../b2 cycle_canceling_test   <- single test
43
44You can also check the [regression tests reports](http://beta.boost.org/development/tests/develop/developer/graph.html).
45