summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosef Angstenberger <code@jtxa.de>2021-06-10 23:16:18 +0200
committerBrad King <brad.king@kitware.com>2021-06-17 11:55:18 -0400
commit25dde20cc5df77326f369c2dbcca3edcf687e581 (patch)
treed7f406ed2224c92a9e2399d64ee8fdfd147908df
parentd1c3e7e78af0b3a4a5637e2bf3af86cfa5ba6e6f (diff)
downloadcmake-25dde20cc5df77326f369c2dbcca3edcf687e581.tar.gz
Tutorial: Fix links after splitting steps
-rw-r--r--Help/guide/tutorial/Adding Export Configuration.rst8
-rw-r--r--Help/guide/tutorial/Adding Support for a Testing Dashboard.rst8
-rw-r--r--Help/guide/tutorial/Adding Usage Requirements for a Library.rst10
-rw-r--r--Help/guide/tutorial/Installing and Testing.rst2
-rw-r--r--Help/guide/tutorial/Packaging an Installer.rst2
5 files changed, 16 insertions, 14 deletions
diff --git a/Help/guide/tutorial/Adding Export Configuration.rst b/Help/guide/tutorial/Adding Export Configuration.rst
index 55cb3e29f8..6c283a64a0 100644
--- a/Help/guide/tutorial/Adding Export Configuration.rst
+++ b/Help/guide/tutorial/Adding Export Configuration.rst
@@ -1,10 +1,10 @@
Step 11: Adding Export Configuration
====================================
-During `Installing and Testing (Step 4)`_ of the tutorial we added the ability
-for CMake to install the library and headers of the project. During
-`Building an Installer (Step 7)`_ we added the ability to package up this
-information so it could be distributed to other people.
+During :guide:`tutorial/Installing and Testing` of the tutorial we added the
+ability for CMake to install the library and headers of the project. During
+:guide:`tutorial/Packaging an Installer` we added the ability to package up
+this information so it could be distributed to other people.
The next step is to add the necessary information so that other CMake projects
can use our project, be it from a build directory, a local install or when
diff --git a/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst b/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
index 41b772c9db..74d3f0f365 100644
--- a/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
+++ b/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
@@ -2,10 +2,10 @@ Step 8: Adding Support for a Testing Dashboard
==============================================
Adding support for submitting our test results to a dashboard is simple. We
-already defined a number of tests for our project in `Testing Support`_. Now we
-just have to run those tests and submit them to a dashboard. To include support
-for dashboards we include the :module:`CTest` module in our top-level
-``CMakeLists.txt``.
+already defined a number of tests for our project in
+:ref:`Testing Support <Tutorial Testing Support>`. Now we just have to run
+those tests and submit them to a dashboard. To include support for dashboards
+we include the :module:`CTest` module in our top-level ``CMakeLists.txt``.
Replace:
diff --git a/Help/guide/tutorial/Adding Usage Requirements for a Library.rst b/Help/guide/tutorial/Adding Usage Requirements for a Library.rst
index a625d90480..6146a5e319 100644
--- a/Help/guide/tutorial/Adding Usage Requirements for a Library.rst
+++ b/Help/guide/tutorial/Adding Usage Requirements for a Library.rst
@@ -11,11 +11,11 @@ requirements are:
- :command:`target_include_directories`
- :command:`target_link_libraries`
-Let's refactor our code from `Adding a Library (Step 2)`_ to use the modern
-CMake approach of usage requirements. We first state that anybody linking to
-MathFunctions needs to include the current source directory, while
-MathFunctions itself doesn't. So this can become an ``INTERFACE`` usage
-requirement.
+Let's refactor our code from :guide:`tutorial/Adding a Library` to use the
+modern CMake approach of usage requirements. We first state that anybody
+linking to MathFunctions needs to include the current source directory,
+while MathFunctions itself doesn't. So this can become an ``INTERFACE``
+usage requirement.
Remember ``INTERFACE`` means things that consumers require but the producer
doesn't. Add the following lines to the end of
diff --git a/Help/guide/tutorial/Installing and Testing.rst b/Help/guide/tutorial/Installing and Testing.rst
index 3f85df3e15..611749b3ae 100644
--- a/Help/guide/tutorial/Installing and Testing.rst
+++ b/Help/guide/tutorial/Installing and Testing.rst
@@ -52,6 +52,8 @@ argument. For example:
Navigate to the install directory and verify that the installed Tutorial runs.
+.. _`Tutorial Testing Support`:
+
Testing Support
---------------
diff --git a/Help/guide/tutorial/Packaging an Installer.rst b/Help/guide/tutorial/Packaging an Installer.rst
index 037ae86699..cee1da44f4 100644
--- a/Help/guide/tutorial/Packaging an Installer.rst
+++ b/Help/guide/tutorial/Packaging an Installer.rst
@@ -4,7 +4,7 @@ Step 7: Packaging an Installer
Next suppose that we want to distribute our project to other people so that
they can use it. We want to provide both binary and source distributions on a
variety of platforms. This is a little different from the install we did
-previously in `Installing and Testing (Step 4)`_ , where we were
+previously in :guide:`tutorial/Installing and Testing`, where we were
installing the binaries that we had built from the source code. In this
example we will be building installation packages that support binary
installations and package management features. To accomplish this we will use