18341fd23a
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.
34 lines
1 KiB
Bash
34 lines
1 KiB
Bash
#!/bin/sh
|
|
|
|
# Builds documentation for all target triples that we have a registered URL for
|
|
# in liblibc. This scrapes the list of triples to document from `src/lib.rs`
|
|
# which has a bunch of `html_root_url` directives we pick up.
|
|
|
|
set -e
|
|
|
|
TARGETS=`grep html_root_url src/lib.rs | sed 's/.*".*\/\(.*\)"/\1/'`
|
|
|
|
rm -rf target/doc
|
|
mkdir -p target/doc
|
|
|
|
cp ci/landing-page-head.html target/doc/index.html
|
|
|
|
for target in $TARGETS; do
|
|
echo documenting $target
|
|
|
|
rustdoc -o target/doc/$target --target $target src/lib.rs --cfg cross_platform_docs \
|
|
--crate-name libc
|
|
|
|
echo "<li><a href="/libc/$target/libc/index.html">$target</a></li>" \
|
|
>> target/doc/index.html
|
|
done
|
|
|
|
cat ci/landing-page-footer.html >> target/doc/index.html
|
|
|
|
# If we're on travis, not a PR, and on the right branch, publish!
|
|
if [ "$TRAVIS_PULL_REQUEST" = "false" ] && [ "$TRAVIS_BRANCH" = "master" ]; then
|
|
pip install ghp_import --install-option="--prefix=$HOME/.local"
|
|
$HOME/.local/bin/ghp-import -n target/doc
|
|
git push -qf https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
|
|
fi
|