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

Fix docs build #858

Merged
merged 3 commits into from
Dec 20, 2023
Merged

Fix docs build #858

merged 3 commits into from
Dec 20, 2023

Conversation

dave-tucker
Copy link
Member

@dave-tucker dave-tucker commented Dec 19, 2023

Doctests aren't running in CI!
This PR:

  1. Adds doctests to CI
  2. Fixes ringbuf docs in aya
  3. Fixes XDP map docs in aya-bpf

Fixes #820

Copy link

netlify bot commented Dec 19, 2023

Deploy Preview for aya-rs-docs ready!

Name Link
🔨 Latest commit 19af249
🔍 Latest deploy log https://app.netlify.com/sites/aya-rs-docs/deploys/6581c54e67c3220008ed4419
😎 Deploy Preview https://deploy-preview-858--aya-rs-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mergify mergify bot added aya This is about aya (userspace) aya-bpf This is about aya-bpf (kernel) test A PR that improves test cases or CI labels Dec 19, 2023
Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
doctests are not running in CI and therefore the didn't catch the
ringbuf docs failures. This commit fixes the issues in the examples.

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
Copy link
Member

@ajwerner ajwerner left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for doing it!

@dave-tucker dave-tucker merged commit 13f21dc into aya-rs:main Dec 20, 2023
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aya This is about aya (userspace) aya-bpf This is about aya-bpf (kernel) test A PR that improves test cases or CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cargo test Fails on Documentation Test in aya/src/maps/ring_buf.rs
2 participants