summaryrefslogtreecommitdiffstats
path: root/src/boost/libs/graph/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
commit483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch)
treee5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /src/boost/libs/graph/README.md
parentInitial commit. (diff)
downloadceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz
ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/boost/libs/graph/README.md')
-rw-r--r--src/boost/libs/graph/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/src/boost/libs/graph/README.md b/src/boost/libs/graph/README.md
new file mode 100644
index 00000000..7a4dc735
--- /dev/null
+++ b/src/boost/libs/graph/README.md
@@ -0,0 +1,44 @@
+Boost Graph Library
+===================
+
+A generic interface for traversing graphs, using C++ templates.
+
+The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/graph/doc/index.html).
+
+## Support, bugs and feature requests ##
+
+Bugs and feature requests can be reported through the [Trac issue tracker](https://svn.boost.org/trac/boost/query?component=graph&desc=1&order=id)
+(see [open issues](https://svn.boost.org/trac/boost/query?status=!closed&component=graph&desc=1&order=id) and
+[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.
+
+You 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).
+
+There 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].
+
+
+## Development ##
+
+Clone the whole boost project, which includes the individual Boost projects as submodules ([see boost+git doc](https://github.com/boostorg/boost/wiki/Getting-Started)):
+
+ git clone https://github.com/boostorg/boost
+ cd boost
+ git submodule update --init
+
+The Boost Graph Library is located in `libs/graph/`.
+
+Boost Graph Library is mostly made of headers but also contains some compiled components. Here are the build commands:
+
+ ./bootstrap.sh <- compile b2
+ ./b2 headers <- just installs headers
+ ./b2 <- build compiled components
+
+**Note:** The Boost Graph Library cannot currently be built outside of Boost itself.
+
+### Running tests ###
+First, make sure you are in `libs/graph/test`.
+You can either run all the 300+ tests listed in `Jamfile.v2` or run a single test:
+
+ ../../../b2 <- run all tests
+ ../../../b2 cycle_canceling_test <- single test
+
+You can also check the [regression tests reports](http://beta.boost.org/development/tests/develop/developer/graph.html).