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

build(docs.rs): cover more Mac targets #276

Merged
merged 1 commit into from
May 23, 2024

Conversation

ErichDonGubler
Copy link
Member

@ErichDonGubler ErichDonGubler commented Jul 14, 2023

Expands the set of Mac targets to cover more Mac toolchains. 😀

Original OP text from draft

We've specified a default-target for docs.rs metadata in Cargo.toml, but the way to exclude other platforms is via the targets field, according to these docs on it:

# If `default-target` is unset, the first element of `targets` is treated as the default target.
# Otherwise, these `targets` are built in addition to the default target.
# If both `default-target` and `targets` are unset,
#   all tier-one targets will be built and `x86_64-unknown-linux-gnu` will be used as the default target.

Should fix #5. EDIT: Maybe not?

@ErichDonGubler ErichDonGubler force-pushed the fix-docs.rs branch 2 times, most recently from 3787428 to 09a9df7 Compare July 14, 2023 18:29
@ErichDonGubler

This comment was marked as resolved.

@MarijnS95
Copy link
Contributor

MarijnS95 commented Oct 31, 2023

Barring the cross-compilation issue, should iOS also be targeted for docs?

I'm unsure if there's anything cfg'd for that target, but might be useful to include it nonetheless.

EDIT: And if such a PR makes the documentation available elsewhere, the "docs are broken" module comment should be replaced with a link :)

Cargo.toml Outdated Show resolved Hide resolved
@MarijnS95
Copy link
Contributor

@ErichDonGubler can you pursue this again? #5 was fixed and closed via #303, and running cargo doc --open --no-deps --target x86_64-apple-darwin locally shows that the docs now build successfully! Don't forget about my and @xorza's query to extend the list of targets first.

@MarijnS95
Copy link
Contributor

After all #303 was contained in the recent 0.28.0 release, and the default x86_64-apple-darwin target had a successful build already as seen at https://docs.rs/metal/0.28.0/metal/index.html!

@ErichDonGubler ErichDonGubler changed the title build(docs.rs): only build MacOS build(docs.rs): cover more Mac targets May 16, 2024
@ErichDonGubler
Copy link
Member Author

@xorza: I've adjusted PR title, summary, and the sole commit to note that this only covers more targets, since that seems like the only useful scope left in this contribution. 🙂

@ErichDonGubler ErichDonGubler marked this pull request as ready for review May 16, 2024 22:22
@ErichDonGubler
Copy link
Member Author

@xorza: I've rebased, taken your review suggestion, adjusted PR title, summary, and the sole commit to note that this only covers more targets, since that seems like the only useful scope left in this contribution. 🙂

@ErichDonGubler
Copy link
Member Author

ErichDonGubler commented May 16, 2024

Nightly CI appears to be complaining about an "unused" feature dispatch_queue, which got renamed waaay back in fb17c9e. Eek! That means the dispatch module has been disabled for…a long time, while a different route to dispatch module import in the sync module has been taken instead (maybe a private use from lib.rs?) and kept from breaking compilation.

Copy link
Contributor

@MarijnS95 MarijnS95 left a comment

Choose a reason for hiding this comment

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

Looks good to have all Tier 1/2 Apple platforms listed, and instead of setting a "useless" default-target, no longer rely on the default targets = ["...windows..", "...linux...", ...] array on which docs.rs will fail anyway: https://docs.rs/crate/metal/0.28.0/builds/1204445/x86_64-unknown-linux-gnu.txt

Copy link
Collaborator

@grovesNL grovesNL left a comment

Choose a reason for hiding this comment

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

Thank you!

@grovesNL grovesNL merged commit 0d6214f into gfx-rs:master May 23, 2024
1 of 2 checks passed
@ErichDonGubler ErichDonGubler deleted the fix-docs.rs branch May 23, 2024 18:16
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.

Host documentation
4 participants