projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 92f5a8d4 TL |
1 | Boost Regex Library |
| 2 | ============================ | |
| 3 | ||
| 4 | The Boost Regex library provides regular expression support for C++, this library is the ancestor to std::regex and still goes beyond | |
| 5 | and offers some advantages to, the standard version. | |
| 6 | ||
| 7 | The full documentation is available on [boost.org](http://www.boost.org/doc/libs/release/libs/regex/index.html). | |
| 8 | ||
| 1e59de90 TL |
9 | ## Standalone Mode ## |
| 10 | ||
| 11 | This library may now be used in "standalone" mode without the rest of the Boost C++ libraries, in order to do this you must either: | |
| 12 | ||
| 13 | * Have a C++17 compiler that supports __has_include, in this case if <boost/config.hpp> is not present then the library will automoatically enter standalone mode. Or: | |
| 14 | * Define BOOST_REGEX_STANDALONE when building. | |
| 15 | ||
| 16 | The main difference between the 2 modes, is that when Boost.Config is present the library will automatically configure itself around various compiler defects. In particular in order to use the library with exception support turned off, you will either need a copy of Boost.Config in your include path, or else manually define BOOST_NO_EXCEPTIONS when building. | |
| 17 | ||
| 18 | In any event, to obtain a standalone version of this library, simply download a .zip of the "master" branch of this repository. | |
| 19 | ||
| 92f5a8d4 TL |
20 | ## Support, bugs and feature requests ## |
| 21 | ||
| 22 | Bugs and feature requests can be reported through the [Gitub issue tracker](https://github.com/boostorg/regex/issues) | |
| 23 | (see [open issues](https://github.com/boostorg/regex/issues) and | |
| 24 | [closed issues](https://github.com/boostorg/regex/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed)). | |
| 25 | ||
| 26 | You can submit your changes through a [pull request](https://github.com/boostorg/regex/pulls). | |
| 27 | ||
| 28 | There is no mailing-list specific to Boost Regex, although you can use the general-purpose Boost [mailing-list](http://lists.boost.org/mailman/listinfo.cgi/boost-users) using the tag [regex]. | |
| 29 | ||
| 30 | ||
| 31 | ## Development ## | |
| 32 | ||
| 33 | 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)): | |
| 34 | ||
| 35 | git clone https://github.com/boostorg/boost | |
| 36 | cd boost | |
| 37 | git submodule update --init | |
| 38 | ||
| 39 | The Boost Regex Library is located in `libs/regex/`. | |
| 40 | ||
| 41 | ### Running tests ### | |
| 42 | First, make sure you are in `libs/regex/test`. | |
| 43 | You can either run all the tests listed in `Jamfile.v2` or run a single test: | |
| 44 | ||
| 45 | ../../../b2 <- run all tests | |
| 46 | ../../../b2 regex_regress <- single test | |
| 47 |