Skip to content

Commit

Permalink
Add CMake doc link to chapter03 abstracts and regenerate READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheErk committed Sep 19, 2018
1 parent 4fb6563 commit 98c051d
Show file tree
Hide file tree
Showing 16 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion chapter-03/recipe-01/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Detecting the Python interpreter

We will introduce the `find_package` CMake command and use it to detect a
We will introduce the [`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) CMake command and use it to detect a
working Python interpreter on the system.


Expand Down
2 changes: 1 addition & 1 deletion chapter-03/recipe-01/abstract.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
We will introduce the `find_package` CMake command and use it to detect a
We will introduce the [`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) CMake command and use it to detect a
working Python interpreter on the system.
2 changes: 1 addition & 1 deletion chapter-03/recipe-02/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Detecting the Python library

This recipe builds an executable embedding the Python interpreter. We will use
`find_package` to find the Python development headers and library.
[`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) to find the Python development headers and library.

Code example copy-pasted from the Python docs on embedding https://docs.python.org/3.5/extending/embedding.html

Expand Down
2 changes: 1 addition & 1 deletion chapter-03/recipe-02/abstract.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This recipe builds an executable embedding the Python interpreter. We will use
`find_package` to find the Python development headers and library.
[`find_package`](https://cmake.org/cmake/help/latest/command/find_package.html) to find the Python development headers and library.

Code example copy-pasted from the Python docs on embedding https://docs.python.org/3.5/extending/embedding.html
4 changes: 2 additions & 2 deletions chapter-03/recipe-03/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This example will embed a Python interpreter into a C++ executable and run a
custom Python script.
The Python script uses Numpy and we will show how to find this module with CMake
with help of `find_package_handle_standard_args`.
The Python script uses [Numpy](http://www.numpy.org/) and we will show how to find this module with CMake
with help of [`find_package_handle_standard_args`](https://cmake.org/cmake/help/latest/module/FindPackageHandleStandardArgs.html).

To test run: `./pure-embedding use_numpy print_ones 15 34`

Expand Down
4 changes: 2 additions & 2 deletions chapter-03/recipe-03/abstract.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This example will embed a Python interpreter into a C++ executable and run a
custom Python script.
The Python script uses Numpy and we will show how to find this module with CMake
with help of `find_package_handle_standard_args`.
The Python script uses [Numpy](http://www.numpy.org/) and we will show how to find this module with CMake
with help of [`find_package_handle_standard_args`](https://cmake.org/cmake/help/latest/module/FindPackageHandleStandardArgs.html).

To test run: `./pure-embedding use_numpy print_ones 15 34`
2 changes: 1 addition & 1 deletion chapter-03/recipe-05/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Detecting the OpenMP parallel environment

We will show how to detect support for the OpenMP shared-memory parallelism
standard. Usage of CMake `IMPORTED` libraries is shown. Examples are given for
standard. Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown. Examples are given for
both C++ and Fortran using CMake 3.9 or higher. The `cxx-example-3.5` and
`fortran-example-3.5` show how to attain the same goal with a lower version of
CMake.
Expand Down
2 changes: 1 addition & 1 deletion chapter-03/recipe-05/abstract.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
We will show how to detect support for the OpenMP shared-memory parallelism
standard. Usage of CMake `IMPORTED` libraries is shown. Examples are given for
standard. Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown. Examples are given for
both C++ and Fortran using CMake 3.9 or higher. The `cxx-example-3.5` and
`fortran-example-3.5` show how to attain the same goal with a lower version of
CMake.
2 changes: 1 addition & 1 deletion chapter-03/recipe-06/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Detecting the MPI parallel environment

We will show how to detect support for MPI distributed-memory parallelism
standard. Usage of CMake `IMPORTED` libraries is shown.
standard. Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown.
Examples are given for both C++ and C using CMake 3.9 or higher.
The `c-example-3.5` show how to attain the same goal with a lower version of
CMake.
Expand Down
2 changes: 1 addition & 1 deletion chapter-03/recipe-06/abstract.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
We will show how to detect support for MPI distributed-memory parallelism
standard. Usage of CMake `IMPORTED` libraries is shown.
standard. Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown.
Examples are given for both C++ and C using CMake 3.9 or higher.
The `c-example-3.5` show how to attain the same goal with a lower version of
CMake.
4 changes: 2 additions & 2 deletions chapter-03/recipe-07/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Detecting the Eigen library

Show how to use the Eigen library with OpenMP threading and optionally linking
Show how to use the [Eigen library](http://eigen.tuxfamily.org) with [OpenMP](https://www.openmp.org/) threading and optionally linking
to BLAS/LAPACK.
Usage of CMake `IMPORTED` libraries is shown for CMake 3.9 or higher.
Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown for CMake 3.9 or higher.
The `cxx-example-3.5` folder shows how to attain the same goal with older
versions of CMake.

Expand Down
4 changes: 2 additions & 2 deletions chapter-03/recipe-07/abstract.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Show how to use the Eigen library with OpenMP threading and optionally linking
Show how to use the [Eigen library](http://eigen.tuxfamily.org) with [OpenMP](https://www.openmp.org/) threading and optionally linking
to BLAS/LAPACK.
Usage of CMake `IMPORTED` libraries is shown for CMake 3.9 or higher.
Usage of CMake [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) is shown for CMake 3.9 or higher.
The `cxx-example-3.5` folder shows how to attain the same goal with older
versions of CMake.
4 changes: 2 additions & 2 deletions chapter-03/recipe-08/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Detecting the Boost libraries

This recipe shows how to find the Boost C++ libraries and how these are
conveniently wrapped into `IMPORTED` libraries in CMake.
This recipe shows how to find the [Boost C++](https://www.boost.org/) libraries and how these are
conveniently wrapped into [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) in CMake.


- [cxx-example](cxx-example/)
4 changes: 2 additions & 2 deletions chapter-03/recipe-08/abstract.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
This recipe shows how to find the Boost C++ libraries and how these are
conveniently wrapped into `IMPORTED` libraries in CMake.
This recipe shows how to find the [Boost C++](https://www.boost.org/) libraries and how these are
conveniently wrapped into [`IMPORTED` libraries](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) in CMake.
4 changes: 2 additions & 2 deletions chapter-03/recipe-09/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Detecting external libraries: I. Using `pkg-config`

This recipe shows how to detect the ZeroMQ library using CMake and `pkg-config`.
This recipe shows how to detect the [ZeroMQ library](http://zeromq.org/) using CMake and `pkg-config`.
The recipe works on Unix-like systems, such as GNU/Linux and macOS.
For CMake 3.6 and higher, an `IMPORTED` library can be used, but an example
For CMake 3.6 and higher, an [`IMPORTED` library](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) can be used, but an example
for older versions of CMake is also shown.


Expand Down
4 changes: 2 additions & 2 deletions chapter-03/recipe-09/abstract.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This recipe shows how to detect the ZeroMQ library using CMake and `pkg-config`.
This recipe shows how to detect the [ZeroMQ library](http://zeromq.org/) using CMake and `pkg-config`.
The recipe works on Unix-like systems, such as GNU/Linux and macOS.
For CMake 3.6 and higher, an `IMPORTED` library can be used, but an example
For CMake 3.6 and higher, an [`IMPORTED` library](https://cmake.org/cmake/help/latest/manual/cmake-buildsystem.7.html#imported-targets) can be used, but an example
for older versions of CMake is also shown.

0 comments on commit 98c051d

Please sign in to comment.