OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
3a7337ff17
rust/mk/docs.mk

270 lines
8.6 KiB
Makefile
Raw Normal View History

Reliciense makefiles and testsuite. Yup.
2012-12-11 02:32:48 +01:00
# Copyright 2012 The Rust Project Developers. See the COPYRIGHT
# file at the top-level directory of this distribution and at
# http://rust-lang.org/COPYRIGHT.
#
# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
# option. This file may not be copied, modified, or distributed
# except according to those terms.
Start splitting up Makefile.in
2011-05-01 22:18:52 +02:00
######################################################################
# Doc variables and rules
######################################################################
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
DOCS :=
tutorial: Add Japanese translation
2013-08-08 15:38:33 +02:00
DOCS_L10N :=
Start splitting up Makefile.in
2011-05-01 22:18:52 +02:00
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
######################################################################
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 07:51:48 +02:00
# Docs, from pandoc, rustdoc (which runs pandoc), and node
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
######################################################################
doc: Run language ref through prep.js This is so we can strip out support code needed to make the examples work, and as a bonus it does syntax highlighting.
2012-03-21 01:50:32 +01:00
Tidy up doc make rules.
2012-03-27 02:59:09 +02:00
doc/rust.css: rust.css
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
Display the full TOC in the manual. Closes #4194
2012-12-15 03:06:11 +01:00
doc/manual.css: manual.css
@$(call E, cp: $@)
$(Q)cp -a $< $@ 2> /dev/null
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 07:51:48 +02:00
ifeq ($(CFG_PANDOC),)
$(info cfg: no pandoc found, omitting docs)
NO_DOCS = 1
endif
ifeq ($(CFG_NODE),)
$(info cfg: no node found, omitting docs)
NO_DOCS = 1
endif
ifneq ($(NO_DOCS),1)
[makefiles] Don't add css file to set of DOCS targets
2012-01-19 14:19:23 +01:00
DOCS += doc/rust.html
Display the full TOC in the manual. Closes #4194
2012-12-15 03:06:11 +01:00
doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.css
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
@$(call E, pandoc: $@)
doc: Run language ref through prep.js This is so we can strip out support code needed to make the examples work, and as a bonus it does syntax highlighting.
2012-03-21 01:50:32 +01:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
"$(CFG_PANDOC)" \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
--standalone --toc \
--section-divs \
--number-sections \
--from=markdown --to=html \
Add a stylesheet to make the reference HTML look a bit prettier
2012-01-18 09:58:08 +01:00
--css=rust.css \
Display the full TOC in the manual. Closes #4194
2012-12-15 03:06:11 +01:00
--css=manual.css \
doc: improvements to version-stamp makefile logic.
2013-02-06 23:59:03 +01:00
--include-before-body=doc/version_info.html \
doc: Run language ref through prep.js This is so we can strip out support code needed to make the examples work, and as a bonus it does syntax highlighting.
2012-03-21 01:50:32 +01:00
--output=$@
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
mk: Fix pdf build
2013-05-01 02:45:08 +02:00
DOCS += doc/rust.tex
doc: Remove unused keywords.txt
2012-04-20 05:06:13 +02:00
doc/rust.tex: rust.md doc/version.md
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
@$(call E, pandoc: $@)
Prep docs before pdf.
2012-03-27 22:07:26 +02:00
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
"$(CFG_PANDOC)" \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
--standalone --toc \
--number-sections \
doc: improvements to version-stamp makefile logic.
2013-02-06 23:59:03 +01:00
--include-before-body=doc/version.md \
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
--from=markdown --to=latex \
Prep docs before pdf.
2012-03-27 22:07:26 +02:00
--output=$@
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
docs: Sketch out rustpkg manual
2013-04-19 01:15:17 +02:00
DOCS += doc/rustpkg.html
doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css doc/manual.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
"$(CFG_PANDOC)" \
--standalone --toc \
--section-divs \
--number-sections \
--from=markdown --to=html \
--css=rust.css \
--css=manual.css \
--include-before-body=doc/version_info.html \
--output=$@
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 12:51:20 +01:00
DOCS += doc/tutorial.html
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-18 01:15:37 +02:00
doc/tutorial.html: tutorial.md doc/version_info.html doc/rust.css
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 12:51:20 +01:00
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: Split macros out into a separate tutorial
2012-09-05 20:03:36 +02:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
tutorial: Add Japanese translation
2013-08-08 15:38:33 +02:00
DOCS_L10N += doc/l10n/ja/tutorial.html
doc/l10n/ja/tutorial.html: doc/l10n/ja/tutorial.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight doc/l10n/ja/tutorial.md | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
--from=markdown --to=html --css=../../rust.css \
--include-before-body=doc/version_info.html \
--output=$@
doc: Split macros out into a separate tutorial
2012-09-05 20:03:36 +02:00
DOCS += doc/tutorial-macros.html
doc/tutorial-macros.html: tutorial-macros.md doc/version_info.html \
doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: Split out the FFI part of the tutorial The tutorial should perhaps contain an FFI section, but this one is too long.
2012-09-05 20:20:04 +02:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
add a tutorial on containers and iterators
2013-06-28 00:48:12 +02:00
DOCS += doc/tutorial-container.html
doc/tutorial-container.html: tutorial-container.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
doc: Split out the FFI part of the tutorial The tutorial should perhaps contain an FFI section, but this one is too long.
2012-09-05 20:20:04 +02:00
DOCS += doc/tutorial-ffi.html
doc/tutorial-ffi.html: tutorial-ffi.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
docs: Add Niko's borrowed pointers tutorial
2012-09-16 02:09:21 +02:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-borrowed-ptr.html
doc/tutorial-borrowed-ptr.html: tutorial-borrowed-ptr.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
doc: Split out task tutorail. Add links to sub-tutorials
2012-09-23 00:33:50 +02:00
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-tasks.html
doc/tutorial-tasks.html: tutorial-tasks.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 12:51:20 +01:00
--from=markdown --to=html --css=rust.css \
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-18 01:15:37 +02:00
--include-before-body=doc/version_info.html \
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 12:51:20 +01:00
--output=$@
doc: add condition tutorial
2013-08-17 01:03:24 +02:00
DOCS += doc/tutorial-conditions.html
doc/tutorial-conditions.html: tutorial-conditions.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
Add rustpkg tutorial to the official tutorials. Three things in this commit: 1. Actually build the rustpkg tutorial. I didn't know I needed this when I first wrote it. 2. Link to it rather than the manual from the tutorial. 3. Update the headers: most of them were one level too deeply nested.
2013-09-23 23:36:38 +02:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
DOCS += doc/tutorial-rustpkg.html
doc/tutorial-rustpkg.html: tutorial-rustpkg.md doc/version_info.html doc/rust.css
@$(call E, pandoc: $@)
doc: add condition tutorial
2013-08-17 01:03:24 +02:00
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
$(CFG_PANDOC) --standalone --toc \
--section-divs --number-sections \
--from=markdown --to=html --css=rust.css \
--include-before-body=doc/version_info.html \
--output=$@
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 07:51:48 +02:00
ifeq ($(CFG_PDFLATEX),)
$(info cfg: no pdflatex found, omitting doc/rust.pdf)
else
ifeq ($(CFG_XETEX),)
$(info cfg: no xetex found, disabling doc/rust.pdf)
else
ifeq ($(CFG_LUATEX),)
$(info cfg: lacking luatex, disabling pdflatex)
else
mk: Fix pdf build
2013-05-01 02:45:08 +02:00
DOCS += doc/rust.pdf
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 07:51:48 +02:00
doc/rust.pdf: doc/rust.tex
@$(call E, pdflatex: $@)
$(Q)$(CFG_PDFLATEX) \
-interaction=batchmode \
-output-directory=doc \
$<
endif
endif
Move tutorial over to a format similar to the reference doc And adjust highlighting/testing scripts to deal with this.
2012-01-19 12:51:20 +01:00
endif
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-13 04:10:30 +01:00
mk: reorganize doc build to fix dependencies. #6042 Most of our documentation requires both pandoc and node.js. This simplifies the logic around those checks and fixes an error when building without node.js but with pandoc.
2013-04-24 07:51:48 +02:00
endif # No pandoc / node
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
######################################################################
# LLnextgen (grammar analysis from refman)
######################################################################
ifeq ($(CFG_LLNEXTGEN),)
$(info cfg: no llnextgen found, omitting grammar-verification)
else
.PHONY: verify-grammar
doc/rust.g: rust.md $(S)src/etc/extract_grammar.py
@$(call E, extract_grammar: $@)
add missing $(CFG_PYTHON) prefixes
2013-01-03 08:53:05 +01:00
$(Q)$(CFG_PYTHON) $(S)src/etc/extract_grammar.py $< >$@
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
verify-grammar: doc/rust.g
@$(call E, LLnextgen: $<)
$(Q)$(CFG_LLNEXTGEN) --generate-lexer-wrapper=no $< >$@
$(Q)rm -f doc/rust.c doc/rust.h
Move the ifdefs to nest properly. Real clever.
2012-01-18 01:49:57 +01:00
endif
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
######################################################################
libstd: Rename libcore to libstd and libstd to libextra; update makefiles. This only changes the directory names; it does not change the "real" metadata names.
2013-05-17 19:45:09 +02:00
# Rustdoc (libstd/extra)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
######################################################################
Start splitting up Makefile.in
2011-05-01 22:18:52 +02:00
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
# The rustdoc executable
mk: cleanup - lib and executable suffix handling
2013-03-02 13:25:12 +01:00
RUSTDOC = $(HBIN2_H_$(CFG_BUILD_TRIPLE))/rustdoc$(X_$(CFG_BUILD_TRIPLE))
Establish 'core' library separate from 'std'.
2011-12-06 01:46:37 +01:00
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
# The library documenting macro
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 08:25:48 +02:00
# $(1) - The crate name (std/extra)
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
# $(2) - The crate file
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 08:25:48 +02:00
# $(3) - The relevant host build triple (to depend on libstd)
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
define libdoc
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 08:25:48 +02:00
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
@$$(call E, rustdoc: $$@)
rustdoc: Add the ability to input json This modifies the command-line usage of rustdoc to intake its own JSON output as well as a rust source file. This also alters the command line from `rustdoc input file` to `rustdoc file` with the input/output formats specified as -r and -w, respectively. When using a JSON input, no passes or plugins are re-run over the json, instead the output is generated directly from the JSON that was provided. Passes and plugins are still run on rust source input, however.
2013-09-30 21:58:18 +02:00
$(Q)$(RUSTDOC) $(2)
Establish 'core' library separate from 'std'.
2011-12-06 01:46:37 +01:00
build: Switch from naturaldocs to rustdoc
2012-03-10 07:53:46 +01:00
DOCS += doc/$(1)/index.html
Establish 'core' library separate from 'std'.
2011-12-06 01:46:37 +01:00
endef
rustdoc: Out with the old, in with the new Removes old rustdoc, moves rustdoc_ng into its place instead (plus drops the _ng suffix). Also shreds all reference to rustdoc_ng from the Makefile rules.
2013-09-22 08:25:48 +02:00
$(eval $(call libdoc,std,$(STDLIB_CRATE),$(CFG_BUILD_TRIPLE)))
$(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD_TRIPLE)))
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
ifdef CFG_DISABLE_DOCS
$(info cfg: disabling doc build (CFG_DISABLE_DOCS))
DOCS :=
endif
doc: improvements to version-stamp makefile logic.
2013-02-06 23:59:03 +01:00
doc/version.md: $(MKFILE_DEPS) $(wildcard $(S)doc/*.*)
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
@$(call E, version-stamp: $@)
Tidy tidy
2012-01-18 23:45:47 +01:00
$(Q)echo "$(CFG_VERSION)" >$@
Refactor the doc building rules a bit, sensitize them to the presence or absence of xetex and luatex (for now).
2012-01-18 23:14:28 +01:00
doc: improvements to version-stamp makefile logic.
2013-02-06 23:59:03 +01:00
doc/version_info.html: version_info.html.template $(MKFILE_DEPS) \
$(wildcard $(S)doc/*.*)
Add a badge to the tutorial and reference docs indicating which Rust version they pertain to.
2012-07-18 01:15:37 +02:00
@$(call E, version-info: $@)
sed -e "s/VERSION/$(CFG_RELEASE)/; s/SHORT_HASH/$(shell echo \
$(CFG_VER_HASH) | head -c 8)/;\
s/STAMP/$(CFG_VER_HASH)/;" $< >$@
doc: improvements to version-stamp makefile logic.
2013-02-06 23:59:03 +01:00
GENERATED += doc/version.md doc/version_info.html
Make clean cleaner.
2011-12-30 21:47:43 +01:00
docs: $(DOCS)
Use po4a to provide translatable documentation This commit add a new "docs-l10n" make target which uses po4a to: * create .pot (PO templates) from markdown doc * update templates and po for enabled languages * generate translated markdown for completed (> 80%) translations Currently, no language has been activated. Signed-off-by: Luca Bruno <lucab@debian.org>
2013-07-07 21:12:00 +02:00
tutorial: Add Japanese translation
2013-08-08 15:38:33 +02:00
docs-l10n: $(DOCS_L10N)
doc/l10n/%.md: doc/po/%.md.po doc/po4a.conf
Add project information to l10n templates.
2013-07-17 00:18:42 +02:00
po4a --copyright-holder="The Rust Project Developers" \
--package-name="Rust" \
--package-version="$(CFG_RELEASE)" \
doc: Add -M and -L option to po4a
2013-07-30 00:05:47 +02:00
-M UTF-8 -L UTF-8 \
Add project information to l10n templates.
2013-07-17 00:18:42 +02:00
doc/po4a.conf
Use po4a to provide translatable documentation This commit add a new "docs-l10n" make target which uses po4a to: * create .pot (PO templates) from markdown doc * update templates and po for enabled languages * generate translated markdown for completed (> 80%) translations Currently, no language has been activated. Signed-off-by: Luca Bruno <lucab@debian.org>
2013-07-07 21:12:00 +02:00
.PHONY: docs-l10n
Reference in New Issue Copy Permalink