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.

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

Add dataflow block name and some API docs #8617

Merged
merged 2 commits into from
Oct 19, 2022

Conversation

drewnoakes
Copy link
Member

@drewnoakes drewnoakes commented Oct 18, 2022

Split out of #8550 to simplify review.

Microsoft Reviewers: Open in CodeFlow

@drewnoakes drewnoakes added the Feature-Language-Service Populating the Roslyn workspace with references, source files, analyzers, etc label Oct 18, 2022
@drewnoakes drewnoakes added this to the 17.5 milestone Oct 18, 2022
@drewnoakes drewnoakes requested a review from a team as a code owner October 18, 2022 03:38
@@ -132,7 +132,8 @@ protected override async Task InitializeCoreAsync(CancellationToken cancellation
target: DataflowBlockFactory.CreateActionBlock<IProjectVersionedValue<(ConfiguredProject ActiveConfiguredProject, ConfigurationSubscriptionSources Sources)>>(
async update => await ExecuteUnderLockAsync(cancellationToken => OnSlicesChanged(update, cancellationToken)),
_unconfiguredProject,
ProjectFaultSeverity.LimitedFunctionality),
ProjectFaultSeverity.LimitedFunctionality,
"LanguageServiceHostSlices {0}"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What fills in the place holder here, and what value will it have?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've only ever seen it used in WinDBG, to help identify the purpose behind each dataflow block in the graph. I'm not sure what value goes in the placeholder actually, or why it's needed, but all nameFormat values have that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Digging into this, the nameFormat is used on the dataflow block's ToString method, and is passed two placeholder values:

  • {0} — the block's type name
  • {1} — the hash code of the block

@drewnoakes drewnoakes merged commit 9b99b42 into dotnet:main Oct 19, 2022
@drewnoakes drewnoakes deleted the lang-svc-small-bits branch October 19, 2022 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature-Language-Service Populating the Roslyn workspace with references, source files, analyzers, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants