about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2016-05-11 21:30:19 +0200
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2016-05-11 21:30:19 +0200
commit3bb96abce512f17f6ad6404ea093360577094d41 (patch)
tree17403840f9817b873fd68502d5ab98fe6e937375
parent521c0ae1e8dba629881b334df86dd4d6f032a09b (diff)
parent0619eeb739b997701f3e70b964a327573e03f1b3 (diff)
downloadrust-3bb96abce512f17f6ad6404ea093360577094d41.tar.gz
rust-3bb96abce512f17f6ad6404ea093360577094d41.zip
Rollup merge of #33489 - GuillaumeGomez:howto, r=alexcrichton
Improve help for make command

r? @steveklabnik
-rw-r--r--Makefile.in20
1 files changed, 20 insertions, 0 deletions
diff --git a/Makefile.in b/Makefile.in
index 58cd2e31060..7425e9bd73e 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -107,6 +107,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!
+#
 # </tips>
 #
 # <nitty-gritty>
@@ -256,3 +270,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