summaryrefslogtreecommitdiff
path: root/GNUmakefile
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2019-08-21 01:02:43 +0200
committerStefan Kangas <stefankangas@gmail.com>2019-08-29 11:58:23 +0200
commit9df285250bc30b5ba86a19c817eea0c56164e022 (patch)
tree580377a6ecd161d728c1f93ef8c7de49001940eb /GNUmakefile
parentd87e9a59cde7466780c6c9bec4702665f7eb86e1 (diff)
downloademacs-9df285250bc30b5ba86a19c817eea0c56164e022.tar.gz
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.
Diffstat (limited to 'GNUmakefile')
-rw-r--r--GNUmakefile33
1 files changed, 33 insertions, 0 deletions
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