Skip to content

Minor improvement to linker descriptor documentation#127015

Open
mrvoorhe wants to merge 1 commit into
dotnet:mainfrom
Unity-Technologies:linker-docs-improvement
Open

Minor improvement to linker descriptor documentation#127015
mrvoorhe wants to merge 1 commit into
dotnet:mainfrom
Unity-Technologies:linker-docs-improvement

Conversation

@mrvoorhe

Copy link
Copy Markdown
Contributor

The Assembly. part in lines such as

    <type fullname="Assembly.B" />

Could be confusing. While it is convention to have the assembly name and namespace match, it's not a requirement.

The `Assembly.` part in lines such as
```
    <type fullname="Assembly.B" />
```
Could be confusing.  While it is convention to have the assembly name and namespace match, it's not a requirement.
Copilot AI review requested due to automatic review settings April 16, 2026 16:46
@mrvoorhe

Copy link
Copy Markdown
Contributor Author

@sbomer Please take a look

@github-actions github-actions Bot added the area-Tools-ILLink .NET linker development as well as trimming analyzers label Apr 16, 2026
@dotnet-policy-service dotnet-policy-service Bot added linkable-framework Issues associated with delivering a linker friendly framework community-contribution Indicates that the PR has been added by a community member labels Apr 16, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @agocke, @dotnet/illink
See info in area-owners.md if you want to be subscribed.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the ILLink linker descriptor documentation examples to avoid implying that a type’s namespace must match the assembly name, reducing confusion for users writing descriptor XML.

Changes:

  • Replaced Assembly.* type fullname examples with Namespace.* to better reflect that type names are namespace-qualified, not assembly-qualified.
  • Adjusted multiple XML snippets throughout the doc to consistently use the new placeholder namespace.

Comment on lines 109 to 113
<!-- Preserves all types who's fully qualified type name matches the regular expression -->
<type fullname="Assembly.Namespace*" />
<type fullname="Namespace.Namespace*" />

<!-- Preserve all types within the specified namespace -->
<namespace fullname="Assembly.Namespace" />

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

In this example, the comment says the type name matches a “regular expression”, but the sample uses the * wildcard pattern (as in the earlier prefix examples). Also, <type fullname="Namespace.Namespace*" /> and <namespace fullname="Assembly.Namespace" /> use different prefixes, which undermines the doc’s goal of showing assembly name and namespace aren’t inherently related. Consider updating the wording to describe wildcard matching and aligning the sample namespace/type values.

Copilot uses AI. Check for mistakes.
@@ -107,7 +107,7 @@ The `required` attribute specifies that if the type is not marked, during the ma
<assembly fullname="Assembly">

<!-- Preserves all types who's fully qualified type name matches the regular expression -->

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

Typo in the comment: “who's” should be “whose”.

Suggested change
<!-- Preserves all types who's fully qualified type name matches the regular expression -->
<!-- Preserves all types whose fully qualified type name matches the regular expression -->

Copilot uses AI. Check for mistakes.

<!-- No "preserve" attribute and no members specified means preserve all members -->
<type fullname="Assembly.B" />
<type fullname="Namespace.B" />

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

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

This line (and a few others in the XML snippets) has trailing whitespace at end-of-line. In Markdown this can create unintended hard line breaks and also tends to fail whitespace hygiene checks; please trim trailing spaces in the examples.

Copilot uses AI. Check for mistakes.
@mrvoorhe

Copy link
Copy Markdown
Contributor Author

@sbomer Can you merge this?

@JulieLeeMSFT

Copy link
Copy Markdown
Member

@mrvoorhe, please address the copilot reviews.
cc @sbomer.

@JulieLeeMSFT JulieLeeMSFT added the needs-author-action An issue or pull request that requires more info or actions from the author. label Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-Tools-ILLink .NET linker development as well as trimming analyzers community-contribution Indicates that the PR has been added by a community member linkable-framework Issues associated with delivering a linker friendly framework needs-author-action An issue or pull request that requires more info or actions from the author.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants