dotnet / dotnet/sdk

apicompat --package-assembly-references is difficult to use

Open
#41,686 1 comment 0 reactions 0 assignees View on GitHub
Area-ApiCompat
Dominant language
C#
Stars
3.2k
Forks
1.3k
PR merge metrics
PR metrics pending

Description

The docs/usage say it should be `TFM=file,file,` but it's actually a `tfm|file,file`.

The docs don't indicate how to specify more than one TFM - but this is done by passing the parameter multiple times.

The docs say `TFM` but it actually needs the full form of the moniker. It should allow the short form (by parsing it).

The docs should also indicate that a directory works.

Alternate option for a package - generate a multi-targeting project for all frameworks discovered in package, add a reference to the package, restore it, and then drive API compat off such a project. This could save a lot of manual inputs, but it would be a lot to juggle (MSBuild reference, temporary project, etc etc).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.