diff --git a/.github/workflows/rst-lint.yml b/.github/workflows/rst-lint.yml new file mode 100644 index 000000000..d4944b718 --- /dev/null +++ b/.github/workflows/rst-lint.yml @@ -0,0 +1,23 @@ +name: Check RST files using restructuredtext-lint + +on: + pull_request: + branches: + - master + +jobs: + build: + name: rst-lint + runs-on: ubuntu-latest + steps: + - name: Checkout libblockdev repository + uses: actions/checkout@v6 + + - name: Install restructuredtext-lint + run: | + sudo apt -qq update + sudo apt -y -qq install python3-restructuredtext-lint + + - name: Run restructuredtext-lint + run: | + rst-lint *.rst tests/*.rst diff --git a/NEWS.rst b/NEWS.rst index 31cba383c..2c35e5b9e 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -15,14 +15,17 @@ for details. **Full list of changes** Michael Biebl (1): + - Mark _get_linux_version() as static Tomas Bzatek (3): + - nvme: Add bd_nvme_find_namespaces_for_ctrl() - nvme: Clarify argument doc strings for bd_nvme_find_ctrls_for_ns() - tests: Add tests for bd_nvme_find_namespaces_for_ctrl() Vojtech Trefny (188): + - misc: Remove custom Vagrantfile - misc: Add some missing dependencies for pgi-docgen - fs: Log mount and unmount calls @@ -71,8 +74,7 @@ Vojtech Trefny (188): - dm: Fix memory leak in bd_dm_map_exists - crypto: Fix memory leak in bd_crypto_luks_info - utils: Check if resolved path in bd_utils_resolve_device is device -- dm: Fail fast when no name/node specified for - dm_node_from_name/dm_name_from_node +- dm: Fail fast when no name/node specified for dm_node_from_name/dm_name_from_node - lvm-dbus: bd_lvm_vdo_pool_convert implementation - part: Check partition parsed partition type before setting it - part: Check whether partition exists before setting GPT attributes @@ -83,7 +85,7 @@ Vojtech Trefny (188): - s390: Fix fgetc comparison to use character '1' instead of integer 1 - lvm: Fix next_arg index in bd_lvm_vdo_pool_convert - utils: Fix NULL dereference in bd_utils_dbus_service_available -- fs: Fix g_free(label) to g_free(*label) in get_uuid_label +- fs: Fix g_free(label) to g_free(\*label) in get_uuid_label - core: Fix bd_ensure_init to check all plugins, not just the last - core: Restore stub on dlsym failure in generated plugin loaders - fs: Remove mnt_free_fs calls on table-owned fs pointers @@ -214,6 +216,7 @@ Vojtech Trefny (188): - Fix gtk-doc warnings for docstrings and sections file dependabot[bot] (5): + - infra: bump github/codeql-action from 3 to 4 - infra: bump actions/upload-artifact from 4 to 5 - infra: bump actions/checkout from 5 to 6 @@ -228,8 +231,7 @@ for details. **Notable changes** -- bd_nvme_connect() now defaults to port 4420 or 8009 for discovery NQN respectively when -the transport_svcid argument is not specified. +- bd_nvme_connect() now defaults to port 4420 or 8009 for discovery NQN respectively when the transport_svcid argument is not specified. **Full list of changes** diff --git a/README.DEVEL.md b/README.DEVEL.md index d6a011472..9df4541e0 100644 --- a/README.DEVEL.md +++ b/README.DEVEL.md @@ -141,7 +141,7 @@ Making releases it to *docs/html* - [ ] Update the documentation by copying the contents of the *docs/html* - folder to the *libblockdev* directory in the + folder to the *libblockdev/docs* directory in the [Storaged project website repository](https://github.com/storaged-project/storaged-project.github.io) and commit and push the changes diff --git a/tests/README.rst b/tests/README.rst index 07329f97d..7acb3e5ef 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -1,2 +1,2 @@ -See the chapter `Testing libblockdev' in the docs/ directory or on-line at +See the chapter `Testing libblockdev` in the docs/ directory or on-line at http://storaged.org/libblockdev/