---

yaml
---
r: 227298
b: refs/heads/auto
c: 4561607
h: refs/heads/master
v: v3

Author: nikomatsakis

[refs]

@@ -8,7 +8,7 @@ refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503
 refs/tags/release-0.3.1: 495bae036dfe5ec6ceafd3312b4dca48741e845b
 refs/tags/release-0.4: e828ea2080499553b97dfe33b3f4d472b4562ad7
 refs/tags/release-0.5: 7e3bcfbf21278251ee936ad53e92e9b719702d73
-refs/heads/auto: 0649b16ade40d1fb02ea5c390293278bd876854a
+refs/heads/auto: 4561607403e1595d5ecbf36716711bc0076506f0
 refs/tags/release-0.6: b4ebcfa1812664df5e142f0134a5faea3918544c
 refs/tags/0.1: b19db808c2793fe2976759b85a355c3ad8c8b336
 refs/tags/0.2: 1754d02027f2924bed83b0160ee340c7f41d5ea1

branches/auto/mk/docs.mk

@@ -13,6 +13,9 @@
 #
 # The DOCS variable is their names (with no file extension).
 #
+# PDF_DOCS lists the targets for which PDF documentation should be
+# build.
+#
 # RUSTDOC_FLAGS_xyz variables are extra arguments to pass to the
 # rustdoc invocation for xyz.
 #
@@ -32,6 +35,8 @@ DOCS += guide-crates guide-error-handling guide-ffi guide-macros guide \
     guide-testing
 
 
+PDF_DOCS := reference
+
 RUSTDOC_DEPS_reference := doc/full-toc.inc
 RUSTDOC_FLAGS_reference := --html-in-header=doc/full-toc.inc
 
@@ -47,6 +52,13 @@ RUSTDOC_HTML_OPTS_NO_CSS = --html-before-content=doc/version_info.html \
 
 RUSTDOC_HTML_OPTS = $(RUSTDOC_HTML_OPTS_NO_CSS) --markdown-css rust.css
 
+PANDOC_BASE_OPTS := --standalone --toc --number-sections
+PANDOC_TEX_OPTS = $(PANDOC_BASE_OPTS) --from=markdown --to=latex \
+	--include-before-body=doc/version.tex \
+	--include-before-body=doc/footer.tex \
+	--include-in-header=doc/uptack.tex
+PANDOC_EPUB_OPTS = $(PANDOC_BASE_OPTS) --to=epub
+
 # The rustdoc executable...
 RUSTDOC_EXE = $(HBIN2_H_$(CFG_BUILD))/rustdoc$(X_$(CFG_BUILD))
 # ...with rpath included in case --disable-rpath was provided to
@@ -77,10 +89,30 @@ else
 HTML_DEPS :=
 endif
 
+# Check for xelatex
+
+ifneq ($(CFG_XELATEX),)
+    CFG_LATEX := $(CFG_XELATEX)
+    XELATEX = 1
+  else
+    $(info cfg: no xelatex found, disabling LaTeX docs)
+    NO_PDF_DOCS = 1
+endif
+
+ifeq ($(CFG_PANDOC),)
+$(info cfg: no pandoc found, omitting PDF and EPUB docs)
+ONLY_HTML_DOCS = 1
+endif
+
+
 ######################################################################
 # Rust version
 ######################################################################
 
+doc/version.tex: $(MKFILE_DEPS) $(wildcard $(D)/*.*) | doc/
+	@$(call E, version-stamp: $@)
+	$(Q)echo "$(CFG_VERSION)" >$@
+
 HTML_DEPS += doc/version_info.html
 doc/version_info.html: $(D)/version_info.html.template $(MKFILE_DEPS) \
                        $(wildcard $(D)/*.*) | doc/
@@ -89,10 +121,10 @@ doc/version_info.html: $(D)/version_info.html.template $(MKFILE_DEPS) \
                 s/SHORT_HASH/$(CFG_SHORT_VER_HASH)/; \
                 s/STAMP/$(CFG_VER_HASH)/;" $< >$@
 
-GENERATED += doc/version_info.html
+GENERATED += doc/version.tex doc/version_info.html
 
 ######################################################################
-# Docs from rustdoc
+# Docs, from rustdoc and sometimes pandoc
 ######################################################################
 
 doc/:
@@ -118,6 +150,20 @@ doc/footer.inc: $(D)/footer.inc | doc/
 	$(Q)cp -PRp $< $@ 2> /dev/null
 
 # The (english) documentation for each doc item.
+
+define DEF_SHOULD_BUILD_PDF_DOC
+SHOULD_BUILD_PDF_DOC_$(1) = 1
+endef
+$(foreach docname,$(PDF_DOCS),$(eval $(call DEF_SHOULD_BUILD_PDF_DOC,$(docname))))
+
+doc/footer.tex: $(D)/footer.inc | doc/
+	@$(call E, pandoc: $@)
+	$(CFG_PANDOC) --from=html --to=latex $< --output=$@
+
+doc/uptack.tex: $(D)/uptack.tex | doc/
+	$(Q)cp $< $@
+
+# HTML (rustdoc)
 DOC_TARGETS += doc/not_found.html
 doc/not_found.html: $(D)/not_found.md $(HTML_DEPS) | doc/
 	@$(call E, rustdoc: $@)
@@ -133,6 +179,47 @@ doc/$(1).html: $$(D)/$(1).md $$(HTML_DEPS) $$(RUSTDOC_DEPS_$(1)) | doc/
 	@$$(call E, rustdoc: $$@)
 	$$(Q)$$(RUSTDOC) $$(RUSTDOC_HTML_OPTS) $$(RUSTDOC_FLAGS_$(1)) $$<
 
+ifneq ($(ONLY_HTML_DOCS),1)
+
+# EPUB (pandoc directly)
+DOC_TARGETS += doc/$(1).epub
+doc/$(1).epub: $$(D)/$(1).md | doc/
+	@$$(call E, pandoc: $$@)
+	$$(CFG_PANDOC) $$(PANDOC_EPUB_OPTS) $$< --output=$$@
+
+# PDF (md =(pandoc)=> tex =(pdflatex)=> pdf)
+DOC_TARGETS += doc/$(1).tex
+doc/$(1).tex: $$(D)/$(1).md doc/uptack.tex doc/footer.tex doc/version.tex | doc/
+	@$$(call E, pandoc: $$@)
+	$$(CFG_PANDOC) $$(PANDOC_TEX_OPTS) $$< --output=$$@
+
+ifneq ($(NO_PDF_DOCS),1)
+ifeq ($$(SHOULD_BUILD_PDF_DOC_$(1)),1)
+DOC_TARGETS += doc/$(1).pdf
+ifneq ($(XELATEX),1)
+doc/$(1).pdf: doc/$(1).tex
+	@$$(call E, latex compiler: $$@)
+	$$(Q)$$(CFG_LATEX) \
+	-interaction=batchmode \
+	-output-directory=doc \
+	$$<
+else
+# The version of xelatex on the snap bots seemingly ingores -output-directory
+# So we'll output to . and move to the doc directory manually.
+# This will leave some intermediate files in the build directory.
+doc/$(1).pdf: doc/$(1).tex
+	@$$(call E, latex compiler: $$@)
+	$$(Q)$$(CFG_LATEX) \
+	-interaction=batchmode \
+	-output-directory=. \
+	$$<
+	$$(Q)mv ./$(1).pdf $$@
+endif # XELATEX
+endif # SHOULD_BUILD_PDF_DOCS_$(1)
+endif # NO_PDF_DOCS
+
+endif # ONLY_HTML_DOCS
+
 endef
 
 $(foreach docname,$(DOCS),$(eval $(call DEF_DOC,$(docname))))

branches/auto/mk/tests.mk

@@ -268,10 +268,9 @@ tidy-basic:
 .PHONY: tidy-binaries
 tidy-binaries:
 		@$(call E, check: binaries)
-		$(Q)find $(S)src -type f \
-		    \( -perm -u+x -or -perm -g+x -or -perm -o+x \) \
+		$(Q)find $(S)src -type f -perm +a+x \
 		    -not -name '*.rs' -and -not -name '*.py' \
-		    -and -not -name '*.sh' -and -not -name '*.pp' \
+		    -and -not -name '*.sh' \
 		| grep '^$(S)src/jemalloc' -v \
 		| grep '^$(S)src/libuv' -v \
 		| grep '^$(S)src/llvm' -v \

branches/auto/src/doc/README.md

@@ -1,5 +1,11 @@
 # Rust documentations
 
+## Dependencies
+
+[Pandoc](http://johnmacfarlane.net/pandoc/installing.html), a universal
+document converter, is required to generate docs as HTML from Rust's
+source code.
+
 ## Building
 
 To generate all the docs, just run `make docs` from the root of the repository.
@@ -20,12 +26,15 @@ To generate an HTML version of a doc from Markdown manually, you can do
 something like:
 
 ~~~~
-rustdoc reference.md
+pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
 ~~~~
 
 (`reference.md` being the Rust Reference Manual.)
 
-An overview of how to use the `rustdoc` command is available [in the docs][1].
-Further details are available from the command line by with `rustdoc --help`.
+The syntax for pandoc flavored markdown can be found at:
+
+- http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
+
+A nice quick reference (for non-pandoc markdown) is at:
 
-[1]: https://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md
+- http://kramdown.gettalong.org/quickref.html

branches/auto/src/doc/trpl/the-stack-and-the-heap.md

@@ -549,7 +549,7 @@ reuse.
 If you’d like to dive into this topic in greater detail, [this paper][wilson]
 is a great introduction.
 
-[wilson]: http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.143.4688
+[wilson]: http://www.cs.northwestern.edu/~pdinda/icsclass/doc/dsa.pdf
 
 ## Semantic impact