From 0619eeb739b997701f3e70b964a327573e03f1b3 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sat, 7 May 2016 23:51:13 +0200 Subject: [PATCH] Add default rule for Makefile and make it displays some help. Add examples for "make help" command --- Makefile.in | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Makefile.in b/Makefile.in index ce67abad39b24..55c091aef76d2 100644 --- a/Makefile.in +++ b/Makefile.in @@ -108,6 +108,20 @@ # # run `make nitty-gritty` # +# # Make command examples +# +# ## Docs linked commands +# +# * make check-stage1-rustdocck: Builds rustdoc. It has the advantage to compile +# quite quickly since we're only using stage1 +# executables. +# * make doc/error-index.md: Gets all doc blocks from doc comments and error +# explanations to put them in a markdown file. You +# can then test them by running +# "rustdoc --test error-index.md". +# +# And of course, the wonderfully useful 'make tidy'! Always run it before opening a pull request to rust! +# # # # @@ -257,3 +271,9 @@ ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \ CFG_INFO := $(info cfg: including ctags rules) include $(CFG_SRC_DIR)mk/ctags.mk endif + +.DEFAULT: + @echo "\n======================================================" + @echo "== If you need help, run 'make help' or 'make tips' ==" + @echo "======================================================\n" + exit 1