about summary refs log tree commit diff
path: root/mk/docs.mk
AgeCommit message (Collapse)AuthorLines
2017-02-06Delete the `mk` folderAlex Crichton-222/+0
This commit deletes the old build system located in the `mk` folder as it's now been obsoleted for two cycles and is replaced by rustbuild.
2016-08-25Also remove build steps for styleSteve Klabnik-8/+1
2016-02-25mk: Move disable-jemalloc logic into makefilesAlex Crichton-2/+2
The `--disable-jemalloc` configure option has a failure mode where it will create a distribution that is not compatible with other compilers. For example the nightly for Linux will assume that it will link to jemalloc by default as an allocator for executable crates. If, however, a standard library is used which was built via `./configure --disable-jemalloc` then this will fail because the jemalloc crate wasn't built. While this seems somewhat reasonable as a niche situation, the same mechanism is used for disabling jemalloc for platforms that just don't support it. For example if the rumprun target is compiled then the sibiling Linux target *also* doesn't have jemalloc. This is currently a problem for our cross-build nightlies which build many targets. If rumprun is also built, it will disable jemalloc for all targets, which isn't desired. This commit moves the platform-specific disabling of jemalloc as hardcoded logic into the makefiles that is scoped per-platform. This way when configuring multiple targets **without the `--disable-jemalloc` option specified** all targets will get jemalloc as they should.
2016-02-14Rename `error-index-generator` to `error_index_generator`Dirk Gadsden-4/+4
This is because the tool compiler passes the name of the tool as a command line `--cfg`. The improved session config parser is stricter and no longer permits invalid meta items (such as "error-index-generator").
2016-02-09Update MakefileGuillaume Gomez-1/+8
2016-02-01Revert "mk: fix some undefined variable warnings"Alex Crichton-2/+2
This reverts commit d03712977d7c913044f2b863269c4491d7fa7c36.
2016-02-01mk: fix some undefined variable warningsTamir Duberstein-2/+2
Some of this is scary stuff. Probably time to lint against this. Found with `make --warn-undefined-variables`.
2015-11-19src/doc/trpl -> src/doc/bookSteve Klabnik-4/+4
The book was located under 'src/doc/trpl' because originally, it was going to be hosted under that URL. Late in the game, before 1.0, we decided that /book was a better one, so we changed the output, but not the input. This causes confusion for no good reason. So we'll change the source directory to look like the output directory, like for every other thing in src/doc.
2015-11-03mk: Move some old docs to the deprecated listBrian Anderson-2/+2
2015-09-02Introduce 'make doc' -> 'make docs'Steve Klabnik-0/+1
Because 'doc' is a directory, when running `make doc`, you'll see this: make: Nothing to be done for `doc'. By adding a target for `doc` to build `docs`, both work. Fixes #14705
2015-08-13Auto merge of #27789 - chriskrycho:remove_pandoc_references, r=steveklabnikbors-89/+2
Per @steveklabnik's comment [here](https://github.com/rust-lang/cargo/issues/739#issuecomment-130085860), the Pandoc components of the Makefile are no longer used, and as such the corresponding components of the documentation are out of date. - I've removed the Pandoc (and therefore also LaTeX) elements of the makefile and confirmed that the build proceeds correctly. - I updated the documentation to reference `rustdoc` and of Pandoc. r? @steveklabnik
2015-08-11mk/docs: remove Pandoc and LaTeX elements.Chris Krycho-89/+2
2015-08-09Use https URLs to refer to rust-lang.org where appropriate.Eli Friedman-2/+2
Also fixes a few outdated links.
2015-08-03rename TARPL to The RustinomiconAlexis Beingessner-5/+5
2015-07-13update build to make tarplAlexis Beingessner-1/+8
2015-06-20diagnostics: Resurrect the Compiler Error Index.Michael Sproul-2/+1
2015-06-09Auto merge of #25836 - steveklabnik:gh25305, r=alexcrichtonbors-0/+1
Fixes #25794
2015-06-09Remove numbers all together from not_found.htmlSteve Klabnik-0/+1
2015-06-03mk: fix the CFG_ENABLE_COMPILER_DOCS spellingGleb Kozyrev-1/+1
2015-05-22Remove error diagnostics uniqueness check and .json generation.Felix S. Klock II-1/+2
This is meant to be a temporary measure to get the builds to be reliable again; see also Issue #25705.
2015-05-05Error index style tweaks.Michael Sproul-1/+1
2015-05-03Add error index generator.Michael Sproul-0/+10
2015-04-07mk: Stop documenating non-facade cratesAlex Crichton-3/+5
This commit ceases documentation-by-default of crates such as `term`, `serialize`, and `alloc`. Crates like `term` and `rand` have duplicates on `crates.io` and the search index entries generated in the local tree end up only leading to confusion. Crates like the entire compiler infrastructure, `flate`, or `rbml` don't need to be documented in such a prominent location. This change also means that doc tests will no longer be run for crates beyond the facade (e.g. `serialize` or `term`), but there were very few doc tests in there to begin with. Closes #22168
2015-04-07mk: Pass the same flags to rustdoc as rustcAlex Crichton-1/+1
This ensures that def ids don't drift too much over time. Closes #15309
2015-03-29mk: don't build docs for internal or behind-the-facade crates in beta/stableCorey Richardson-1/+4
This saves a bunch of a time and will make distributions smaller, as well as avoiding filling the implementors page with internal garbage. Turn it back on with `--enable-compiler-docs` if you want compiler docs during development. Crates behind the facade are only documented on nightly/dev builds (where they can be used). [breaking-change] Closes #23772 Closes #21297
2015-03-04std: Deprecate std::old_io::fsAlex Crichton-0/+2
This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-17rollup merge of #22331: steveklabnik/guidelinesAlex Crichton-1/+7
Fixes #19315 r? @aturon
2015-02-17Fix removal of complement-bugreport.mdManish Goregaokar-1/+1
2015-02-17Rollup merge of #22326 - semarie:compat-cp, r=alexcrichtonManish Goregaokar-4/+4
`cp -a` is a GNU extension. Use an alternate combinaison of POSIX options (`-PRp`) that do nearly the same. The difference is `-a` will preserve context, links and xattr attributes, whereas `-p` not. But as we use it only for copy a file, there is no difference in the current context.
2015-02-16Import rust-guidlinesSteve Klabnik-1/+7
at https://github.com/rust-lang/rust-guidelines/commit/16fa41b3b091e7e532c809c7145dd88b8e4a5513 Fixes #19315
2015-02-14docs.mk: use posix arguments for cpSébastien Marie-4/+4
`cp -a` is a GNU extension. Use an alternate combinaison of POSIX options (`-PRp`) that do nearly the same. The difference is `-a` will preserve context, links and xattr attributes, whereas `-p` not. But as we use it only for copy a file, there is no difference in the current context.
2015-02-13Generate grammar.html and link to it from the reference.Steve Klabnik-1/+1
Fixes #19278
2015-02-11docs: disable PDF docs when latex _isn't_ presentTim Cuthbertson-1/+1
2015-02-05Only accept xelatex for building PDF docsSteve Klabnik-17/+6
None of the others work, so let's remove them. Fixes #17220.
2015-01-09Ensure that the book is built after the doc/ directory.Huon Wilson-1/+1
Without this, rustbook was failing because it was expecting the directory to exist. (Previously, rustbook was just silently failing to install the CSS files due to this.)
2015-01-09Add stub deprecation files for each of the old guides.Huon Wilson-0/+6
There are hundreds of stackoverflow answers, reddit posts and blog articles that link to these documents, so it's a nicer user experience if they're not plain 404s. The intention is to let these hang around only for relatively short while. The alpha is likely to bring in many new users and they will be reading the documents mentioned above.
2015-01-08Fix dead links in the guide and reorganizeAlex Crichton-3/+2
2015-01-08"The Rust Programming Language"Steve Klabnik-8/+19
This pulls all of our long-form documentation into a single document, nicknamed "the book" and formally titled "The Rust Programming Language." A few things motivated this change: * People knew of The Guide, but not the individual Guides. This merges them together, helping discoverability. * You can get all of Rust's longform documentation in one place, which is nice. * We now have rustbook in-tree, which can generate this kind of documentation. While its style is basic, the general idea is much better: a table of contents on the left-hand side. * Rather than a almost 10,000-line guide.md, there are now smaller files per section.
2015-01-05rollup merge of #19998: th0114nd/unicode-bottomAlex Crichton-3/+8
In the HTML version of the documentation, it isn't rendered so might as well use the unicode representation.
2014-12-28mk: Stop generating docs for deprecated cratesAlex Crichton-1/+2
These crates are all deprecated for their rust-lang/$crate equivalents and by generating docs we're generating broken links. The documentation for these crates are generated out-of-tree and are managed separately, so we're not losing the documentation altogether, just the links from the main distribution's docs. Closes #20096
2014-12-19Changed LaTex $\bot$s to ⊥th0114nd-3/+8
In the HTML version of the documentation, it isn't rendered so might as well use the unicode representation. Part of the problem was that putting a math unicode character wasn't rendering properly in the pdf, so extra steps were needed to define the unicode charecter ⊥ in reference.tex closes #15285
2014-12-17remove l10nSteve Klabnik-34/+0
2014-12-04auto merge of #18613 : steveklabnik/rust/ownership_guide, r=huonwbors-1/+1
This is a work in progress, but this should get *extensive* review, so I'm putting it up early and often. This is the start of a draft of the new 'ownership guide,' which explains ownership, borrowing, etc. I'm feeling better about this framing than last time's, but we'll see.
2014-11-26rollup merge of #19322: DiamondLovesYou/multi-llvmdepsAlex Crichton-1/+2
2014-11-26Lifetime guide -> ownership guideSteve Klabnik-1/+1
2014-11-25Don't use the same llvmdeps.rs for every host.Richard Diamond-1/+2
2014-11-24remove the generation of grammar from the referenceSteve Klabnik-20/+0
2014-11-18New guide: error handlingSteve Klabnik-1/+1
2014-11-07Guide: Puts the toc again in the docgamazeps-3/+3
Closes #17505
2014-10-23build the crates guideSteve Klabnik-1/+1