2
0
mirror of https://github.com/boostorg/fiber.git synced 2026-02-19 14:22:23 +00:00

Add 'Installing and Running Tests' section.

Add ["text] macro for enclosing "text" in curly double quotes.
This commit is contained in:
Nat Goodspeed
2016-02-09 20:14:45 -05:00
parent f42fdca00f
commit 4146812990
2 changed files with 58 additions and 0 deletions

View File

@@ -35,6 +35,7 @@
[def __rendezvous__ ['rendezvous]]
[template mdash[] '''—''']
[template "[text] '''“'''[text]'''”''']
[template superscript[exp] '''<superscript>'''[exp]'''</superscript>''']
[template class_heading[class_name]
@@ -179,6 +180,7 @@
[include overview.qbk]
[include installing.qbk]
[include fiber.qbk]
[include scheduling.qbk]
[include stack.qbk]

56
doc/installing.qbk Normal file
View File

@@ -0,0 +1,56 @@
[/
Copyright Oliver Kowalke, Nat Goodspeed 2016.
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt
]
[section:installing Installing and Running Tests]
[heading Installing the Fiber library]
As Fiber is not yet officially part of Boost, it is necessary to embed it in
an existing [@http://www.boost.org/users/download/ Boost source tree].
The [@https://github.com/olk/boost-fiber/archive/master.zip downloaded Fiber
library] can be placed into an existing Boost source tree by moving the
top-level Fiber directory to `libs/fiber` under the top-level Boost directory,
then further moving `libs/fiber/include/boost/fiber` (in other words, the
Fiber library's `include/boost/fiber` directory) to `boost/fiber` under the
top-level Boost directory.
On a Posix system such as Linux or OS X, you may use symlinks instead.
Create a symlink from the Boost directory's `libs/fiber` to the top-level
Fiber directory, e.g.:
cd ~/boost_1_61_0
ln -s ~/boost-fiber-master libs/fiber
Then create a symlink from the Boost directory's `boost/fiber` to the Fiber
library's `include/boost/fiber` directory:
cd boost
ln -s ../libs/fiber/include/boost/fiber fiber
For some versions of the Boost.Build system, it was important to use a
relative symlink of that form for `boost/fiber`.
[#tests]
[heading Running Tests]
Once the Fiber library has been overlaid (or symlinked) into the Boost source
tree this way, the Boost.Build system can build it like any other Boost
library. In particular:
cd ~/boost_1_61_0
./bootstrap.sh
./b2 libs/fiber/test
On Windows, the commands would look more like:
cd /D %HOMEDRIVE%%HOMEPATH%\boost_1_61_0
bootstrap
b2 libs\fiber\test
[endsect]