Issue a warning if .data files remain #3321
Merged
Conversation
This file contains 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
This will help users realize that they have updated to an incompatible version and must export and import their tasks.
ryneeverett
suggested changes
Mar 31, 2024
src/TDB2.cpp
Outdated
| format ("Found existing '.data' files in {1}", location)) << "\n"; | ||
| std::cout << " Taskwarrior's storage format changed in 3.0.\n"; | ||
| std::cout << " See https://github.com/GothenburgBitFactory/taskwarrior/releases.\n"; | ||
| std::cout << " Remove the files to silence this warning.\n\n"; |
There was a problem hiding this comment.
Suggested change
| std::cout << " Remove the files to silence this warning.\n\n"; |
I wouldn't make this suggestion in a warning message because a user might delete these files without exporting first. Really they should probably move them elsewhere for a temporary backup but IMO just pointing them towards longer form documentation is all a warning message should aspire to do.
There was a problem hiding this comment.
Thanks, good advice!
src/TDB2.cpp
Outdated
| Color warning = Color (Context::getContext ().config.get ("color.warning")); | ||
| std::cout << warning.colorize ( | ||
| format ("Found existing '.data' files in {1}", location)) << "\n"; | ||
| std::cout << " Taskwarrior's storage format changed in 3.0.\n"; |
There was a problem hiding this comment.
I'm not in love with this wording but I feel like some kind of "call to action" other than (implicitly) "delete your .data files" would be good.
Suggested change
| std::cout << " Taskwarrior's storage format changed in 3.0.\n"; | |
| std::cout << " Taskwarrior's storage format changed in 3.0, requiring a manual migration.\n"; |
ryneeverett
approved these changes
Mar 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This will help users realize that they have updated to an incompatible version and must export and import their tasks.