blob: bf21ab5762af59645397080b4cc273fa42bf9951 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmSubdirCommand_h
#define cmSubdirCommand_h
#include "cmCommand.h"
/** \class cmSubdirCommand
* \brief Specify a list of subdirectories to build.
*
* cmSubdirCommand specifies a list of subdirectories to process
* by CMake. For each subdirectory listed, CMake will descend
* into that subdirectory and process any CMakeLists.txt found.
*/
class cmSubdirCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmSubdirCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "subdirs";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the add_subdirectory() command instead.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"Add a list of subdirectories to the build.\n"
" subdirs(dir1 dir2 ..."
"[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n"
"Add a list of subdirectories to the build. The add_subdirectory "
"command should be used instead of subdirs although subdirs will "
"still work. "
"This will cause any CMakeLists.txt files in the sub directories "
"to be processed by CMake. Any directories after the PREORDER flag "
"are traversed first by makefile builds, the PREORDER flag has no "
"effect on IDE projects. "
" Any directories after the EXCLUDE_FROM_ALL marker "
"will not be included in the top level makefile or project file. "
"This is useful for having CMake create makefiles or projects for "
"a set of examples in a project. You would want CMake to "
"generate makefiles or project files for all the examples at "
"the same time, but you would not want them to show up in the "
"top level project or be built each time make is run from the top.";
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
cmTypeMacro(cmSubdirCommand, cmCommand);
};
#endif
|
