Skip to content

Commit

Permalink
Test rustdoc generation in CI to catch warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
cbiffle committed May 4, 2024
1 parent 35c0498 commit 04ecade
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ jobs:
path: |
target/thumbv7m-none-eabi/debug/lilos-testsuite-lm3s6965
doc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: ./doc-all.sh

test_qemu:
needs: build
runs-on: ubuntu-latest
Expand Down
12 changes: 12 additions & 0 deletions doc-all.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env bash

set -euo pipefail

DIRS="os list handoff semaphore rwlock"

for d in $DIRS; do
echo "---- testing doc generation in $d"
pushd $d > /dev/null
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
popd > /dev/null
done

0 comments on commit 04ecade

Please sign in to comment.