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

Add Rust docs #49

Merged
merged 9 commits into from
May 20, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Build Docs

on: [push, pull_request]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
name: Build
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Rust
uses: dtolnay/rust-toolchain@stable

- name: Configure cache
uses: Swatinem/rust-cache@v2

- name: Setup pages
id: pages
uses: actions/configure-pages@v4

- name: Build docs
run: |
cargo clean --doc
cargo doc --workspace --no-deps --lib
cargo doc -p crossbeam-epoch --no-deps
cargo doc -p crossbeam-pebr-epoch --no-deps

# GitHub cannot find the nested index file by default.
# We need to specify the target manually.
- name: Add redirect
run: echo '<meta http-equiv="refresh" content="0;url=smr_benchmark/index.html">' > target/doc/index.html

- name: Remove lock file
run: rm target/doc/.lock

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: target/doc

deploy:
name: Deploy
needs: build
runs-on: ubuntu-latest

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
36 changes: 21 additions & 15 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 19 additions & 6 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
[workspace]
members = [
"./smrs/hp-pp",
"./smrs/nbr",
"./smrs/cdrc",
"./smrs/hp-brcu",
"./smrs/vbr",
"./smrs/circ",
]

[package]
name = "smr-benchmark"
version = "0.1.0"
authors = ["authors"]
edition = "2021"
description = "SMR Benchmark: A Microbenchmark Suite for Concurrent Safe Memory Reclamation Schemes"
repository = "https://github.com/kaist-cp/smr-benchmark"
readme = "README.md"

[dependencies]
bitflags = "2.5"
Expand All @@ -13,12 +26,12 @@ csv = "1.3.0"
rand = "0.8"
typenum = "1.17"
num = "0.4.3"
hp_pp = { git = "https://github.com/kaist-cp/hp-plus" }
nbr-rs = { path = "./nbr-rs" }
cdrc-rs = { path = "./cdrc-rs" }
hp-brcu = { path = "./hp-brcu" }
vbr-rs = { path = "./vbr-rs" }
circ = { path = "./circ" }
hp_pp = { path = "./smrs/hp-pp" }
nbr = { path = "./smrs/nbr" }
cdrc = { path = "./smrs/cdrc" }
hp-brcu = { path = "./smrs/hp-brcu" }
vbr = { path = "./smrs/vbr" }
circ = { path = "./smrs/circ" }

[target.'cfg(target_os = "linux")'.dependencies]
tikv-jemallocator = "0.5"
Expand Down
Loading
Loading