Skip to content

Fix the build documentation parsing #12364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 19, 2014
Merged

Fix the build documentation parsing #12364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ece12d8
mk: Fix the regexp of SHOW_DOCS
Armavica Feb 18, 2014
54f710f
mk: Talk about `make clean` in the build help
Armavica Feb 18, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions Makefile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,17 @@
#
# First, start with one of these build targets:
#
# * all - The default. Builds a complete, bootstrapped compiler.
# * all - The default. Build a complete, bootstrapped compiler.
# `rustc` will be in `${target-triple}/stage2/bin/`. Run it
# directly from the build directory if you like. This also
# comes with docs in `doc/`.
#
# * check - Run the complete test suite
#
# * clean - Clean the build repertory. It is advised to run this
# command if you want to build Rust again, after an update
# of the git repository.
#
# * install - Install Rust. Note that installation is not necessary
# to use the compiler.
#
Expand Down Expand Up @@ -103,7 +107,7 @@
#
# </tips>
#
# <nittygritty>
# <nitty-gritty>
#
# # The Rust Build System
#
Expand Down Expand Up @@ -152,12 +156,12 @@
# libraries are managed and versioned without polluting the common
# areas of the filesystem.
#
# General rust binaries may stil live in the host bin directory; they
# General rust binaries may still live in the host bin directory; they
# will just link against the libraries in the target lib directory.
#
# Admittedly this is a little convoluted.
#
# </nittygritty>
# </nitty-gritty>
#

######################################################################
Expand Down
8 changes: 4 additions & 4 deletions mk/main.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,13 +446,13 @@ all: $(ALL_TARGET_RULES) $(GENERATED) docs
# $(1) is the name of the doc <section> in Makefile.in
# pick everything between tags | remove first line | remove last line
# | remove extra (?) line | strip leading `#` from lines
SHOW_DOCS = $(Q)awk '/$(1)/,/<\/$(1)>/' $(S)/Makefile.in | sed '1d' | sed '$$d' | sed 's/^\# \?//'
SHOW_DOCS = $(Q)awk '/<$(1)>/,/<\/$(1)>/' $(S)/Makefile.in | sed '1d' | sed '$$d' | sed 's/^\# \?//'

help:
$(call SHOW_DOCS,help)

hot-tips:
$(call SHOW_DOCS,hottips)
tips:
$(call SHOW_DOCS,tips)

nitty-gritty:
$(call SHOW_DOCS,nittygritty)
$(call SHOW_DOCS,nitty-gritty)