Browse Source

Help: Document CMAKE_OBJDUMP variable

Peter Kokot 1 year ago
parent
commit
dc7aabf4d0

+ 2 - 2
Help/command/file.rst

@@ -1337,7 +1337,7 @@ Handling Runtime Binaries
     the actual path to ``objdump``, ``dumpbin``, or ``otool``.
 
     If this variable is not specified, it is determined by the value of
-    ``CMAKE_OBJDUMP`` if set, else by system introspection.
+    :variable:`CMAKE_OBJDUMP` variable if set, else by system introspection.
 
     .. versionadded:: 3.18
-      Use ``CMAKE_OBJDUMP`` if set.
+      Uses :variable:`CMAKE_OBJDUMP` if set.

+ 1 - 0
Help/manual/cmake-variables.7.rst

@@ -93,6 +93,7 @@ Variables that Provide Information
    /variable/CMAKE_MINOR_VERSION
    /variable/CMAKE_NETRC
    /variable/CMAKE_NETRC_FILE
+   /variable/CMAKE_OBJDUMP
    /variable/CMAKE_PARENT_LIST_FILE
    /variable/CMAKE_PATCH_VERSION
    /variable/CMAKE_PROJECT_DESCRIPTION

+ 16 - 0
Help/variable/CMAKE_OBJDUMP.rst

@@ -0,0 +1,16 @@
+CMAKE_OBJDUMP
+-------------
+
+Path to the ``objdump`` executable on the host system.  This tool, typically
+part of the Binutils collection on Unix-like systems, provides information
+about compiled object files.
+
+This cache variable may be populated by CMake when project languages are
+enabled using the :command:`project` or :command:`enable_language` commands.
+
+See Also
+^^^^^^^^
+
+* The :command:`file(GET_RUNTIME_DEPENDENCIES)` command provides a more general
+  way to get information from runtime binaries.
+* The :variable:`CPACK_OBJDUMP_EXECUTABLE` variable.

+ 1 - 0
Modules/CMakeFindBinUtils.cmake

@@ -15,6 +15,7 @@
 #   CMAKE_RANLIB
 #   CMAKE_LINKER
 #   CMAKE_MT
+#   CMAKE_OBJDUMP
 #   CMAKE_STRIP
 #   CMAKE_INSTALL_NAME_TOOL
 

+ 1 - 1
Modules/CPack.cmake

@@ -498,7 +498,7 @@ The following variables are for advanced uses of CPack:
   .. versionadded:: 3.25
 
   Specify the ``objdump`` executable path used by CPack.
-  The default value will be taken from the ``CMAKE_OBJDUMP`` variable, if set,
+  The default value will be taken from the :variable:`CMAKE_OBJDUMP` variable,
   which may be populated by CMake when enabling languages.  If ``CMAKE_OBJDUMP``
   is not set, CPack will use :command:`find_program` to determine the
   ``objdump`` path when needed.

+ 2 - 1
Modules/GetPrerequisites.cmake

@@ -26,7 +26,8 @@ files:
    otool (Mac OSX)
 
 .. versionchanged:: 3.16
-  The tool specified by ``CMAKE_OBJDUMP`` will be used, if set.
+  The tool specified by the :variable:`CMAKE_OBJDUMP` variable
+  will be used, if set.
 
 The following functions are provided by this module: