Document Boost::math oddities
#1099
Conversation
docs/packages/pkg/Boost.rst
Outdated
| @@ -42,7 +43,13 @@ List of components (other libraries are header-only): | |||
| - ``iostreams`` | |||
| - ``locale`` | |||
| - ``log`` | |||
| - ``math`` | |||
| - ``math`` - Requires Special names for ``find_package`` and ``target_link_libraries``, choose one of: | |||
There was a problem hiding this comment.
This is a list of components that can be used in hunter_add_package(Boost COMPONENTS ...) so it doesn't belong here. For the find_package(Boost CONFIG REQUIRED ...) you can add code snippet similar to Qt:
There was a problem hiding this comment.
Shall make a new section for just math then, was trying not to expand it that far as it increases verbosity, but yeah it is probably required, shall do.
examples/Boost-math/CMakeLists.txt
Outdated
| add_executable(foo foo.cpp) | ||
| target_link_libraries(foo Boost::math_tr1) | ||
|
|
||
| # Compatibility mode |
There was a problem hiding this comment.
We are testing it in other examples. Let's remove this.
examples/Boost-math/CMakeLists.txt
Outdated
| hunter_add_package(Boost COMPONENTS math) | ||
|
|
||
| # now boost can be used | ||
| # you need to choose which form of Boost::math you want |
There was a problem hiding this comment.
Can we use all of them simultaneously?
There was a problem hiding this comment.
You can depending on t he functions you use. Technically you can link them all in and it will always work (relying on LTO to optimize them out).
There was a problem hiding this comment.
Let's link all of them. By this we will tests that all Boost::math_* targets are valid.
Actually it's bold for me, not italic. Are you talking about GitHub rendering or readthedocs (sphinx)? You can find documentation build instructions here: |
Yeah the github renderer. I'm on an entirely terminal system here currently so I cannot see generated docs locally, I have to git push to github and check it, say, on my phone to see how it looks. |
They work differrently and will not look the same. |
Ah, good to know that the restructured text format is so globally consistent... >.> |
|
What other changes are needed? I have time today to do so now. :-) |
docs/packages/pkg/Boost.rst
Outdated
| hunter_add_package(Boost COMPONENTS math) | ||
| find_package(Boost CONFIG REQUIRED math_c99 math_c99f math_c99l math_tr1 math_tr1f math_tr1l) | ||
| include_directories(${Boost_INCLUDE_DIRS}) | ||
| target_link_libraries(... ${Boost_LIBRARIES}) |
There was a problem hiding this comment.
Boost_LIBRARIES is a list of full paths, it's not recommended to use it.
There was a problem hiding this comment.
Aren't CMake build's non-relocateable anyway? Plus ${Boost_INCLUDE_DIRS} would make it non-relocateable too?
examples/Boost-math/CMakeLists.txt
Outdated
| # download boost | ||
| hunter_add_package(Boost COMPONENTS math) | ||
|
|
||
| # now boost::math can be used |
There was a problem hiding this comment.
now boost::math -> now boost::math_* targets
docs/packages/pkg/Boost.rst
Outdated
| ----------- | ||
|
|
||
| When using Boost Math you will need to link in the libraries, however these are not named ``math`` but | ||
| rather are individual based on what you need to link it, the easist of which is to link in all parts: |
There was a problem hiding this comment.
s,easist,easiest,
docs/packages/pkg/Boost.rst
Outdated
| @@ -89,6 +90,44 @@ For example: | |||
| - `boost.iostreams | |||
| options <http://www.boost.org/doc/libs/1_57_0/libs/iostreams/doc/index.html?path=7>`__ | |||
|
|
|||
| Boost::Math | |||
There was a problem hiding this comment.
This is a little bit confusing. There is no imported library Boost::Math, C++ namespace is boost::. Let it be just Math then.
docs/packages/pkg/Boost.rst
Outdated
|
|
||
| hunter_add_package(Boost COMPONENTS math) | ||
| find_package(Boost CONFIG REQUIRED math_c99 math_c99f math_c99l math_tr1 math_tr1f math_tr1l) | ||
| include_directories(${Boost_INCLUDE_DIRS}) |
|
Any other changes? :-) |
|
I've removed OSX Boost.math testing (we have Visual Studio and Linux) because of the timeout, don't know what is the problem. My local test worked fine. If you want to check it and add new toolchain take a look at this documents and open pull request:
Uploading: |
Fixes #1098 but I'm not quite happy with how the restructuredtext is formatted, is that really becoming italic and why... Any ideas on how to fix that formatting?