Skip to content

Commit 0619eeb

Browse files
Add default rule for Makefile and make it displays some help.
Add examples for "make help" command
1 parent 3157691 commit 0619eeb

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

Makefile.in

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,20 @@
108108
#
109109
# run `make nitty-gritty`
110110
#
111+
# # Make command examples
112+
#
113+
# ## Docs linked commands
114+
#
115+
# * make check-stage1-rustdocck: Builds rustdoc. It has the advantage to compile
116+
# quite quickly since we're only using stage1
117+
# executables.
118+
# * make doc/error-index.md: Gets all doc blocks from doc comments and error
119+
# explanations to put them in a markdown file. You
120+
# can then test them by running
121+
# "rustdoc --test error-index.md".
122+
#
123+
# And of course, the wonderfully useful 'make tidy'! Always run it before opening a pull request to rust!
124+
#
111125
# </tips>
112126
#
113127
# <nitty-gritty>
@@ -257,3 +271,9 @@ ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \
257271
CFG_INFO := $(info cfg: including ctags rules)
258272
include $(CFG_SRC_DIR)mk/ctags.mk
259273
endif
274+
275+
.DEFAULT:
276+
@echo "\n======================================================"
277+
@echo "== If you need help, run 'make help' or 'make tips' =="
278+
@echo "======================================================\n"
279+
exit 1

0 commit comments

Comments
 (0)