Formally deprecate the old diagnostics.json digest file #1163
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
d-ronnqvist
commented
Feb 27, 2025
Comment on lines
+68
to
+72
| package protocol _DeprecatedConsumeProblemsAccess { | ||
| func _consume(problems: [Problem]) throws | ||
| } | ||
|
|
||
| package struct _Deprecated<Consumer: ConvertOutputConsumer>: _DeprecatedConsumeProblemsAccess { |
There was a problem hiding this comment.
Because ConvertOutputConsumer is a public protocol I had to get a bit creative to be able to still call its deprecated API without introducing deprecation warnings in the DocC code.
d-ronnqvist
commented
Feb 27, 2025
| @@ -21,7 +21,6 @@ class TestRenderNodeOutputConsumer: ConvertOutputConsumer { | |||
| } | |||
| } | |||
|
|
|||
| func consume(problems: [Problem]) throws { } | |||
There was a problem hiding this comment.
This tests that conforming types can omit implementing the deprecated method.
rdar://145729962
d-ronnqvist
force-pushed
the
deprecate-old-diagnostics-digest-file
branch
from
67ee22a to
15ac29e
Compare
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.
Bug/issue #, if applicable: rdar://145729962
Summary
This formally deprecates the old "diagnostics.json" digest file that DocC writes when passed the
--emit-digestflag.This file has superseded by the
--diagnostics-file, --diagnostics-output-path <diagnostics-file>file since March 2023 (by #494).With these changes, the deprecated "diagnostics.json" digest file will contain an additional warning that this file is deprecated and will be removed. However, if there are no warnings or errors, the file won't include this deprecation warning to avoid interfering with older systems who read this file as an indication that the build has warnings or not.
Dependencies
None.
Testing
Build any documentation that produces at least one warning and pass the
--emit-digestflag.Inspect the "diagnostics.json" file inside the documentation output. There should be a warning that this file is deprecated and will be removed.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessary