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: add arc_lock feature and typedefs #25

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

mkroening
Copy link
Member

This PR has two commits:

  1. Adding the arc_lock feature and corresponding typedefs.
  2. Configuring docs.rs to
    • document all features
    • use doc_auto_cfg to annotate required features on types
    • enable --generate-link-to-definition for rustdoc sources

You can test this with the following command:

RUSTDOCFLAGS="-Zunstable-options --cfg=docsrs --generate-link-to-definition" cargo +nightly doc --open --all-features

Closes #24

Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>
- document all features
- use `doc_auto_cfg` to annotate with features
- enable `--generate-link-to-definition`

Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de>
@mkroening mkroening changed the title Arc lock feat: add arc_lock feature and typedefs Oct 18, 2023
Copy link
Member

@phil-opp phil-opp left a comment

Choose a reason for hiding this comment

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

Thanks!

I didn't know about generate-link-to-definition before, looks cool!

@phil-opp phil-opp merged commit d7bcef0 into rust-osdev:master Oct 18, 2023
@mkroening mkroening deleted the arc_lock branch October 18, 2023 11:07
@mkroening
Copy link
Member Author

Thanks a lot!

I don't have any more wishes currently, so as far as I am concerned, we are ready for a release. :)

@phil-opp
Copy link
Member

Ok great! I opened #26.

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.

Add arc_lock feature
2 participants