Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation and error handling of -dryrun #8

Closed
pauldreik opened this issue Oct 15, 2018 · 2 comments
Closed

Improve documentation and error handling of -dryrun #8

pauldreik opened this issue Oct 15, 2018 · 2 comments
Labels
enhancement New feature or request

Comments

@pauldreik
Copy link
Owner

pauldreik commented Oct 15, 2018 •
edited
Loading

The dryrun option is possible to misunderstand, and the error message is bad. See Debian bug 754663 and Ubuntu bug 1782273.

It is perhaps difficult to get right from glancing over the documentation because it needs a boolean argument true or false afterwards. This is a bad design (sorry!) but must remain as is for backwards compatibility. Making the true|false optional, would lead to ambiguity if invoking like this awkward example shows:

cd $(dirname $(which true))
rdfind -dryrun true false

It would be good to improve the error output, such that the error message immediately suggest what should be done.
Perhaps the builtin documentation can be made a bit clearer.
@pauldreik pauldreik added the enhancement New feature or request label Oct 15, 2018
pauldreik pushed a commit that referenced this issue Oct 15, 2018
#8 add unit test for dryrun. improve the error message.
852650f
pauldreik pushed a commit that referenced this issue Oct 15, 2018
#8 add test case to demonstrate bad error message
559bcea
pauldreik pushed a commit that referenced this issue Oct 15, 2018
#8 improve error message on misuse of dryrun
46294c1
pauldreik pushed a commit that referenced this issue Oct 15, 2018
#8 improve error message on failed test
c4eeeb7
@pauldreik
Copy link
Owner Author

I do not see how to improve the documentation. Reading the Debian bug report again, I think the submitter had immediately understood what was wrong if the updated error message had been in place.
This bug is done for now.

pauldreik pushed a commit that referenced this issue Oct 15, 2018
#8 add to release notes
9b951ed
@pauldreik
Copy link
Owner Author

This is fixed in 1.4.0-alpha0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pauldreik