Skip to content

Commit 384c32b

Browse files
committed
add recipe titles to cross-refs and monospace commands
1 parent 407f82d commit 384c32b

File tree

12 files changed

+28
-26
lines changed

12 files changed

+28
-26
lines changed

chapter-06/recipe-02/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
In this recipe, we generate `print_info.c` from the template `print_info.c.in`
44
by emulating the CMake function
5-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
5+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
66
with a custom Python script.
77

88
The goal of this recipe is to learn how we can generate source code at
99
configure time.
1010

1111
We should point out that this recipe has a serious limitation and cannot
1212
emulate
13-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
13+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
1414
fully. The approach that we present here cannot generate an automatic
1515
dependency which would regenerate `print_info.c` at build time. In other words,
1616
if you remove the generated `print_info.c` after the configure step, this file
1717
will not be regenerated and the build step will fail. To proper mimic the
1818
behavior of
19-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
19+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
2020
we would require
21-
[add_custom_command](https://cmake.org/cmake/help/latest/command/add_custom_command.html)
21+
[`add_custom_command`](https://cmake.org/cmake/help/latest/command/add_custom_command.html)
2222
and
23-
[add_custom_target](https://cmake.org/cmake/help/latest/command/add_custom_target.html),
23+
[`add_custom_target`](https://cmake.org/cmake/help/latest/command/add_custom_target.html),
2424
which we will use in the subsequent [Recipe 3, *Generating source code at build
2525
time using Python*](../recipe-03), where we will overcome this limitation.
2626

chapter-06/recipe-02/abstract.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
In this recipe, we generate `print_info.c` from the template `print_info.c.in`
22
by emulating the CMake function
3-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
3+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
44
with a custom Python script.
55

66
The goal of this recipe is to learn how we can generate source code at
77
configure time.
88

99
We should point out that this recipe has a serious limitation and cannot
1010
emulate
11-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
11+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
1212
fully. The approach that we present here cannot generate an automatic
1313
dependency which would regenerate `print_info.c` at build time. In other words,
1414
if you remove the generated `print_info.c` after the configure step, this file
1515
will not be regenerated and the build step will fail. To proper mimic the
1616
behavior of
17-
[configure_file](https://cmake.org/cmake/help/latest/command/configure_file.html)
17+
[`configure_file`](https://cmake.org/cmake/help/latest/command/configure_file.html)
1818
we would require
19-
[add_custom_command](https://cmake.org/cmake/help/latest/command/add_custom_command.html)
19+
[`add_custom_command`](https://cmake.org/cmake/help/latest/command/add_custom_command.html)
2020
and
21-
[add_custom_target](https://cmake.org/cmake/help/latest/command/add_custom_target.html),
21+
[`add_custom_target`](https://cmake.org/cmake/help/latest/command/add_custom_target.html),
2222
which we will use in the subsequent [Recipe 3, *Generating source code at build
2323
time using Python*](../recipe-03), where we will overcome this limitation.

chapter-06/recipe-05/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Recording the project version from a file
22

3-
The goal of this recipe is similar to [Recipe 4](../recipe-04), but the
4-
starting point is different; our plan is to read the version information from a
3+
The goal of this recipe is similar to [Recipe 4, *Recording the project version information for reproducibility*](../recipe-04),
4+
but the starting point is different; our plan is to read the version information from a
55
file, rather than setting it inside of `CMakeLists.txt`.
66

77
The motivation for keeping the version in a separate file, outside of CMake

chapter-06/recipe-05/abstract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
The goal of this recipe is similar to [Recipe 4](../recipe-04), but the
2-
starting point is different; our plan is to read the version information from a
1+
The goal of this recipe is similar to [Recipe 4, *Recording the project version information for reproducibility*](../recipe-04),
2+
but the starting point is different; our plan is to read the version information from a
33
file, rather than setting it inside of `CMakeLists.txt`.
44

55
The motivation for keeping the version in a separate file, outside of CMake

chapter-06/recipe-07/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Recording the Git hash at build time
22

3-
In [Recipe 6](../recipe-06), we recorded the state of the code repository
3+
In [Recipe 6, *Recording the Git hash at configure time*](../recipe-06),
4+
we recorded the state of the code repository
45
(Git hash) at configure time. In this recipe, we wish to go a step further and
56
demonstrate how to record the Git hash (or, generally, perform other actions)
67
at build time, to make sure that these actions are run every time we build the

chapter-06/recipe-07/abstract.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
In [Recipe 6](../recipe-06), we recorded the state of the code repository
1+
In [Recipe 6, *Recording the Git hash at configure time*](../recipe-06),
2+
we recorded the state of the code repository
23
(Git hash) at configure time. In this recipe, we wish to go a step further and
34
demonstrate how to record the Git hash (or, generally, perform other actions)
45
at build time, to make sure that these actions are run every time we build the

chapter-08/recipe-01/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This recipe introduces the superbuild pattern with a very simple example. We
44
will show how to use the
5-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject.html)
5+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject.html)
66
command to build a simple "Hello, World" program.
77

88

chapter-08/recipe-01/abstract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
This recipe introduces the superbuild pattern with a very simple example. We
22
will show how to use the
3-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject.html)
3+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject.html)
44
command to build a simple "Hello, World" program.

chapter-08/recipe-04/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
In this recipe we reuse the code from [Recipe 3 in Chapter 4](../../chapter-04/recipe-03)
44
and fetch and build the [Google Test](https://github.com/google/googletest) framework
5-
using [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html),
5+
using [`FetchContent`](https://cmake.org/cmake/help/latest/module/FetchContent.html),
66
which provides a compact and
77
versatile module to assemble project dependencies at configure time. For additional insight
8-
and for CMake below 3.11, we will also discuss how to emulate [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) using
9-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
8+
and for CMake below 3.11, we will also discuss how to emulate [`FetchContent`](https://cmake.org/cmake/help/latest/module/FetchContent.html) using
9+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
1010
at configure time.
1111

1212

chapter-08/recipe-04/abstract.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
In this recipe we reuse the code from [Recipe 3 in Chapter 4](../../chapter-04/recipe-03)
22
and fetch and build the [Google Test](https://github.com/google/googletest) framework
3-
using [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html),
3+
using [`FetchContent`](https://cmake.org/cmake/help/latest/module/FetchContent.html),
44
which provides a compact and
55
versatile module to assemble project dependencies at configure time. For additional insight
6-
and for CMake below 3.11, we will also discuss how to emulate [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) using
7-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
6+
and for CMake below 3.11, we will also discuss how to emulate [`FetchContent`](https://cmake.org/cmake/help/latest/module/FetchContent.html) using
7+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
88
at configure time.

chapter-08/recipe-05/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Managing your project as a superbuild
22

33
This recipe shows how to use
4-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
4+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
55
to handle dependencies available from open source Git repositories.
66

77
As an example we will build a project which depends on https://github.com/dev-cafe/message.

chapter-08/recipe-05/abstract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This recipe shows how to use
2-
[ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
2+
[`ExternalProject_Add`](https://cmake.org/cmake/help/latest/module/ExternalProject_Add.html)
33
to handle dependencies available from open source Git repositories.
44

55
As an example we will build a project which depends on https://github.com/dev-cafe/message.

0 commit comments

Comments
 (0)