diff --git a/.github/workflows/qc.yaml b/.github/workflows/qc.yaml index 3e623f7..32269e9 100644 --- a/.github/workflows/qc.yaml +++ b/.github/workflows/qc.yaml @@ -53,6 +53,18 @@ jobs: # by `cargo test`) to be _big enough_. Setting it to 8 MiB - run: RUST_MIN_STACK=8388608 cargo bench --workspace --exclude rosenpass-fuzzing + mandoc: + name: mandoc + runs-on: ubuntu-latest + steps: + - name: Install mandoc + run: sudo apt-get install -y mandoc + - uses: actions/checkout@v3 + - name: Check rosenpass.1 + run: doc/check.sh doc/rosenpass.1 + - name: Check rp.1 + run: doc/check.sh doc/rp.1 + cargo-audit: runs-on: ubuntu-latest steps: diff --git a/doc/check.sh b/doc/check.sh new file mode 100755 index 0000000..57ba57f --- /dev/null +++ b/doc/check.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env bash + +# We have to filter this STYLE error out, because it is very platform specific +OUTPUT=$(mandoc -Tlint "$1" | grep --invert-match "STYLE: referenced manual not found") + +if [ -z "$OUTPUT" ] +then + exit 0 +else + echo "$1 is malformatted, check mandoc -Tlint $1" + echo "$OUTPUT" + exit 1 +fi