From 62981f4b5c52fc693b770e16296934366948c8c6 Mon Sep 17 00:00:00 2001 From: Petr Date: Mon, 20 Mar 2023 12:51:08 +0100 Subject: [PATCH] Minor clarifications to baseline test docs --- DEVGUIDE.md | 4 ++-- TESTGUIDE.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DEVGUIDE.md b/DEVGUIDE.md index bf87db9232..49e04803ec 100644 --- a/DEVGUIDE.md +++ b/DEVGUIDE.md @@ -149,7 +149,7 @@ sh build.sh -c Release ## Updating baselines in tests -Some tests use "baseline" files. There is sometimes a way to update these baselines en-masse in your local build, +Some tests use "baseline" (.bsl) files. There is sometimes a way to update these baselines en-masse in your local build, useful when some change affects many baselines. For example, in the `fsharpqa` and `FSharp.Compiler.ComponentTests` tests the baselines are updated using scripts or utilities that allow the following environment variable to be set: @@ -182,7 +182,7 @@ or `./Build.cmd -c Release -testDesktop` to update Release .NET Framework baselines. > **Note** -> Please note, that by default, **Release** version of IL baseline baseline tests will be running in CI, so when updating baseline files, make sure to add `-c Release` flag to the build command. +> Please note, that by default, **Release** version of IL baseline tests will be running in CI, so when updating baseline (.bsl) files, make sure to add `-c Release` flag to the build command. ## Automated Source Code Formatting diff --git a/TESTGUIDE.md b/TESTGUIDE.md index 7709333606..5dcfbb5f52 100644 --- a/TESTGUIDE.md +++ b/TESTGUIDE.md @@ -121,7 +121,7 @@ This is compiled using [tests\fsharp\FSharp.Tests.FSharpSuite.fsproj](tests/fsha Tests are grouped in folders per area. Each test compiles and executes a `test.fsx|fs` file in its folder using some combination of compiler or FSI flags specified in the FSharpSuite test project. If the compilation and execution encounter no errors, the test is considered to have passed. -There are also negative tests checking code expected to fail compilation. See note about baseline under "Other Tips" bellow for tests checking expectations against "baseline" files. +There are also negative tests checking code expected to fail compilation. See note about baseline under "Other Tips" bellow for tests checking expectations against "baseline" (.bsl) files. ### FSharpQA Suite