MSBuild: fix overwritten comment improvements by ghogen · Pull Request #7484 · dotnet/dotnet-api-docs

ghogen · 2021-12-11T00:24:22Z

Summary

Describe your changes here.

Fixes #Issue_Number (if available)

opbld31 · 2021-12-11T00:26:57Z

Docs Build status updates of commit 7ef8257:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/Microsoft.Build.Framework/SdkResolver.xml	❌Error	Details
xml/Microsoft.Build.Logging/BuildEventArgsReader.xml	❌Error	Details
xml/Microsoft.Build.Tasks/Hash.xml	❌Error	Details
	❌Error	Details
xml/Microsoft.Build.Utilities/TargetDotNetFrameworkVersion.xml	💡Suggestion	Details

xml/Microsoft.Build.Framework/SdkResolver.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'remarks' start tag on line 119 position 10 does not match the end tag of 'Docs'. Line 125, position 9.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/Microsoft.Build.Logging/BuildEventArgsReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'summary' start tag on line 21 position 6 does not match the end tag of 'Docs'. Line 23, position 5.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/Microsoft.Build.Tasks/Hash.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'Docs' start tag on line 16 position 4 does not match the end tag of 'remarks'. Line 20, position 15.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 3 files, aborting...

xml/Microsoft.Build.Utilities/TargetDotNetFrameworkVersion.xml

Line 0, Column 0: [Suggestion: ECMA2Yaml_Enum_NoRemarks] Please note: <remarks> node on Enum fields will be ignored.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

opbld34 · 2021-12-11T01:10:17Z

Docs Build status updates of commit 7ef8257:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Details
xml/Microsoft.Build.Framework/SdkResolver.xml	❌Error	Details
xml/Microsoft.Build.Logging/BuildEventArgsReader.xml	❌Error	Details
xml/Microsoft.Build.Tasks/Hash.xml	❌Error	Details
	❌Error	Details

xml/Microsoft.Build.Framework/SdkResolver.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'remarks' start tag on line 119 position 10 does not match the end tag of 'Docs'. Line 125, position 9.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/Microsoft.Build.Logging/BuildEventArgsReader.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'summary' start tag on line 21 position 6 does not match the end tag of 'Docs'. Line 23, position 5.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

xml/Microsoft.Build.Tasks/Hash.xml

Line 0, Column 0: [Error: ECMA2Yaml_InternalError]

Intenal Several Error: System.Xml.XmlException: The 'Docs' start tag on line 16 position 4 does not match the end tag of 'remarks'. Line 20, position 15.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 3 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

gewarren

These suggestions should fix the build errors too.

xml/Microsoft.Build.Framework/SdkResolver.xml

xml/Microsoft.Build.Framework/SdkResult.xml

xml/Microsoft.Build.Logging/BinaryLogger.xml

xml/Microsoft.Build.Tasks/DownloadFile.xml

xml/Microsoft.Build.Tasks/Unzip.xml

xml/Microsoft.Build.Framework/SdkResolver.xml

xml/Microsoft.Build.Logging/BuildEventArgsReader.xml

xml/Microsoft.Build.Tasks/Hash.xml

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

opbld33 · 2021-12-11T01:57:04Z

Docs Build status updates of commit 8bdfd1a:

✅ Validation status: passed

File	Status	Preview URL
xml/Microsoft.Build.Evaluation/ProjectCollection.xml	✅Succeeded	View
xml/Microsoft.Build.Framework/SdkReference.xml	✅Succeeded	View
xml/Microsoft.Build.Framework/SdkResolver.xml	✅Succeeded	View
xml/Microsoft.Build.Framework/SdkResolverContext.xml	✅Succeeded	View
xml/Microsoft.Build.Framework/SdkResult.xml	✅Succeeded	View
xml/Microsoft.Build.Logging/BinaryLogger.xml	✅Succeeded	View
xml/Microsoft.Build.Logging/BuildEventArgsReader.xml	✅Succeeded	View
xml/Microsoft.Build.Logging/ProfilerLogger.xml	✅Succeeded	View
xml/Microsoft.Build.Tasks/CodeTaskFactory.xml	✅Succeeded	View
xml/Microsoft.Build.Tasks/Copy.xml	✅Succeeded	View
xml/Microsoft.Build.Tasks/DownloadFile.xml	✅Succeeded	View
xml/Microsoft.Build.Tasks/Hash.xml	✅Succeeded	View
xml/Microsoft.Build.Tasks/Unzip.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Try searching the docs.microsoft.com contributor guides
Post your question in the Docs support channel

Fixes #7151 Context Doc comments are changed from time to time in the dotnet-api-docs repo. These changes need to be ported back to the MSBuild source, now that the MSBuild source is being used as the source-of-truth for MSBuild reference docs. Changes Made Comment-only changes in a number of source files. Testing Notes The changes that were required can also be found here: dotnet/dotnet-api-docs#7484 - this docs PR was necessary to prevent the dotnet-api-docs changes from being overwritten when the comments were re-read from MSBuild sources for the 17.0 version of MSBuild.

Restore overwritten comment changes

7ef8257

ghogen requested a review from a team as a code owner December 11, 2021 00:24

ghost added the area-Infrastructure label Dec 11, 2021

ghogen mentioned this pull request Dec 11, 2021

CI Update to Add MSBuild 17 #7469

Merged

ghogen changed the base branch from main to smoke-test-msbuild December 11, 2021 00:41

ghogen closed this Dec 11, 2021

ghogen reopened this Dec 11, 2021

gewarren reviewed Dec 11, 2021

View reviewed changes

Apply suggestions from code review

8bdfd1a

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

gewarren approved these changes Dec 11, 2021

View reviewed changes

gewarren merged commit 532ae45 into dotnet:smoke-test-msbuild Dec 11, 2021

This was referenced Dec 14, 2021

Update doc comments from dotnet-api-docs dotnet/msbuild#7151

Closed

Port doc comment changes from docs repo dotnet/msbuild#7152

Merged

ghogen changed the title ~~MSbuild: fix overwritten comment improvements~~ MSBuild: fix overwritten comment improvements Dec 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSBuild: fix overwritten comment improvements#7484

MSBuild: fix overwritten comment improvements#7484
gewarren merged 2 commits intodotnet:smoke-test-msbuildfrom
ghogen:msbuild-working

ghogen commented Dec 11, 2021

Uh oh!

opbld31 commented Dec 11, 2021

Uh oh!

opbld34 commented Dec 11, 2021

Uh oh!

gewarren left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

opbld33 commented Dec 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

ghogen commented Dec 11, 2021

Summary

Uh oh!

opbld31 commented Dec 11, 2021

❌ Validation status: errors

xml/Microsoft.Build.Framework/SdkResolver.xml

xml/Microsoft.Build.Logging/BuildEventArgsReader.xml

xml/Microsoft.Build.Tasks/Hash.xml

xml/Microsoft.Build.Utilities/TargetDotNetFrameworkVersion.xml

Uh oh!

opbld34 commented Dec 11, 2021

❌ Validation status: errors

xml/Microsoft.Build.Framework/SdkResolver.xml

xml/Microsoft.Build.Logging/BuildEventArgsReader.xml

xml/Microsoft.Build.Tasks/Hash.xml

Uh oh!

gewarren left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

opbld33 commented Dec 11, 2021

✅ Validation status: passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants