From 110e5dd1ac5fc1ac83f803560f0d2e65b77d7a49 Mon Sep 17 00:00:00 2001 From: Kevin Ballard Date: Sat, 11 Jan 2014 17:23:55 -0800 Subject: [PATCH 1/3] doc: build the docs for librustpkg --- .gitignore | 1 + doc/index.md | 2 ++ mk/docs.mk | 4 +++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c70dfb2a02c2..37a98c45a6ba 100644 --- a/.gitignore +++ b/.gitignore @@ -80,6 +80,7 @@ src/.DS_Store /doc/rustc /doc/syntax /doc/rustuv +/doc/rustpkg /nd/ /llvm/ version.md diff --git a/doc/index.md b/doc/index.md index 04682a56e974..39d535a5aebd 100644 --- a/doc/index.md +++ b/doc/index.md @@ -29,6 +29,8 @@ [The M:N runtime library, `libgreen`](green/index.html) [The 1:1 runtime library, `libnative`](native/index.html) +[The Rust packaging library, `librustpkg`](rustpkg/index.html) + [The Rust parser, `libsyntax`](syntax/index.html) [The Rust compiler, `librustc`](rustc/index.html) diff --git a/mk/docs.mk b/mk/docs.mk index d01ebb437702..1982ab0050c1 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -289,7 +289,8 @@ RUSTDOC = $(HBIN2_H_$(CFG_BUILD))/rustdoc$(X_$(CFG_BUILD)) # # Passes --cfg stage2 to rustdoc because it uses the stage2 librustc. define libdoc -doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3)) +doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3)) \ + $(foreach name,$(4),$$(TLIB2_T_$(3)_H_$(3))/$$(CFG_$(name)_$(3))) @$$(call E, rustdoc: $$@) $(Q)$(RUSTDOC) --cfg stage2 $(2) @@ -309,6 +310,7 @@ $(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD))) $(eval $(call libdoc,native,$(LIBNATIVE_CRATE),$(CFG_BUILD))) $(eval $(call libdoc,green,$(LIBGREEN_CRATE),$(CFG_BUILD))) $(eval $(call libdoc,rustuv,$(LIBRUSTUV_CRATE),$(CFG_BUILD))) +$(eval $(call libdoc,rustpkg,$(RUSTPKG_LIB),$(CFG_BUILD),EXTRALIB LIBRUSTC)) $(eval $(call compiledoc,rustc,$(COMPILER_CRATE),$(CFG_BUILD))) $(eval $(call compiledoc,syntax,$(LIBSYNTAX_CRATE),$(CFG_BUILD))) From de6f213927f4b4040a970b19cd5060698fb6731f Mon Sep 17 00:00:00 2001 From: Kevin Ballard Date: Sat, 11 Jan 2014 19:15:05 -0800 Subject: [PATCH 2/3] Restore missing line breaks in doc/index.html a30d61b05a removed all of the trailing whitespace in doc/index.md. Unfortunately, that trailing whitespace was actually markdown syntax for line breaks. --- doc/index.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/index.md b/doc/index.md index 39d535a5aebd..2d8911897c43 100644 --- a/doc/index.md +++ b/doc/index.md @@ -6,32 +6,32 @@ .header-section-number { display: none; } -[The Rust tutorial](tutorial.html) ([PDF](tutorial.pdf)) -[The Rust reference manual](rust.html) ([PDF](rust.pdf)) +[The Rust tutorial](tutorial.html) ([PDF](tutorial.pdf)) +[The Rust reference manual](rust.html) ([PDF](rust.pdf)) # Guides -[Pointers](guide-pointers.html) -[References and Lifetimes](guide-lifetimes.html) -[Containers and Iterators](guide-container.html) -[Tasks and Communication](guide-tasks.html) -[Foreign Function Interface](guide-ffi.html) -[Macros](guide-macros.html) -[Packaging](guide-rustpkg.html) -[Testing](guide-testing.html) +[Pointers](guide-pointers.html) +[References and Lifetimes](guide-lifetimes.html) +[Containers and Iterators](guide-container.html) +[Tasks and Communication](guide-tasks.html) +[Foreign Function Interface](guide-ffi.html) +[Macros](guide-macros.html) +[Packaging](guide-rustpkg.html) +[Testing](guide-testing.html) [Conditions](guide-conditions.html) # Libraries -[The standard library, `libstd`](std/index.html) +[The standard library, `libstd`](std/index.html) [The extra library, `libextra`](extra/index.html) -[The M:N runtime library, `libgreen`](green/index.html) +[The M:N runtime library, `libgreen`](green/index.html) [The 1:1 runtime library, `libnative`](native/index.html) [The Rust packaging library, `librustpkg`](rustpkg/index.html) -[The Rust parser, `libsyntax`](syntax/index.html) +[The Rust parser, `libsyntax`](syntax/index.html) [The Rust compiler, `librustc`](rustc/index.html) # Tooling @@ -40,14 +40,14 @@ # FAQs -[Language FAQ](complement-lang-faq.html) -[Project FAQ](complement-project-faq.html) -[Usage FAQ](complement-usage-faq.html) -[Code cheatsheet](complement-cheatsheet.html) - "How do I do X?" +[Language FAQ](complement-lang-faq.html) +[Project FAQ](complement-project-faq.html) +[Usage FAQ](complement-usage-faq.html) +[Code cheatsheet](complement-cheatsheet.html) - "How do I do X?" [How to submit a bug report](complement-bugreport.html) # External resources -The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org -The Rust community on [Reddit](http://reddit.com/r/rust) +The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org +The Rust community on [Reddit](http://reddit.com/r/rust) The Rust [wiki](http://github.com/mozilla/rust/wiki) From d76ce5f31eb8302076b6b2e3f8bb28560a12cc94 Mon Sep 17 00:00:00 2001 From: Kevin Ballard Date: Sat, 11 Jan 2014 19:16:25 -0800 Subject: [PATCH 3/3] Add librustuv to doc/index.md --- doc/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/index.md b/doc/index.md index 2d8911897c43..456fedf2d470 100644 --- a/doc/index.md +++ b/doc/index.md @@ -29,6 +29,7 @@ [The M:N runtime library, `libgreen`](green/index.html) [The 1:1 runtime library, `libnative`](native/index.html) +[The Rust libuv library, `librustuv`](rustuv/index.html) [The Rust packaging library, `librustpkg`](rustpkg/index.html) [The Rust parser, `libsyntax`](syntax/index.html)