如何获得makefile中的目标列表?

我使用过一些rake(一个Ruby make程序)，它有一个选项，可以获得所有可用目标的列表，例如

> rake --tasks
rake db:charset      # retrieve the charset for your data...
rake db:collation    # retrieve the collation for your da...
rake db:create       # Creates the databases defined in y...
rake db:drop         # Drops the database for your curren...
...

但是在GNU make中似乎没有这样做的选项。

显然，代码几乎已经有了，截至2007年- http://www.mail-archive.com/help-make@gnu.org/msg06434.html。

不管怎样，我做了一个小hack来从makefile中提取目标，你可以将它包含在makefile中。

list:
    @grep '^[^#[:space:]].*:' Makefile

它会给你一个已定义目标的列表。这只是一个开始——例如，它并没有过滤掉依赖关系。

> make list
list:
copy:
run:
plot:
turnin:

当前回答

正如mklement0所指出的，GNU-make中缺少列出所有Makefile目标的功能，他的回答和其他回答提供了实现这一点的方法。

然而，最初的帖子也提到了rake，它的任务开关做的事情与仅仅在rakefile中列出所有任务略有不同。Rake只会给您一个有相关描述的任务列表。没有描述的任务将不会被列出。这使得作者既可以提供定制的帮助描述，也可以省略某些目标的帮助。

如果您想模拟rake的行为，为每个目标提供描述，有一个简单的技术可以做到这一点:在注释中嵌入您想列出的每个目标的描述。

你可以把描述放在目标旁边，或者像我经常做的那样，放在目标上面的PHONY规范旁边，就像这样:

.PHONY: target1 # Target 1 help text
target1: deps
    [... target 1 build commands]

.PHONY: target2 # Target 2 help text
target2:
    [... target 2 build commands]

...                                                                                                         

.PHONY: help # Generate list of targets with descriptions                                                                
help:                                                                                                                    
    @grep '^.PHONY: .* #' Makefile | sed 's/\.PHONY: \(.*\) # \(.*\)/\1 \2/' | expand -t20

它会屈服

$ make help
target1             Target 1 help text
target2             Target 2 help text

...
help                Generate list of targets with descriptions

你也可以在这里找到一个简短的代码示例。

同样，这不能解决在Makefile中列出所有目标的问题。例如，如果您有一个大的Makefile，它可能是生成的或由其他人编写的，并且您想要一种快速的方法来列出它的目标，而不需要深入研究它，那么这将没有帮助。

但是，如果您正在编写Makefile，并且希望以一致的、自记录的方式生成帮助文本，则此技术可能会有用。

2017-08-23 15:16:44

其他回答

我通常这样做:

grep install_targets制作文件

它会返回如下内容:

install_targets = install-xxx1 install-xxx2 ... etc

我希望这对你们有帮助

2019-10-03 09:29:16

@nobar的回答很有帮助地展示了如何使用TAB补全来列出makefile的目标。

这对于默认提供此功能的平台(例如Debian、Fedora)非常有效。在其他平台上(例如Ubuntu)，你必须显式加载这个功能，正如@hek2mgl的回答所暗示的那样: ． /etc/bash_completion安装几个制表符补全函数，包括make函数或者，为make只安装制表符补全: ． /usr/share/bash-completion /完成/

对于根本不提供这个功能的平台，比如OSX，你可以使用下面的命令来实现它:

_complete_make() { COMPREPLY=($(compgen -W "$(make -pRrq : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($1 !~ "^[#.]") {print $1}}' | egrep -v '^[^[:alnum:]]' | sort | xargs)" -- "${COMP_WORDS[$COMP_CWORD]}")); }
complete -F _complete_make make

注意:这并不像Linux发行版附带的制表符补全功能那么复杂:最值得注意的是，它总是以当前目录中的makefile为目标，即使命令行以-f <file>为目标的另一个makefile也是如此。

2014-10-13 12:47:02

Bash脚本

这里有一个非常简单的方法在bash中做到这一点——基于@cibercitizen1上面的评论:

grep : Makefile | awk -F: '/^[^.]/ {print $1;}'

参见@Marc更权威的回答。还有2377，它说明了make的Bash完成模块是如何完成的。

2020-05-21 21:52:42

对于讨厌AWK的人来说，为了简单起见，这个精巧的设计适合我:

help:
  make -qpRr $(lastword $(MAKEFILE_LIST)) | egrep -v '(^(\.|:|#|\s|$)|=)' | cut -d: -f1

(对于在Makefile外部使用，只需删除$(最后一个词…)或将其替换为Makefile路径)。

This solution will not work if you have "interesting" rule names but will work well for most simple setups. The main downside of a make -qp based solution is (as in other answers here) that if the Makefile defines variable values using functions - they will still be executed regardless of -q, and if using $(shell ...) then the shell command will still be called and its side effects will happen. In my setup often the side effects of running shell functions is unwanted output to standard error, so I add 2>/dev/null after the make command.

2020-07-13 09:31:49