diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 5d1af7a..ea48243 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -26,19 +26,7 @@ jobs: - name: Run test run: make -f Makefile check - ci-checks: - runs-on: ubuntu-latest - container: fedora:43 # CURRENT DEVELOPMENT ENVIRONMENT - steps: - - uses: actions/checkout@v6 - with: - persist-credentials: false - - name: Install dependencies - run: dnf install -y make yamllint - - name: Run test - run: make -f Makefile yamllint - - spelling-checks: + spelling-and-formatting-checks: runs-on: ubuntu-latest container: fedora:43 # CURRENT DEVELOPMENT ENVIRONMENT steps: @@ -47,6 +35,9 @@ jobs: dnf install -y clang make + xmllint + which + yamllint - uses: actions/checkout@v6 with: persist-credentials: false @@ -57,5 +48,9 @@ jobs: - uses: baptiste0928/cargo-install@v3 with: crate: typos-cli - - name: Run test + - name: Run spell check run: make -f Makefile check-typos + - name: Run format check + run: make -f Makefile fmt + - name: Run lint check + run: make -f Makefile yamllint diff --git a/Makefile b/Makefile index d6b11c0..373c49b 100644 --- a/Makefile +++ b/Makefile @@ -65,9 +65,13 @@ website-copy: test-website-repo test-commit-msg clean website-distrib (cd ./public; cp * -R ${WEBSITE_REPO}) (cd ${WEBSITE_REPO}; git add .; git commit -m "${COMMIT_MSG}") +fmt: + (cd ./docs/dbus ; $(MAKE) fmt) + .PHONY: check clean + fmt pdfs test-commit-msg test-website-repo diff --git a/docs/dbus/Makefile b/docs/dbus/Makefile index 7678606..8553aee 100644 --- a/docs/dbus/Makefile +++ b/docs/dbus/Makefile @@ -9,6 +9,13 @@ check-closed-insets: check: check-closed-insets +fmt: + xmllint --format ./blockdev.xml --output ./blockdev.xml + xmllint --format ./filesystem.xml --output ./filesystem.xml + xmllint --format ./manager.xml --output ./manager.xml + xmllint --format ./pool.xml --output ./pool.xml + .PHONY: check check-closed-insets + fmt diff --git a/docs/dbus/blockdev.xml b/docs/dbus/blockdev.xml index 5e56ec0..cce0293 100644 --- a/docs/dbus/blockdev.xml +++ b/docs/dbus/blockdev.xml @@ -1,28 +1,29 @@ + - + - - - + + + - - + + - - - + + + - - - + + + @@ -30,26 +31,26 @@ - + - - - + + + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/docs/dbus/filesystem.xml b/docs/dbus/filesystem.xml index 3501dd4..de5be86 100644 --- a/docs/dbus/filesystem.xml +++ b/docs/dbus/filesystem.xml @@ -1,28 +1,29 @@ + - + - - - + + + - - + + - - - + + + - - - + + + @@ -30,338 +31,338 @@ - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - + - + - + - + - + - + - + - + - + diff --git a/docs/dbus/manager.xml b/docs/dbus/manager.xml index 7640e3f..74a847f 100644 --- a/docs/dbus/manager.xml +++ b/docs/dbus/manager.xml @@ -2,31 +2,31 @@ - + - + - - - + + + - - + + - - - + + + - - - + + + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - + - + - - - + + + - + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - + - + - - - + + + - + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - - - + + + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - - - + + + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - + - - - + + + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - + - - - + + + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - + - - - + + + - + - + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - + - - - + + + - + - + - + - - - + + + - + - - - + + + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - - - + + + - - - + + + - - + + - + - + - - - + + + - + - + - + - + - - - + + + - + - + - + - - - + + + - + - - - + + + - + - + - + - - - + + + @@ -1472,11 +1472,11 @@ --> - + - - - + + + @@ -1486,11 +1486,11 @@ --> - + - - - + + + @@ -1500,11 +1500,11 @@ --> - + - - - + + + @@ -1514,11 +1514,11 @@ --> - + - - - + + + @@ -1528,11 +1528,11 @@ --> - + - - - + + + @@ -1542,11 +1542,11 @@ --> - + - - - + + + @@ -1556,11 +1556,11 @@ --> - + - - - + + + @@ -1570,14 +1570,14 @@ --> - + - - - + + + - - - + + + diff --git a/docs/dbus/pool.xml b/docs/dbus/pool.xml index 9a90c59..9cb2557 100644 --- a/docs/dbus/pool.xml +++ b/docs/dbus/pool.xml @@ -1,28 +1,29 @@ + - + - - - + + + - - + + - - - + + + - - - + + + @@ -30,46 +31,46 @@ - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -79,38 +80,38 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -278,38 +279,38 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -501,38 +502,38 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -724,46 +725,46 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - - - - + + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -955,46 +956,46 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - - - - + + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -1186,46 +1187,46 @@ s: Name bs: Optional size specification --> - + - - - + + + - + - - - + + + - - - - + + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -1418,46 +1419,46 @@ bs: Optional size specification bs: Optional size limit specification --> - + - - - + + + - + - - - + + + - - - - + + + + - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + @@ -1650,26 +1651,26 @@ bs: Optional size specification bs: Optional size limit specification --> - + - - - + + + - + - - - + + + @@ -1679,36 +1680,36 @@ b: True if the filesystem name is specified, otherwise false. s: Filesystem name. --> - + - + - - - + + + - - - - + + + + - + - - - + + + @@ -1716,11 +1717,11 @@ True if the metadata that would be written if it were written now, false if the metadata that is currently on disk. --> - + - - - + + + - - - + + + - + - - - + + + - + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - + + + - + - - - + + + - + - + - + - - - + + + - + - + - - - + + + @@ -1923,26 +1924,26 @@ bs: Optional size specification bs: Optional size limit specification --> - + - - - + + + - + - - - + + + @@ -1952,36 +1953,36 @@ b: True if the filesystem name is specified, otherwise false. s: Filesystem name. --> - + - + - - - + + + - - - - + + + + - + - - - + + + @@ -1989,11 +1990,11 @@ True if the metadata that would be written if it were written now, false if the metadata that is currently on disk. --> - + - - - + + + - + - - - + + + - + - + - - - + + + - + - - - + + + - + - + - - - + + + @@ -2064,11 +2065,11 @@ If no token slot specified, remove the binding from the first slot bound with this method. --> - + - - - + + + @@ -2077,20 +2078,20 @@ If no token slot specified, remove the binding from the first slot bound with this method. --> - + - - - + + + - + - + - + - + + + - + - + - + - + - + - + - + - + - + - + + + + +