Public bug reported: [ Impact ]
The apparmor.d man page contained incorrect information about the combination of mount options=(list) options in (list), so this documentation should be fixed, and a test included to ensure that the documented behavior matches the actual behavior. [ Test Plan ] Checking the contents of the man page: * Open the apparmor.d man page with `man apparmor.d` and scroll down to the example that starts with `mount options=(ro, atime) options in (nodev, user)` * Verify that the mount commands listed as matching the rule all include ro and atime * The regression test that checks that the behavior is as documented will run as part of the QRT test suite described below Verification that the documentation matches the current behavior can be done via the QRT test suite, which includes execution of the AppArmor test suite. * To prepare the QRT test suite (can be done on any machine): - `git clone https://git.launchpad.net/qa-regression-testing` - `./scripts/make-test-tarball ./scripts/test-apparmor.py` * To run the QRT test suite: - Copy the tarball onto the machine with the new AppArmor installed and extract it - `sudo ./install-packages test-apparmor.py` - `sudo ./test-apparmor.py -v` [ Where problems could occur ] The man page update is a documentation-only change. The risk exists that the new packaged man page could be malformed, but this is unlikely since the man page is generated by pod2man, and such issues can be caught during testing by attempting to open the man page after installation of the new version. The test suite update, which does not affect the final packaged build, will help ensure that the updated documentation matches the actual behavior. [ Other Info ] This bug was originally reported at https://gitlab.com/apparmor/apparmor/-/merge_requests/1674. ** Affects: apparmor (Ubuntu) Importance: Undecided Status: New -- You received this bug notification because you are a member of Ubuntu Touch seeded packages, which is subscribed to apparmor in Ubuntu. https://bugs.launchpad.net/bugs/2110630 Title: apparmor.d man page contains incorrect information about mount flag combinations Status in apparmor package in Ubuntu: New Bug description: [ Impact ] The apparmor.d man page contained incorrect information about the combination of mount options=(list) options in (list), so this documentation should be fixed, and a test included to ensure that the documented behavior matches the actual behavior. [ Test Plan ] Checking the contents of the man page: * Open the apparmor.d man page with `man apparmor.d` and scroll down to the example that starts with `mount options=(ro, atime) options in (nodev, user)` * Verify that the mount commands listed as matching the rule all include ro and atime * The regression test that checks that the behavior is as documented will run as part of the QRT test suite described below Verification that the documentation matches the current behavior can be done via the QRT test suite, which includes execution of the AppArmor test suite. * To prepare the QRT test suite (can be done on any machine): - `git clone https://git.launchpad.net/qa-regression-testing` - `./scripts/make-test-tarball ./scripts/test-apparmor.py` * To run the QRT test suite: - Copy the tarball onto the machine with the new AppArmor installed and extract it - `sudo ./install-packages test-apparmor.py` - `sudo ./test-apparmor.py -v` [ Where problems could occur ] The man page update is a documentation-only change. The risk exists that the new packaged man page could be malformed, but this is unlikely since the man page is generated by pod2man, and such issues can be caught during testing by attempting to open the man page after installation of the new version. The test suite update, which does not affect the final packaged build, will help ensure that the updated documentation matches the actual behavior. [ Other Info ] This bug was originally reported at https://gitlab.com/apparmor/apparmor/-/merge_requests/1674. To manage notifications about this bug go to: https://bugs.launchpad.net/ubuntu/+source/apparmor/+bug/2110630/+subscriptions -- Mailing list: https://launchpad.net/~touch-packages Post to : touch-packages@lists.launchpad.net Unsubscribe : https://launchpad.net/~touch-packages More help : https://help.launchpad.net/ListHelp
