From 1506f9ca56c813f6c1fee4cea90a1cd8e5a4a04d Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 7 May 2015 16:21:29 -0400 Subject: find_package: Drop search in recent cmake-gui locations The find_package command, on Windows, has always searched build trees recently visited by cmake-gui (or CMakeSetup at one time). This was done when the command was created with the intention of simplifying workflows involving building multiple dependent projects. However, this behavior depends on recent developer interaction and therefore can create different find results based on transient system states. It can lead to surprising results and user confusion. Since this behavior was first added CMake has gained many more search options, better error messages when a package is not found, and a package registry. The latter in particular allows projects to make their build trees available for dependent projects to find without user intervention. Therefore the originally intended workflow can be achieved in other, more stable ways. After the above evoluion of find_package we have now decided that the magic search-where-cmake-gui-was behavior does more harm than good. Drop it. We do not need a policy for this behavior change because it only affects interactive use. --- Help/command/find_package.rst | 16 ++++-------- .../dev/find_package-no-cmake-gui-paths.rst | 10 ++++++++ Source/cmFindPackageCommand.cxx | 30 +--------------------- Source/cmFindPackageCommand.h | 2 -- 4 files changed, 16 insertions(+), 42 deletions(-) create mode 100644 Help/release/dev/find_package-no-cmake-gui-paths.rst diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 7f518a6..a5efba6 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -68,7 +68,7 @@ The complete Config mode command signature is:: [NO_CMAKE_PATH] [NO_SYSTEM_ENVIRONMENT_PATH] [NO_CMAKE_PACKAGE_REGISTRY] - [NO_CMAKE_BUILDS_PATH] + [NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing. [NO_CMAKE_SYSTEM_PATH] [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY] [CMAKE_FIND_ROOT_PATH_BOTH | @@ -265,20 +265,14 @@ enabled. PATH -5. Search project build trees recently configured in a :manual:`cmake-gui(1)`. - This can be skipped if ``NO_CMAKE_BUILDS_PATH`` is passed. It is intended - for the case when a user is building multiple dependent projects one - after another. - (This step is implemented only on Windows.) - -6. Search paths stored in the CMake :ref:`User Package Registry`. +5. Search paths stored in the CMake :ref:`User Package Registry`. This can be skipped if ``NO_CMAKE_PACKAGE_REGISTRY`` is passed or by setting the :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` to ``TRUE``. See the :manual:`cmake-packages(7)` manual for details on the user package registry. -7. Search cmake variables defined in the Platform files for the +6. Search cmake variables defined in the Platform files for the current system. This can be skipped if ``NO_CMAKE_SYSTEM_PATH`` is passed:: @@ -286,14 +280,14 @@ enabled. CMAKE_SYSTEM_FRAMEWORK_PATH CMAKE_SYSTEM_APPBUNDLE_PATH -8. Search paths stored in the CMake :ref:`System Package Registry`. +7. Search paths stored in the CMake :ref:`System Package Registry`. This can be skipped if ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` is passed or by setting the :variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` to ``TRUE``. See the :manual:`cmake-packages(7)` manual for details on the system package registry. -9. Search paths specified by the ``PATHS`` option. These are typically +8. Search paths specified by the ``PATHS`` option. These are typically hard-coded guesses. .. |FIND_XXX| replace:: find_package diff --git a/Help/release/dev/find_package-no-cmake-gui-paths.rst b/Help/release/dev/find_package-no-cmake-gui-paths.rst new file mode 100644 index 0000000..3914559 --- /dev/null +++ b/Help/release/dev/find_package-no-cmake-gui-paths.rst @@ -0,0 +1,10 @@ +find_package-no-cmake-gui-paths +------------------------------- + +* The :command:`find_package` command no longer considers project + build trees recently configured in a :manual:`cmake-gui(1)`. + This was previously done only on Windows and is now never done. + The ``NO_CMAKE_BUILDS_PATH`` option is now ignored if given + and effectively always on. + Projects may populate the :ref:`User Package Registry` to aid + users building multiple dependent projects one after another. diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index 4d568e9..68a6558 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -42,7 +42,6 @@ cmFindPackageCommand::cmFindPackageCommand() this->Required = false; this->NoUserRegistry = false; this->NoSystemRegistry = false; - this->NoBuilds = false; this->UseConfigFiles = true; this->UseFindModules = true; this->DebugMode = false; @@ -246,7 +245,7 @@ bool cmFindPackageCommand } else if(args[i] == "NO_CMAKE_BUILDS_PATH") { - this->NoBuilds = true; + // Ignore legacy option. configArgs.insert(i); doing = DoingNone; } @@ -1142,10 +1141,6 @@ void cmFindPackageCommand::ComputePrefixes() { this->FillPrefixesUserRegistry(); } - if(!this->NoBuilds) - { - this->FillPrefixesBuilds(); - } if(!this->NoCMakeSystemPath) { this->FillPrefixesCMakeSystemVariable(); @@ -1438,29 +1433,6 @@ bool cmFindPackageCommand::CheckPackageRegistryEntry(const std::string& fname, } //---------------------------------------------------------------------------- -void cmFindPackageCommand::FillPrefixesBuilds() -{ - cmSearchPath &paths = this->LabeledPaths[PathLabel::Builds]; - - // It is likely that CMake will have recently built the project. - for(int i=0; i <= 10; ++i) - { - std::ostringstream r; - r << - "[HKEY_CURRENT_USER\\Software\\Kitware\\CMakeSetup\\" - "Settings\\StartPath;WhereBuild" << i << "]"; - std::string f = r.str(); - cmSystemTools::ExpandRegistryValues(f); - cmSystemTools::ConvertToUnixSlashes(f); - if(cmSystemTools::FileIsFullPath(f.c_str()) && - cmSystemTools::FileIsDirectory(f)) - { - paths.AddPath(f); - } - } -} - -//---------------------------------------------------------------------------- void cmFindPackageCommand::FillPrefixesCMakeSystemVariable() { cmSearchPath &paths = this->LabeledPaths[PathLabel::CMakeSystem]; diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h index 949dcb1..3eee404 100644 --- a/Source/cmFindPackageCommand.h +++ b/Source/cmFindPackageCommand.h @@ -89,7 +89,6 @@ private: void FillPrefixesSystemEnvironment(); void FillPrefixesUserRegistry(); void FillPrefixesSystemRegistry(); - void FillPrefixesBuilds(); void FillPrefixesCMakeSystemVariable(); void FillPrefixesUserGuess(); void FillPrefixesUserHints(); @@ -138,7 +137,6 @@ private: bool UseFindModules; bool NoUserRegistry; bool NoSystemRegistry; - bool NoBuilds; bool DebugMode; bool UseLib64Paths; bool PolicyScope; -- cgit v0.12