]> git.lizzy.rs Git - rust.git/commitdiff
Rollup merge of #33489 - GuillaumeGomez:howto, r=alexcrichton
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Wed, 11 May 2016 19:30:19 +0000 (21:30 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Wed, 11 May 2016 19:30:19 +0000 (21:30 +0200)
Improve help for make command

r? @steveklabnik

Makefile.in

index 58cd2e31060f5be09dadf822be2177296b4959f4..7425e9bd73e95913b75af6d7b8d345a05218b819 100644 (file)
 #
 #     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