From 9df285250bc30b5ba86a19c817eea0c56164e022 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Wed, 21 Aug 2019 01:02:43 +0200 Subject: Add new "make help" target * GNUmakefile: Add new "help" target that shows a brief summary of common make targets. (Bug#12411) * INSTALL * etc/NEWS: Announce it. --- GNUmakefile | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) (limited to 'GNUmakefile') diff --git a/GNUmakefile b/GNUmakefile index a67624e1f73..274109ca484 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -32,6 +32,38 @@ # But run 'autogen.sh' first, if the source was checked out directly # from the repository. +# Display help. + +ifeq (help,$(filter help,$(MAKECMDGOALS))) +help: + @echo "NOTE: This is a brief summary of some common make targets." + @echo "For more detailed information, please read the files INSTALL," + @echo "INSTALL.REPO, Makefile or visit this URL:" + @echo "http://www.gnu.org/prep/standards/html_node/Standard-Targets.html" + @echo "" + @echo "make all -- compile and build Emacs" + @echo "make install -- install Emacs" + @echo "make TAGS -- update tags tables" + @echo "make clean -- delete built files but preserve configuration" + @echo "make mostlyclean -- like 'make clean', but leave those files that" + @echo " usually do not need to be recompiled" + @echo "make distclean -- delete all build and configuration files," + @echo " leave only files included in source distribution" + @echo "make maintainer-clean -- delete almost everything that can be regenerated" + @echo "make bootstrap -- delete all compiled files to force a new bootstrap" + @echo " from a clean slate, then build in the normal way" + @echo "make uninstall -- remove files installed by 'make install'" + @echo "make check -- run the Emacs test suite" + @echo "make docs -- generate Emacs documentation in info format" + @echo "make html -- generate documentation in html format" + @echo "make ps -- generate documentation in ps format" + @echo "make pdf -- generate documentation in pdf format " + @exit + +.PHONY: help + +else + # If a Makefile already exists, just use it. ifeq ($(wildcard Makefile),Makefile) @@ -82,3 +114,4 @@ bootstrap: Makefile endif endif +endif -- cgit v1.2.1