Complete TODO: Add descriptive error messages to docset initialization failure #1661
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.
While authoring a new Zeal docset recently I configured the docset wrong and had to debug the issue, but the only error message Zeal would give me was:
I went through the code trying to find the root cause of this error and discovered a TODO in
src/libs/registry/docset.cpp
suggesting that the errors leading to that message should be reported in more detail. I decided to try fix this myself, which is what this pull request does, adding new error messages for missing directories or files and for a malformedInfo.plist
.