From 56ca6bdd24d9bbb3549ec629cf20b7dbe936543d Mon Sep 17 00:00:00 2001 From: Jason Tibbitts Date: Oct 20 2021 21:04:11 +0000 Subject: Fix formatting issues in Cmake guidelines This fixes a few instances of bad formatting as well as minor capitalization and grammar issues. --- diff --git a/guidelines/modules/ROOT/pages/CMake.adoc b/guidelines/modules/ROOT/pages/CMake.adoc index fe64c66..dd69a18 100644 --- a/guidelines/modules/ROOT/pages/CMake.adoc +++ b/guidelines/modules/ROOT/pages/CMake.adoc @@ -60,30 +60,30 @@ for more information. Holds the location of the actual directory where the build was made. When making https://fedoraproject.org/wiki/Changes/CMake_to_do_out-of-source_builds[out-of-source builds], -this macro is the same as %_vpath_builddir, +this macro is the same as `+%_vpath_builddir+`, which should be used preferably in such cases. See the xref:vpath.adoc[Defining source and build directories] for more information. When doing in-source builds (that means before Fedora 33 https://fedoraproject.org/wiki/Changes/CMake_to_do_out-of-source_builds[out-of-source builds] change), -this macro would differ from %_vpath_builddir +this macro would differ from `+%_vpath_builddir+` and it will hold the actual location that was used for the build. This is useful in cases, -when you want to use the same SPECfile for different Fedora releases +when you want to use the same specfile for different Fedora releases where on some the build is in-source and on some out-of-source AND you need to know the builddir location - -e.g. when using "cmake -B %__cmake_builddir -LH" -inbetween of %cmake and "%cmake_build". +e.g. when using `+cmake -B %__cmake_builddir -LH+` +between `+%cmake+` and `+%cmake_build+`. Whenever possible, using out-of-source builds is advised, -as this is the direction both Fedora and CMake upstream bears. +as this is the direction both Fedora and CMake upstream are moving. -Warning: This macro is suitable only for rare compatibility reasons. +WARNING: This macro is suitable only for rare compatibility reasons. Once all active Fedora releases will use https://fedoraproject.org/wiki/Changes/CMake_to_do_out-of-source_builds[out-of-source builds], -this macro will be redundant (same as %_vpath_builddir) and removed. +this macro will be redundant (same as `+%_vpath_builddir+`) and may be removed. -== Example usage in the spec file +== Example Usage .... %build @@ -99,11 +99,11 @@ this macro will be redundant (same as %_vpath_builddir) and removed. == Notes -NOTE: Since Fedora 33, `+%__cmake_in_source_build+` is not defined +Since Fedora 33, `+%__cmake_in_source_build+` is not defined so if you want to have consistent behavior across different releases, make sure to `+%define+` or `+%undefine+` it accordingly. -*NOTE*: `+-DCMAKE_SKIP_RPATH:BOOL=ON+`. +`+-DCMAKE_SKIP_RPATH:BOOL=ON+`. With recent cmake-2.4, it should not be used. This CMake version should handle RPATHs issues correctly (set them in build-dir, remove them during installation). @@ -119,7 +119,6 @@ will *not* strip rpaths; in this case `+INSTALL(TARGETS ...)+` must be used in combination with changing the `+OUTPUT_NAME+` property. -*NOTE*: CMake has good documentation in two places: - +CMake has good documentation in two places: * https://cmake.org/documentation/ * https://gitlab.kitware.com/cmake/community/wikis/Home