boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-09 23:24:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change the local Boost directory from modular-boost to boost

Adam Wulkiewicz 2017-03-06 01:12:07 +01:00
parent e4dd219304
commit 8a8445b168
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Contribution-Tutorial.md

@ -4,7 +4,7 @@
* [Testing the development branch of Boost.Geometry](#testing-the-development-branch-of-boostgeometry)
* [Fork Boost.Geometry repository](#fork-boostgeometry-repository)
* [Verify if your fork works (optional)](#verify-if-your-fork-works-optional)
* [Working with ModularBoost](#working-with-modularboost)
* [Working with Boost](#working-with-boost)
* [Preparation](#preparation)
* [Add new remote repository](#add-new-remote-repository)
* [GitFlow workflow](#gitflow-workflow)
@ -22,7 +22,7 @@
* git (see [Getting Started with Git](https://svn.boost.org/trac/boost/wiki/Git/GitHome))
* a compiler to run Boost tests - gcc, clang, Visual Studio Express, etc.
* configured GitHub account
* every step mentioned here: [TryModBoost](https://svn.boost.org/trac/boost/wiki/TryModBoost) understood and tested.
* steps mentioned here: [Getting Started with Boost](https://github.com/boostorg/boost/wiki/Getting-Started) understood and tested.
Other helpful links:
@ -34,11 +34,19 @@ Other helpful links:
### Testing the development branch of Boost.Geometry
Those are the steps which must be done to checkout the Boost.Geometry repository and run tests
(also described here: https://svn.boost.org/trac/boost/wiki/TryModBoost#Developing).
(see also: https://github.com/boostorg/boost/wiki/Getting-Started).
Pull the develop branch
Clone Boost repository, build `b2` and create directory containing Boost headers
cd modular-boost/libs/geometry
git clone --recursive https://github.com/boostorg/boost.git
cd boost
git checkout develop
.\bootstrap
.\b2 headers
Pull the develop branch of Boost.Geometry
cd libs/geometry
git checkout develop
git branch -vv
git pull
@ -66,7 +74,7 @@ More info: [Forking Projects](https://guides.github.com/activities/forking/)
#### Verify if your fork works (optional)
Go out of `modular-boost/libs/geometry/` directory
Go out of `boost/libs/geometry/` directory
cd ../../..
@ -84,15 +92,15 @@ see commits
For now you should see exactly the same commits as in Boost.Geometry repository.
### Working with ModularBoost
### Working with Boost
You could of course stop on the previous point and work on this local clone of the fork of Boost.Geometry however there is a catch. You won't be able to use b2 (run tests or build documentation) if the library is not inside the Boost directory. It's therefore convenient to use your fork inside modular-boost which basically means adding new remote for Boost.Geometry and using it aside the original Boost.Geometry repository.
You could of course stop on the previous point and work on this local clone of the fork of Boost.Geometry however there is a catch. You won't be able to use b2 (run tests or build documentation) if the library is not inside the Boost directory. It's therefore convenient to use your fork inside boost which basically means adding new remote for Boost.Geometry and using it aside the original Boost.Geometry repository.
#### Preparation
If you did the optional steps mentioned in the section [**Verify if your fork works (optional)**](#verify-if-your-fork-works-optional), go back to the Geometry module directory `modular-boost/libs/geometry/`.
If you did the optional steps mentioned in the section [**Verify if your fork works (optional)**](#verify-if-your-fork-works-optional), go back to the Geometry module directory `boost/libs/geometry/`.
cd ../modular-boost/libs/geometry
cd ../boost/libs/geometry
For now there is only one remote repository set for this local copy. You may check it by running
@ -219,7 +227,7 @@ As you already know tests are placed in the `test/` directory. Add tests for the
* It's preferable to do this before sending the merge/pull request.
* Consider using additional compiler options like -Wall, -Wextra, -Wconversion to catch more bugs.
Run the tests (assuming you're in `modular-boost/libs/geometry/`)
Run the tests (assuming you're in `boost/libs/geometry/`)
b2 test