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

feat(c-api) Do not build C headers if the env var DOCS_RS exists #2044

Merged
merged 2 commits into from
Jan 22, 2021

Conversation

Hywan
Copy link
Contributor

@Hywan Hywan commented Jan 22, 2021

Description

Fix #1954.

According to https://docs.rs/about/builds, the DOCS_RS environment variable is set when the documentation is built from docs.rs. In this case, we must not build the C headers because it generates such error (see #1954 to learn more):

Unable to copy the generated C bindings: Os { code: 30, kind: Other, message: "Read-only file system" }

Review

  • Add a short description of the the change to the CHANGELOG.md file

@Hywan Hywan added bug Something isn't working 📦 lib-c-api About wasmer-c-api 📚 documentation Do you like to read? labels Jan 22, 2021
@Hywan Hywan requested a review from MarkMcCaskey January 22, 2021 13:25
@Hywan Hywan requested a review from jubianchi as a code owner January 22, 2021 13:25
@Hywan Hywan self-assigned this Jan 22, 2021
Copy link
Contributor

@MarkMcCaskey MarkMcCaskey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an improvement but it's still broken when doing cargo publish; we'll have to either cargo publish --no-verify or DOCS_RS=1 cargo publish; currently it's the 1 crate not covered by publish.py: we have to publish it manually.

(An easy fix would be to extend publish.py to allow setting env vars)

@Hywan
Copy link
Contributor Author

Hywan commented Jan 22, 2021

Let's merge this PR for the moment, and let's add another to solve the cargo publish problem :-).

bors r+

@bors
Copy link
Contributor

bors bot commented Jan 22, 2021

@bors bors bot merged commit b7e1987 into wasmerio:master Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 📚 documentation Do you like to read? 📦 lib-c-api About wasmer-c-api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

wasmer-c-api's documentation is broken on docs.rs
2 participants