From 594bafe52773c940fc3fb9cd9022a4d1a3a194c7 Mon Sep 17 00:00:00 2001 From: Ben Boeckel Date: Tue, 21 Jul 2015 17:18:53 -0400 Subject: [PATCH] cmake: add --trace-expand option The --trace option is helpful, but sometimes, what you're looking for is deep under many layers of function calls and figuring out what instance of the function call you're looking at is tedious to determine (usually involving patching and message()). Instead, add a --trace-expand option to trace while expanding commands into what CMake actually sees. --- Help/manual/cmake.1.rst | 10 +++++++--- Help/release/dev/trace-expand.rst | 5 +++++ Help/variable/CMAKE_POLICY_WARNING_CMPNNNN.rst | 4 ++-- Source/cmMakefile.cxx | 16 ++++++++++++++-- Source/cmake.cxx | 8 ++++++++ Source/cmake.h | 3 +++ Source/cmakemain.cxx | 1 + Tests/RunCMake/CommandLine/RunCMakeTest.cmake | 4 ++++ .../RunCMake/CommandLine/trace-expand-stderr.txt | 2 ++ Tests/RunCMake/CommandLine/trace-expand.cmake | 0 10 files changed, 46 insertions(+), 7 deletions(-) create mode 100644 Help/release/dev/trace-expand.rst create mode 100644 Tests/RunCMake/CommandLine/trace-expand-stderr.txt create mode 100644 Tests/RunCMake/CommandLine/trace-expand.cmake diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 4bd5a5ec7..9ce497140 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -113,14 +113,18 @@ Options ``--debug-output`` Put cmake in a debug mode. - Print extra stuff during the cmake run like stack traces with + Print extra information during the cmake run like stack traces with message(send_error ) calls. ``--trace`` Put cmake in trace mode. - Print a trace of all calls made and from where with - message(send_error ) calls. + Print a trace of all calls made and from where. + +``--trace-expand`` + Put cmake in trace mode. + + Like ``--trace``, but with variables expanded. ``--warn-uninitialized`` Warn about uninitialized values. diff --git a/Help/release/dev/trace-expand.rst b/Help/release/dev/trace-expand.rst new file mode 100644 index 000000000..383326e3f --- /dev/null +++ b/Help/release/dev/trace-expand.rst @@ -0,0 +1,5 @@ +trace-expand +------------ + +* Add ``--trace-expand`` argument to CMake. Acts like ``--trace``, but expands + variable references in the output. diff --git a/Help/variable/CMAKE_POLICY_WARNING_CMPNNNN.rst b/Help/variable/CMAKE_POLICY_WARNING_CMPNNNN.rst index 092fe3eb6..8de0d56f6 100644 --- a/Help/variable/CMAKE_POLICY_WARNING_CMPNNNN.rst +++ b/Help/variable/CMAKE_POLICY_WARNING_CMPNNNN.rst @@ -17,5 +17,5 @@ warn by default: This variable should not be set by a project in CMake code. Project developers running CMake may set this variable in their cache to enable the warning (e.g. ``-DCMAKE_POLICY_WARNING_CMP=ON``). -Alternatively, running :manual:`cmake(1)` with the ``--debug-output`` -or ``--trace`` option will also enable the warning. +Alternatively, running :manual:`cmake(1)` with the ``--debug-output``, +``--trace``, or ``--trace-expand`` option will also enable the warning. diff --git a/Source/cmMakefile.cxx b/Source/cmMakefile.cxx index ae69b24b6..7c9897056 100644 --- a/Source/cmMakefile.cxx +++ b/Source/cmMakefile.cxx @@ -307,10 +307,21 @@ void cmMakefile::PrintCommandTrace(const cmListFileFunction& lff) const std::ostringstream msg; msg << this->GetExecutionFilePath() << "(" << lff.Line << "): "; msg << lff.Name << "("; + bool expand = this->GetCMakeInstance()->GetTraceExpand(); + std::string temp; for(std::vector::const_iterator i = lff.Arguments.begin(); i != lff.Arguments.end(); ++i) { - msg << i->Value; + if (expand) + { + temp = i->Value; + this->ExpandVariablesInString(temp); + msg << temp; + } + else + { + msg << i->Value; + } msg << " "; } msg << ")"; @@ -4802,7 +4813,8 @@ bool cmMakefile::PolicyOptionalWarningEnabled(std::string const& var) return cmSystemTools::IsOn(val); } } - // Enable optional policy warnings with --debug-output or --trace. + // Enable optional policy warnings with --debug-output, --trace, + // or --trace-expand. cmake* cm = this->GetCMakeInstance(); return cm->GetDebugOutput() || cm->GetTrace(); } diff --git a/Source/cmake.cxx b/Source/cmake.cxx index 7bf3832a9..6abdbed88 100644 --- a/Source/cmake.cxx +++ b/Source/cmake.cxx @@ -121,6 +121,7 @@ void cmWarnUnusedCliWarning(const std::string& variable, cmake::cmake() { this->Trace = false; + this->TraceExpand = false; this->WarnUninitialized = false; this->WarnUnused = false; this->WarnUnusedCli = true; @@ -617,10 +618,17 @@ void cmake::SetArgs(const std::vector& args, std::cout << "Running with debug output on.\n"; this->SetDebugOutputOn(true); } + else if(arg.find("--trace-expand",0) == 0) + { + std::cout << "Running with expanded trace output on.\n"; + this->SetTrace(true); + this->SetTraceExpand(true); + } else if(arg.find("--trace",0) == 0) { std::cout << "Running with trace output on.\n"; this->SetTrace(true); + this->SetTraceExpand(false); } else if(arg.find("--warn-uninitialized",0) == 0) { diff --git a/Source/cmake.h b/Source/cmake.h index f0f94115c..20e49e3a6 100644 --- a/Source/cmake.h +++ b/Source/cmake.h @@ -270,6 +270,8 @@ class cmake // Do we want trace output during the cmake run. bool GetTrace() { return this->Trace;} void SetTrace(bool b) { this->Trace = b;} + bool GetTraceExpand() { return this->TraceExpand;} + void SetTraceExpand(bool b) { this->TraceExpand = b;} bool GetWarnUninitialized() { return this->WarnUninitialized;} void SetWarnUninitialized(bool b) { this->WarnUninitialized = b;} bool GetWarnUnused() { return this->WarnUnused;} @@ -378,6 +380,7 @@ private: WorkingMode CurrentWorkingMode; bool DebugOutput; bool Trace; + bool TraceExpand; bool WarnUninitialized; bool WarnUnused; bool WarnUnusedCli; diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx index c94ffec06..a06b26fc6 100644 --- a/Source/cmakemain.cxx +++ b/Source/cmakemain.cxx @@ -83,6 +83,7 @@ static const char * cmDocumentationOptions[][2] = "useful on one try_compile at a time."}, {"--debug-output", "Put cmake in a debug mode."}, {"--trace", "Put cmake in trace mode."}, + {"--trace-expand", "Put cmake in trace mode with variable expansion."}, {"--warn-uninitialized", "Warn about uninitialized values."}, {"--warn-unused-vars", "Warn about unused variables."}, {"--no-warn-unused-cli", "Don't warn about command line options."}, diff --git a/Tests/RunCMake/CommandLine/RunCMakeTest.cmake b/Tests/RunCMake/CommandLine/RunCMakeTest.cmake index 84d4cc904..cef636852 100644 --- a/Tests/RunCMake/CommandLine/RunCMakeTest.cmake +++ b/Tests/RunCMake/CommandLine/RunCMakeTest.cmake @@ -140,6 +140,10 @@ set(RunCMake_TEST_OPTIONS --trace) run_cmake(trace) unset(RunCMake_TEST_OPTIONS) +set(RunCMake_TEST_OPTIONS --trace-expand) +run_cmake(trace-expand) +unset(RunCMake_TEST_OPTIONS) + set(RunCMake_TEST_OPTIONS --debug-trycompile) run_cmake(debug-trycompile) unset(RunCMake_TEST_OPTIONS) diff --git a/Tests/RunCMake/CommandLine/trace-expand-stderr.txt b/Tests/RunCMake/CommandLine/trace-expand-stderr.txt new file mode 100644 index 000000000..4fee9bc96 --- /dev/null +++ b/Tests/RunCMake/CommandLine/trace-expand-stderr.txt @@ -0,0 +1,2 @@ +^.*/Tests/RunCMake/CommandLine/CMakeLists.txt\(1\): cmake_minimum_required\(VERSION 3.0 \) +.*/Tests/RunCMake/CommandLine/CMakeLists.txt\(2\): project\(trace-expand NONE \) diff --git a/Tests/RunCMake/CommandLine/trace-expand.cmake b/Tests/RunCMake/CommandLine/trace-expand.cmake new file mode 100644 index 000000000..e69de29bb