From ad4f4b3b6a96504841c4a3d3b60476dc199c9220 Mon Sep 17 00:00:00 2001 From: redcode Date: Sat, 2 Nov 2024 20:20:46 +0100 Subject: [PATCH] Documentation WIP. --- documentation/installation-from-sources.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/documentation/installation-from-sources.rst b/documentation/installation-from-sources.rst index 1eae69a..5f3def1 100644 --- a/documentation/installation-from-sources.rst +++ b/documentation/installation-from-sources.rst @@ -85,12 +85,12 @@ Package-specific options are prefixed with ``Z80_`` and can be divided into two .. option:: -DZ80_INSTALL_CMAKEDIR="" - Specify the directory in which to install the CMake `config-file package `_. |br| |nl| + Specify the directory in which to install the CMake `config-file package`_. |br| |nl| The default is ``"${CMAKE_INSTALL_LIBDIR}/cmake/Z80"``. .. option:: -DZ80_INSTALL_PKGCONFIGDIR="" - Specify the directory in which to install the `pkg-config `_ `file `_. |br| |nl| + Specify the directory in which to install the `pkg-config`_ `file`_. |br| |nl| The default is ``"${CMAKE_INSTALL_LIBDIR}/pkgconfig"``. .. option:: -DZ80_NOSTDLIB_FLAGS=(Auto|"[[;...]]") @@ -117,7 +117,7 @@ Package-specific options are prefixed with ``Z80_`` and can be divided into two .. option:: -DZ80_WITH_CMAKE_SUPPORT=(YES|NO) - Generate and install the CMake `config-file package `_. |br| |nl| + Generate and install the CMake `config-file package`_. |br| |nl| The default is ``NO``. .. option:: -DZ80_WITH_HTML_DOCUMENTATION=(YES|NO) @@ -134,7 +134,7 @@ Package-specific options are prefixed with ``Z80_`` and can be divided into two .. option:: -DZ80_WITH_PKGCONFIG_SUPPORT=(YES|NO) - Generate and install the `pkg-config `_ `file `_. |br| |nl| + Generate and install the `pkg-config`_ `file`_. |br| |nl| The default is ``NO``. .. option:: -DZ80_WITH_STANDARD_DOCUMENTS=(YES|NO) @@ -226,3 +226,7 @@ The |cmake_option_build_config|_ option is only necessary for those `CMake gener * Documentation in HTML format. * Documentation in PDF format. + +.. _config-file package: https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#config-file-packages +.. _file: https://people.freedesktop.org/~dbn/pkg-config-guide.html +.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config