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

Update docs #9522

Merged
Merged

Conversation

tmeschter
Copy link
Contributor

@tmeschter tmeschter commented Aug 12, 2024

Updates docs to include more information on project system selectors.

Microsoft Reviewers: Open in CodeFlow

Updates docs to include more information on project system selectors.
@tmeschter tmeschter requested a review from a team as a code owner August 12, 2024 20:35
Replace IVsProjectSystemSelector (incorrect) with IVsProjectSelector (correct).
Copy link
Member

@drewnoakes drewnoakes left a comment

Choose a reason for hiding this comment

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

Might be helpful to add some information about XML solutions (.slnx files) as they don't explicitly list a project type GUID. The example here would just be:

<Solution>
  <Project Path="Library3\Library3.csproj" />
</Solution>

My assumption is that in such a case, the decision is based on file extension and delegation to IVSProjectSelector.

docs/opening-with-new-project-system.md Outdated Show resolved Hide resolved
EndProject
```

Here the "Library3.csproj" project should be opened with the project system designated by the "FAE04EC0-301F-11D3-BF4B-00C04F79EFBC" GUID.
Copy link
Member

Choose a reason for hiding this comment

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

Users reading this might be interested in other project type GUIDs too. We don't have an official doc that lists these that I know of, but this source file does a decent job of enumerating the ones that are most likely interesting to the reader:

https://github.com/dotnet/project-system/blob/1aa6689827ba43e8cd7b9d29a6d15b3eabf6842c/src/Microsoft.VisualStudio.ProjectSystem.Managed.VS/ProjectSystem/ProjectType.cs

docs/opening-with-new-project-system.md Outdated Show resolved Hide resolved
EndProject
```

Here the "Library3.csproj" project should be opened with the project system designated by the "FAE04EC0-301F-11D3-BF4B-00C04F79EFBC" GUID.
Copy link
Contributor

Choose a reason for hiding this comment

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

is the other GUID relevant? ADFEAAF5-225C-4E13-8B65-77057AAC44B8


## Problem

There may be situations where more than one project system is capable of loading project files with a particular extension, or where the choice of project system needs to be dynamically determined. In this case the solution file itself does not contain enough information for the correct project system to be determined.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: In this case, the solution file...

@tmeschter tmeschter merged commit 911e09a into dotnet:main Aug 15, 2024
5 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 17.12 milestone Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants