Skip to content

Regenerate the tool docs for 20.8.2 - #1009

Merged
SimonCropp merged 1 commit into
mainfrom
regenerate-tool-docs
Oct 30, 2026
Merged

SimonCropp merged 1 commit into
mainfrom
regenerate-tool-docs

Conversation

@SimonCropp

Copy link
Copy Markdown
Member

DefinitionsTest.WriteFoundTools writes src/DiffEngine.Tests/diffTools.include.md, and the viewer's scanned paths in it name this library's NuGet cache folder by version (FallbackViewerDirectories.LibraryVersion). The committed copy still named 20.7.1 while Directory.Build.props is at 20.8.2, so every local test run left it modified.

The change. The include regenerated by the tests, and docs/diff-tool.md regenerated from it by MarkdownSnippets. Each changes six lines, the win-x64, osx-x64 and linux-x64 cache paths, from 20.7.1 to 20.8.2.

Tests. Locally on Windows, a Release build had no errors. DiffEngine.Tests: 2,264 passed, 20 skipped, 4 failed. The failures are AListenerIsFoundOnItsPort and AListenerIsListedOnEveryPlatform on net10 and net48. Both assert ListenerTable.Enumerated, the .NET fallback built on GetActiveTcpListeners, which misses listeners on this machine's Windows build (10.0.26300). CI passes them on main.

DefinitionsTest.WriteFoundTools writes the viewer's scanned paths with
this library's version in the NuGet cache folder, and the committed
include still named 20.7.1 while Directory.Build.props is at 20.8.2, so
every local test run left it modified. docs/diff-tool.md is regenerated
from it by MarkdownSnippets.
@SimonCropp
SimonCropp merged commit 71bfe54 into main Oct 30, 2026
15 checks passed
@SimonCropp
SimonCropp deleted the regenerate-tool-docs branch October 30, 2026 11:43
SimonCropp added a commit that referenced this pull request Oct 30, 2026
The viewer is looked for in the NuGet cache under this library's own
version first, and WriteFoundTools wrote that path as it was, so
diffTools.include.md and docs/diff-tool.md went stale at every release
(#1009 caught them up from 20.7.1). The writer now shows that segment as
{version}, and the docs change only when the search order does.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant