[Lvfs-announce] New feature to disambiguate firmware with the same name

Richard Hughes <[email protected]> Fri, 27 Sep 2019 10:38:54 +0100
Newsgroups dev.linux.lists.lvfs-announce
Message-ID <CAD2FfiFdBmFD9vVfzJset24AH+V_qeya-irmDkpFzeccjepFQQ@mail.gmail.com>
Hi all,

Today I've deployed a new version of the LVFS that includes support
for the <name_variant_suffix> metainfo tag.

This optional tag isn't useful for most vendors or most devices, and
is only useful in the case where there are multiple variants of a
device with a different <id> and the same <name>.

This is most typical when there are two different SKUs for one device,
for instance one for the China market, and one for the US market but
where they have the same marketing name. In this case the name variant
suffix can be used to tell the firmware apart. The suffix is appended
to the name in brackets, so for instance Logitech could use it for the
RQR24 and RQR12 variants of the Unifying Receiver so that there are
not two "identical" names in the device list:
https://www.fwupd.org/lvfs/devicelist

Some notes about the <name_variant_suffix> tag:

* Only use this optional tag if the <name> would be duplicated, e.g.
if there are two variants of the same hardware. In 99.9% of cases you
do *not* need to use this tag.

* If you have to use this tag, use a short string, as it will be
appended to the visible name with brackets *if required* to
disambiguate a list

* Don't duplicate any part of the name in the suffix as this will just look odd

* You can add the name variant suffix on existing firmware (even in
stable) on the WebUI with the appropriate permissions. You do not have
to release new firmware or re-upload existing firmware with a new
metainfo.xml file. If you add a variant suffix using the LVFS it will
take the usual 4 hours to regenerate and be visible in the stable
metadata. If you're experimenting with this new feature, please use a
firmware in embargo.

I think there are two vendors interested in this, and everyone else
can just ignore this email. If anyone does have questions about the
use of this new tag, please ask me off-list for advice. Thanks.

Richard.