CODEWITHSUNDEEP
cmake
Holger
Holger

Reputation: 1859

How do I list the defined make targets from the command line?

I feel almost silly for asking this but I couldn't find anything on this...

Suppose I have a cmake project containing a number of targets (libraries, executables, external targets, etc). How do I list them using the cmake command line interface?

I want a list of things that are valid to substitute for $target in the following command line:

cmake . && cmake --build . --target $target

Lot's of bonus points for a solution that uses neither grep nor find nor python nor perl nor... you get the idea.

Upvotes: 88

Views: 90047

Answers (4)

ken
ken

Reputation: 14545

Answer by @Florian is correct. Just to give some context to it, the command

cmake --build . --target help is assuming your build directory is at current directory, as indicated by the "dot".

If you set your build directory to another directory other than current directory, let say, /build, then you should specify it as cmake --build build --target help.

Alternatively, you can also

cd build
make help

Upvotes: 4

Florian
Florian

Reputation: 43002

For Makefile generator build environments you could use

cmake --build . --target help

And there is the graphical output solution (example found here):

cmake --graphviz=test.graph 
dotty test.graph

See also Generating Dependency Graphs with CMake and CMake Graphviz Output Cleaner.

If you don't have dotty installed, you can still make the target dependencies visible with enabling GLOBAL_DEPENDS_DEBUG_MODE in your CMakeLists.txt:

set_property(GLOBAL PROPERTY GLOBAL_DEPENDS_DEBUG_MODE 1)

The disadavantage here is that you can't trigger it from the command line. It will always show on stderr when generating the make environment.

References

Upvotes: 107

ChrisZZ
ChrisZZ

Reputation: 2181

We may get all targets of the generated Makefile, as @Florian and @Olivia Stork answered.

However, people may just looking for explicitly declared targets in CMakeLists.txt . Targets like "all" and "clean" may not be what people is interested in.

Thus, they can simply query "Built target" in the output of make.

i.e.

cd ~/work/my_project
mkdir build && cd build && cmake ..
make -j4 > log.txt 2>&1
grep 'Built target' log.txt | awk '{print $4}'

Upvotes: 1

Olivia Stork
Olivia Stork

Reputation: 4809

I think you might be looking for the command make help.

When I run make help (after running cmake ..) I get the following output:

The following are some of the valid targets for this Makefile:
... all (the default if no target is provided)
... clean
... depend
etc

You could also read the Makefile that cmake auto-generates for you.

Upvotes: 20

Related Questions