echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cmake.m4: Update Autoconf macros documentation

Browse Source 
This updates the documentation for the CMAKE_FIND_BINARY and
CMAKE_FIND_PACKAGE Autoconf macros to imitate other Autoconf macros
internal documentation style with some stylistic adjustments for
readability of the arguments.

- CMAKE_FIND_PACKAGE: Links to docs are added instead of listing
  compiler IDs. The 5th ($5) and 6th ($6) arguments descriptions are
  updated to be action-if-found and action-if-not-found according to the
  current code.
This commit is contained in:
Peter Kokot 2025-03-23 16:09:02 +01:00
parent 5cc08a4563
commit d5793a6e57
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 31 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Auxiliary/cmake.m4
View File

@ -1,6 +1,10 @@
dnl Distributed under the OSI-approved BSD 3-Clause License. See accompanying dnl Distributed under the OSI-approved BSD 3-Clause License. See accompanying
dnl file LICENSE.rst or https://cmake.org/licensing for details. dnl file LICENSE.rst or https://cmake.org/licensing for details.
# CMAKE_FIND_BINARY
# -----------------
# Finds the cmake command-line binary and sets its absolute path in the
# CMAKE_BINARY variable.
AC_DEFUN([CMAKE_FIND_BINARY], AC_DEFUN([CMAKE_FIND_BINARY],
[AC_ARG_VAR([CMAKE_BINARY], [path to the cmake binary])dnl [AC_ARG_VAR([CMAKE_BINARY], [path to the cmake binary])dnl
@ -9,13 +13,33 @@ if test "x$ac_cv_env_CMAKE_BINARY_set" != "xset"; then
fi fi
])dnl ])dnl
# $1: package name # CMAKE_FIND_PACKAGE(package, lang, [compiler-id], [cmake-args],
# $2: language (e.g. C/CXX/Fortran) # [action-if-found], [action-if-not-found])
# $3: The compiler ID, defaults to GNU. # --------------------------------------------------------------
# Possible values are: GNU, Intel, Clang, SunPro, HP, XL, VisualAge, PGI, # Finds a package with CMake.
# PathScale, Cray, SCO, MSVC, LCC #
# $4: optional extra arguments to cmake, e.g. "-DCMAKE_SIZEOF_VOID_P=8" # package:
# $5: optional path to cmake binary # The name of the package as called in CMake with find_package(package).
#
# lang:
# The programming language to use (e.g., C, CXX, Fortran).
# See https://cmake.org/cmake/help/latest/command/enable_language.html
# for a complete list of supported languages.
#
# compiler-id:
# (Optional) The compiler ID to use. Defaults to GNU.
# See https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
# for possible values.
#
# cmake-args:
# (Optional) Additional arguments to pass to cmake command, e.g.,
# -DCMAKE_SIZEOF_VOID_P=8.
#
# action-if-found:
# (Optional) Commands to execute if the package is found.
#
# action-if-not-found:
# (Optional) Commands to execute if the package is not found.
AC_DEFUN([CMAKE_FIND_PACKAGE], [ AC_DEFUN([CMAKE_FIND_PACKAGE], [
AC_REQUIRE([CMAKE_FIND_BINARY])dnl AC_REQUIRE([CMAKE_FIND_BINARY])dnl