Skip to content

Commit ec03db7

Browse files
authored
Merge pull request #226 from linux-nvme/kernel-doc-ci
build: Add kernel-doc CI build
2 parents ee30b68 + a12eb34 commit ec03db7

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

.github/workflows/doc.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: libnvme documenation CI
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
kernel_doc_job:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out repository code
14+
uses: actions/checkout@v2
15+
- name: Check documentation format
16+
run: |
17+
API_FILES="fabrics.h filters.h ioctl.h linux.h tree.h types.h"
18+
for file in $API_FILES; do
19+
./doc/kernel-doc -v -none src/nvme/$file 2>&1 | sed -r 's/^([^:]+):([0-9]+): (warning|error):/::\3 file=\1,line=\2::/g'
20+
done
21+
shell: bash

0 commit comments

Comments
 (0)