[SymbolGraphGen] silence symbolgraph-extract output without -v flag #36785
Conversation
rdar://72630103
|
@swift-ci Please smoke test |
|
@swift-ci Please build toolchain macOS platform |
|
|
||
| /// Whether to silence the "Found N symbols" messages when rendering | ||
| /// a symbol graph. | ||
| bool QuietMessages; |
There was a problem hiding this comment.
Is "quiet" common terminology? Maybe SilenceMessage would fit better here (see https://github.com/apple/swift/blob/a5a79f23c0257c36c297d3c1b9275a873434468a/lib/Sema/TypeCheckType.h#L57)
There was a problem hiding this comment.
When i started writing this, i assumed i would use a --quiet flag, which i've seen on other tools to reduce/eliminate the messages they display. Since the meaning was ultimately inverted (no output without -v flag), this might work better as PrintMessages instead. What do you think?
There was a problem hiding this comment.
PrintMessages sounds good as well!
| llvm::errs() << ModuleDecls.size() | ||
| << " top-level declarations in this module.\n"; | ||
| if (!Options.QuietMessages) | ||
| llvm::errs() << ModuleDecls.size() |
There was a problem hiding this comment.
Another way to implement this would be to create a stream that forwards its input to llvm:errs() only if QuietMessages is true. That way we don't have to guard the messages around if checks. I don't really mind either way though.
There was a problem hiding this comment.
Unless there's some "optional stream wrapper" type that exists somewhere, this implementation feels like the "smallest diff" way to implement this. Otherwise, i'd have to implement the wrapper myself.
| @@ -35,6 +35,10 @@ struct SymbolGraphOptions { | |||
| /// Emit members gotten through class inheritance or protocol default | |||
| /// implementations with compound, "SYNTHESIZED" USRs. | |||
| bool EmitSynthesizedMembers; | |||
|
|
|||
| /// Whether to silence the "Found N symbols" messages when rendering | |||
There was a problem hiding this comment.
It's more than the "Found N symbols" messages though right?
There was a problem hiding this comment.
There are three lines that are affected by this change:
Emitting symbol graph file for module: <filename>.swiftmodule
X top-level declarations in this file.
Found Y symbols and Z relationships.
emitSymbolGraphForModule only emits the latter two (the first is printed directly by swift-symbolgraph-extract), so centering the docs around the "Found N symbols" seemed like the most direct way to describe it. I could mention the "X top-level symbols" line as well if that seems better.
There was a problem hiding this comment.
That's true today but might not be in the future. I'm nitpicking though, this isn't blocking :)
|
Pushed up a commit to invert the meaning of the field. I tweaked the doc comment while i was at it, too. 😉 @swift-ci Please smoke test |
|
@swift-ci Please build toolchain macOS platform |
|
macOS Toolchain Install command |
Resolves rdar://72630103
This PR changes how SymbolGraphGen emits its output. By default, the SymbolGraphGen code will not output anything other than errors without a
-vflag given toswift-symbolgraph-extract. This also means that the symbol-graph code called from the driver or from SourceKit will now also be silenced.