Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use local directories when building for docs.rs #185

Merged
merged 1 commit into from
May 31, 2021

Conversation

XAMPPRocky
Copy link
Contributor

I haven't tested it, but this code should be enough to get afl to compile for docs.rs

See https://docs.rs/crate/afl/0.10.0/builds/351937 for the current errors. This will require a new release to test.

I haven't tested it, but this code should be enough to get `afl` to compile for docs.rs 

See https://docs.rs/crate/afl/0.10.0/builds/351937 for the current errors.
@frewsxcv frewsxcv merged commit 5f38961 into rust-fuzz:master May 31, 2021
@XAMPPRocky XAMPPRocky deleted the patch-1 branch May 31, 2021 11:55
@frewsxcv
Copy link
Member

https://docs.rs/crate/afl/0.10.1/builds/394574

Looks like it didn't work

@XAMPPRocky
Copy link
Contributor Author

XAMPPRocky commented May 31, 2021

Alright, I'll try and get docs.rs building on my machine, though it's odd that it's failing on the same line, I thought the cfg predicate for docs.rs builds was docsrs.

@AlexTMjugador
Copy link
Contributor

The docs.rs documentation states that any file writes should be made in the directory indicated by the OUT_DIR environment variable. Is there anybody working on fixing the documentation builds?

@XAMPPRocky
Copy link
Contributor Author

@AlexTMjugador I'm not FWIW as I'm currently a bit overloaded at the moment. If you'd like to take over go ahead 🙂

smoelius pushed a commit that referenced this pull request May 9, 2022
This change addresses the same problem as #185. It turns out that build
scripts are only meant to write to OUT_DIR, and in general it is untidy
to write things all over the place. docs.rs is specially sensitive to
this.

Also, docs.rs does not set the feature flag "docsrs" by itself, but a
Cargo package metadata section can be used to instruct docs.rs to pass
that flag to Cargo.
@smoelius
Copy link
Member

smoelius commented Sep 2, 2022

I think this is finally working: https://docs.rs/afl/0.12.8/afl/index.html

Thanks @XAMPPRocky and @AlexTMjugador for all of your research into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants