Make the rust_icu crates available on docs.rs about rust_icu HOT 6 CLOSED

Success! See here: https://docs.rs/rust_icu_sys/0.1.2/rust_icu_sys/

I have reasons to think that other crates will become viewable on docs.rs too.

from rust_icu.

Some advice given on rust-lang/docs.rs#655

from rust_icu.

Looks like I managed to make changes that will allow rust_icu to compile on docs.rs.
Instructions here: https://forge.rust-lang.org/docs-rs/add-dependencies.html

One potential issue, the compilation model requires a README.md file must be available, and not be a symlink.

Another, I'm seeing some flakiness in bindgen invocation, exemplified in errors like this, which sometimes happen:

2020/03/27 00:18:07 [INFO] rustwide::cmd: [stderr] /usr/include/x86_64-linux-gnu/gnu/stubs.h:7:11: fatal error: 'gnu/stubs-32.h' file not found

But, the upside, once the two changes land, we may be well positioned to have the docs compilation succeed.

from rust_icu.

2020/03/27 00:18:07 [INFO] rustwide::cmd: [stderr] /usr/include/x86_64-linux-gnu/gnu/stubs.h:7:11: fatal error: 'gnu/stubs-32.h' file not found

This looks like you're trying to cross-compile for x86-unknown-linux-gnu (docs.rs builds all tier 1 targets by default). You can either request crates-build-env to install gcc-multilib (or the clang equivalent) in the build environment, or you can request docs.rs to only build for one target by putting targets = ["x86_64-unknown-linux-gnu"] in your Cargo.toml. See https://blog.rust-lang.org/2020/03/15/docs-rs-opt-into-fewer-targets.html for more details on the second option.

from rust_icu.

from rust_icu.

Several crates have different documentation for different platforms, for example https://docs.rs/winapi/. In the past we've had multiple targets on by default, but we're considering making that opt-in in the future for exactly the reasons you've seen here: it sometimes doesn't work and in most cases the documentation is the same. However, we're keeping the targets on by default for now to avoid unnecessarily breaking builds.

from rust_icu.