microsoft / winget-pkgs

The Microsoft community Windows Package Manager manifest repository
MIT License
8.53k stars 4.43k forks source link

[Docs] Unclear when defaultLocale PackageName/Publisher started affecting ARP entry correlation #174424

Open cvrebert opened 6 hours ago

cvrebert commented 6 hours ago

For the fields PackageName and Publisher in the Locale schema, since schema 1.0.0, there has consistently been a note like the following (modulo irrelevant phrasing tweaks regarding Windows 11 and/or the Settings app and/or prefixing "entry" with "ARP") regarding a semantic change in winget 1.0:

[!NOTE] With the 1.0 release of the Windows Package Manager, this name affects how packages from a source are mapped to Apps installed in Windows 10 and Windows 11 via Add / Remove Programs (ARP) and Windows Apps & Features respectively. The best practice is to ensure this matches the ARP entry for the package name when it has been installed.

In the docs for all subsequent schema versions that still exist, those notes continue to reference Windows Package Manager v1.0; presumably that's when that change to Locale semantics was made.

However, the same fields in the defaultLocale schema have near-identical notes, except the Windows Package Manager version isn't frozen in their case:

Schema Version Windows Package Manager Version
1.0.0 1.0
1.1.0 1.2
1.2.0 1.3
1.4.0 1.4
1.5.0 1.5
1.6.0 1.6
1.7.0 1.7

Ought these notes all refer to 1.0 instead, or was there actual intentionality behind any of the incrementations?

Trenly commented 3 hours ago

While it is true that the functionality has been the same since the 1.0 client, older versions of the client don't support all of the fields from newer versions of the schema. The notes were incremented to match the version of the client that the schema corresponds to so as to show that the behavior hadn't changed since the 1.0 version, and was still the same in each version of the client which supports that field.

I've raised a PR to update the ones that were missed

[Policy] Issue-Docs