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/CheckAtomic.cmake | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) (limited to 'modules/CheckAtomic.cmake') diff --git a/modules/CheckAtomic.cmake b/modules/CheckAtomic.cmake index 185a6abf..d154b117 100644 --- a/modules/CheckAtomic.cmake +++ b/modules/CheckAtomic.cmake @@ -1,19 +1,18 @@ -#.rst: -# CheckAtomic -# ----------- -# -# Check if the compiler supports std:atomic out of the box or if libatomic is -# needed for atomic support. If it is needed libatomicis added to -# CMAKE_REQUIRED_LIBRARIES. So after running CheckAtomic you can use -# std:atomic. -# -# Since 5.75.0. - -#============================================================================= # SPDX-FileCopyrightText: 2003-2018 University of Illinois at Urbana-Champaign. # # SPDX-License-Identifier: BSD-3-Clause -#============================================================================= + +#[=======================================================================[.rst: +CheckAtomic +----------- + +Check if the compiler supports std:atomic out of the box or if libatomic is +needed for atomic support. If it is needed libatomicis added to +``CMAKE_REQUIRED_LIBRARIES``. So after running CheckAtomic you can use +std:atomic. + +Since 5.75.0. +#]=======================================================================] include(CheckCXXSourceCompiles) include(CheckLibraryExists) -- cgit v1.2.1