Warn that the ZFS Test Suite destroys pools, and stop suggesting -x - #647
Merged
Conversation
The page hands the reader ./scripts/zfs-tests.sh -vx with nothing said about what -x does. Upstream's tests/README.md is blunt about it: it "will attempt to remove any leftover configuration from a previous test run", and "this operation can be DANGEROUS because it is possible that the script will mistakenly remove a resource not related to the testing". A reporter took our line at face value and lost a pool that had no mounted datasets, which is exactly the case the cleanup cannot tell apart from its own leftovers. Drop the x from the suggested command and say what the option does where someone about to type it will read it. The larger problem is that nothing on the page frames these scripts as developer tools. Someone who has just built ZFS and wants to check the build reads "Running zloop.sh and zfs-tests.sh" as the way to do that, and the suite happily creates and destroys pools, loads and unloads the modules, and adds users and groups on the machine it finds itself on. Upstream asks for a dedicated machine or VM for that reason; say so at the top of the section, and point the "see below" in Install at it. Both notes use danger rather than warning: in sphinx_rtd_theme that is the red one, and losing a pool earns the red one. Closes: #646 Signed-off-by: George Melikov <mail@gmelikov.ru>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The page hands the reader ./scripts/zfs-tests.sh -vx with nothing said about what -x does. Upstream's tests/README.md is blunt about it: it "will attempt to remove any leftover configuration from a previous test run", and "this operation can be DANGEROUS because it is possible that the script will mistakenly remove a resource not related to the testing". A reporter took our line at face value and lost a pool that had no mounted datasets, which is exactly the case the cleanup cannot tell apart from its own leftovers.
Drop the x from the suggested command and say what the option does where someone about to type it will read it.
The larger problem is that nothing on the page frames these scripts as developer tools. Someone who has just built ZFS and wants to check the build reads "Running zloop.sh and zfs-tests.sh" as the way to do that, and the suite happily creates and destroys pools, loads and unloads the modules, and adds users and groups on the machine it finds itself on. Upstream asks for a dedicated machine or VM for that reason; say so at the top of the section, and point the "see below" in Install at it.
Both notes use danger rather than warning: in sphinx_rtd_theme that is the red one, and losing a pool earns the red one.
Closes: #646