docs icon indicating copy to clipboard operation
docs copied to clipboard

Document baseline validation "strict mode"

Open gewarren opened this issue 2 years ago • 0 comments

Baseline package validation now also has a strict mode which we should probably document (similar to the other package validator documents): EnableStrictModeForBaselineValidation.

You want to set this to true when you want the apicompat to perform "equality" checks instead of compatibility checks. This means that api additions or changing the assembly (in a compatible way) is disallowed. The primary use-case for this is servicing in which API additions are usually forbidden.

You could also enable this so that APICompat records all compatibility differences in the suppression file (for tracking API changes). For that you would also need to set ApiCompatGenerateSuppressionFile to true.

Originally posted by @ViktorHofer in https://github.com/dotnet/docs/pull/38533#discussion_r1412026574


Associated WorkItem - 189677

gewarren avatar Dec 01 '23 20:12 gewarren