Re: [Qemu-devel] [PATCH v2] build-sys: add make 'help' target

["Alex Bennée" <alex.bennee@linaro.org>]

Marc-André Lureau <marcandre.lureau@redhat.com> writes:

> Add a make 'help', to print a summary of the main Makefile targets.
> The format is loosely inspired by Linux make 'help' output.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> Makefile | 38 ++++++++++++++++++++++++++++++++++++++
>  1 file changed, 38 insertions(+)
>
> v2:
>  - add architectures targets
>  - move generic targets on top, 'all' first
>  - better describe 'docker' help target
>
> diff --git a/Makefile b/Makefile
> index 50b4b3a..03dbec2 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -669,3 +669,41 @@ endif
>  -include $(wildcard *.d tests/*.d)
>
>  include $(SRC_PATH)/tests/docker/Makefile.include
> +
> +.PHONY: help
> +help:
> +	@echo  'Generic targets:'
> +	@echo  '  all             - Build all'
> +	@echo  '  dir/file.o      - Build specified target only'
> +	@echo  '  install         - Install QEMU, documentation and tools'
> +	@echo  '  ctags/TAGS      - Generate tags file for editors'
> +	@echo  '  cscope          - Generate cscope index'
> +	@echo  ''
> +	@$(if $(TARGET_DIRS), \
> +		echo 'Architecture specific targets:'; \
> +		$(foreach t, $(TARGET_DIRS), \
> +		printf "  %-30s - Build for %s\\n" $(patsubst %,subdir-%,$(t)) $(t);) \
> +		echo '')
> +	@echo  'Cleaning targets:'
> +	@echo  '  clean           - Remove most generated files but keep the config'
> +	@echo  '  distclean       - Remove all generated files'
> +	@echo  '  dist            - Build a distributable tarball'
> +	@echo  ''
> +	@echo  'Test targets:'
> +	@echo  '  check           - Run all tests (check-help for details)'
> +	@echo  '  docker          - Help about targets running tests inside Docker containers'
> +	@echo  '  test/speed      - Run TCG tests'

I wouldn't mention the TCG tests until we've actually fixed them up.

> +	@echo  ''
> +	@echo  'Documentation targets:'
> +	@echo  '  dvi/html/'
> +	@echo  '  info/pdf        - Build documentation in specified format'
> +	@echo  ''
> +ifdef CONFIG_WIN32
> +	@echo  'Windows targets:'
> +	@echo  '  installer       - Build NSIS-based installer for qemu-ga'
> +ifdef QEMU_GA_MSI_ENABLED
> +	@echo  '  msi             - Build MSI-based installer for qemu-ga'
> +endif
> +	@echo  ''
> +endif
> +	@echo  '  make V=0|1 [targets] 0 => quiet build (default), 1 => verbose build'


--
Alex Bennée