Source/cmSubdirDependsCommand.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmSubdirDependsCommand_h
  13 #define cmSubdirDependsCommand_h
  14
  15 #include "cmCommand.h"
  16
  17 /** \class cmSubdirDependsCommand
  18  * \brief Legacy command.  Do not use.
  19  *
  20  * cmSubdirDependsCommand has been left in CMake for compatability with
  21  * projects already using it.  Its functionality in supporting parallel
  22  * builds is now automatic.  The command does not do anything.
  23  */
  24 class cmSubdirDependsCommand : public cmCommand
  25 {
  26 public:
  27   /**
  28    * This is a virtual constructor for the command.
  29    */
  30   virtual cmCommand* Clone()
  31     {
  32     return new cmSubdirDependsCommand;
  33     }
  34
  35   /**
  36    * This is called when the command is first encountered in
  37    * the CMakeLists.txt file.
  38    */
  39   virtual bool InitialPass(std::vector<std::string> const& args,
  40                            cmExecutionStatus &status);
  41
  42   /**
  43    * The name of the command as specified in CMakeList.txt.
  44    */
  45   virtual const char* GetName() const { return "subdir_depends";}
  46
  47   /**
  48    * Succinct documentation.
  49    */
  50   virtual const char* GetTerseDocumentation() const
  51     {
  52     return "Deprecated.  Does nothing.";
  53     }
  54
  55   /**
  56    * More documentation.
  57    */
  58   virtual const char* GetFullDocumentation() const
  59     {
  60     return
  61       "  subdir_depends(subdir dep1 dep2 ...)\n"
  62       "Does not do anything.  This command used to help projects order "
  63       "parallel builds correctly.  This functionality is now automatic.";
  64     }
  65
  66   /** This command is kept for compatibility with older CMake versions. */
  67   virtual bool IsDiscouraged() const
  68     {
  69     return true;
  70     }
  71
  72   cmTypeMacro(cmSubdirDependsCommand, cmCommand);
  73 };
  74
  75
  76
  77 #endif