diff options
Diffstat (limited to 'Source/cmSubdirDependsCommand.h')
-rw-r--r-- | Source/cmSubdirDependsCommand.h | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h new file mode 100644 index 0000000..daf97cd --- /dev/null +++ b/Source/cmSubdirDependsCommand.h @@ -0,0 +1,77 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2009 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#ifndef cmSubdirDependsCommand_h +#define cmSubdirDependsCommand_h + +#include "cmCommand.h" + +/** \class cmSubdirDependsCommand + * \brief Legacy command. Do not use. + * + * cmSubdirDependsCommand has been left in CMake for compatability with + * projects already using it. Its functionality in supporting parallel + * builds is now automatic. The command does not do anything. + */ +class cmSubdirDependsCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmSubdirDependsCommand; + } + + /** + * This is called when the command is first encountered in + * the CMakeLists.txt file. + */ + virtual bool InitialPass(std::vector<std::string> const& args, + cmExecutionStatus &status); + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() const { return "subdir_depends";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() const + { + return "Deprecated. Does nothing."; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() const + { + return + " subdir_depends(subdir dep1 dep2 ...)\n" + "Does not do anything. This command used to help projects order " + "parallel builds correctly. This functionality is now automatic."; + } + + /** This command is kept for compatibility with older CMake versions. */ + virtual bool IsDiscouraged() const + { + return true; + } + + cmTypeMacro(cmSubdirDependsCommand, cmCommand); +}; + + + +#endif |