From 5512e03562694ebfe571a3b6068a7d35d9ddfd7a Mon Sep 17 00:00:00 2001 From: "Friedrich W. H. Kossebau" Date: Sat, 17 Apr 2021 11:02:00 +0200 Subject: Modules docs: move rst docs into bracket comments CMake >= 3.0 supports bracket comments, and the reStructuredText integration code in sphinx/ext/ecm.py already supports extracting the docs from a bracket comment instead. Editing documentation without leading line comment markers is more simple, e,g. when reflowing text over lines. With ECM meanwhile requiring CMake 3.5 now it is possible to switch (and thus follow also the approach used by cmake itself). NO_CHANGELOG --- modules/ECMSourceVersionControl.cmake | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'modules/ECMSourceVersionControl.cmake') diff --git a/modules/ECMSourceVersionControl.cmake b/modules/ECMSourceVersionControl.cmake index aa8164c4..b61c7069 100644 --- a/modules/ECMSourceVersionControl.cmake +++ b/modules/ECMSourceVersionControl.cmake @@ -1,20 +1,20 @@ -#.rst: -# ECMSourceVersionControl -# -------------------------- -# -# Tries to determine whether the source is under version control (git clone, -# svn checkout, etc). -# -# ``ECM_SOURCE_UNDER_VERSION_CONTROL`` is set when indication is found that -# CMAKE_SOURCE_DIR is under version control. -# -# Since 5.63 - -#============================================================================= # SPDX-FileCopyrightText: 2019 Harald Sitter # # SPDX-License-Identifier: BSD-3-Clause +#[=======================================================================[.rst: +ECMSourceVersionControl +-------------------------- + +Tries to determine whether the source is under version control (git clone, +svn checkout, etc). + +``ECM_SOURCE_UNDER_VERSION_CONTROL`` is set when indication is found that +CMAKE_SOURCE_DIR is under version control. + +Since 5.63 +#]=======================================================================] + if(EXISTS "${CMAKE_SOURCE_DIR}/.git" OR EXISTS "${CMAKE_SOURCE_DIR}/.svn" OR EXISTS "${CMAKE_SOURCE_DIR}/.hg" OR -- cgit v1.2.1