Commit Graph

10 Commits

Author SHA1 Message Date
Francis Gagné
18341fd23a Rename the dox configuration option to cross_platform_docs
The libc crate is used as a dependency of the Rust compiler. Its build
system passes `--cfg dox` to all crates when generating their
documentation. libc's documentation is generated when the build system
is asked to generate the compiler documentation because `cargo doc`
automatically documents all dependencies.

When the dox configuration option is enabled, libc disables its
dependency on the core crate and provides the necessary definitions
itself. The dox configuration option is meant for generating
documentation for a multitude of targets even if the core crate for that
target is not installed. However, when documenting the compiler, it's
not necessary to do that; we can just use core or std as usual.

This change is motivated by the changes made to the compiler in
rust-lang/rust#48171. With these changes, it's necessary to provide
implementations of the Clone and Copy traits for some primitive types in
the library that defines these traits (previously, these implementations
were provided by the compiler). Normally, these traits (and thus the
implementations) are provided by core, so any crate that uses
`#![no_core]` must now provide its own copy of the implementations.

Because libc doesn't provide its own copy of the implementations yet,
and because the compiler's build system passes `--cfg dox` to libc,
generating the documentation for the compiler fails when generating
documentation for libc. By renaming the configuration option, libc will
use core or std and will thus have the necessary definitions for the
documentation to be generated successfully.
2018-03-18 16:39:40 -04:00
Christian Legnitto
a41c074645 Fix doc generation on travis.
Documentation generation appears to be failing on master (https://travis-ci.org/rust-lang/libc/jobs/183483333):

```
Collecting ghp-import
  Downloading ghp-import-0.4.1.tar.gz
Collecting travis
  Could not find a version that satisfies the requirement travis (from versions: )
No matching distribution found for travis
```

Basically `--user` doesn't appear to take an option, so `pip install ghp_import --user $USER` makes pip think the user is a package that needs to be installed (in this case `travis`). As there is no `travis` package, it dies.
2016-12-14 23:35:58 -08:00
Alex Crichton
ba0aea06b5 Fix links to docs
Closes #49
2015-11-15 13:04:43 -08:00
Alex Crichton
67567dfb63 Revert "Fix links to docs"
This reverts commit 767ba143e3.
2015-11-09 13:54:55 -08:00
Alex Crichton
767ba143e3 Fix links to docs
Closes #49
2015-11-07 15:52:15 -08:00
Alex Crichton
d9962f4bd1 CI dox 2015-09-17 17:45:10 -07:00
Alex Crichton
730a17fd1c Root urls for everyone!
Also refator to only list all the triples once
2015-09-17 10:05:36 -07:00
Alex Crichton
dab1ead5fa Auto-generate an index 2015-09-17 09:52:21 -07:00
Alex Crichton
41afa80f05 Add upload tokens 2015-09-16 23:56:01 -07:00
Alex Crichton
24abc4fb80 Attempt to build docs on Travis 2015-09-16 23:54:56 -07:00