Skip to content

Get-help may return multiple instances of the same help file #3410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mirichmo merged 3 commits into from
Mar 28, 2017
Merged

Get-help may return multiple instances of the same help file #3410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fdf27f
Help was incorrectly returning multiple instances of the same help fi…
SteveL-MSFT Mar 24, 2017
601d9ac
updated test to use generated help file rather than an actual one
SteveL-MSFT Mar 24, 2017
c6fb535
Fixed test to have module in $pshome path and casing of en-US culture
SteveL-MSFT Mar 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/System.Management.Automation/help/HelpProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,11 @@ internal Collection<string> GetSearchPaths()
Diagnostics.Assert(searchPaths != null,
"HelpSystem returned an null search path");

searchPaths.Add(GetDefaultShellSearchPath());
string defaultShellSearchPath = GetDefaultShellSearchPath();
if (!searchPaths.Contains(defaultShellSearchPath))
{
searchPaths.Add(defaultShellSearchPath);
}

return searchPaths;
}
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/help/MUIFileSearcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ private void AddFiles(string muiDirectory, string directory, string pattern)
string leafFileName = Path.GetFileName(file);
string uniqueToDirectory = Path.Combine(directory, leafFileName);

if (!_uniqueMatches.Contains(uniqueToDirectory))
if (!_result.Contains(path) && !_uniqueMatches.Contains(uniqueToDirectory))
{
_result.Add(path);
_uniqueMatches[uniqueToDirectory] = true;
Expand Down
21 changes: 21 additions & 0 deletions test/powershell/engine/Help/HelpSystem.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,3 +180,24 @@ Describe "Validate that Get-Help returns provider-specific help" -Tags @('CI', '
}
}
}

Describe "Validate about_help.txt under culture specific folder works" -Tags @('CI') {
BeforeAll {
$modulePath = "$pshome\Modules\Test"
$null = New-Item -Path $modulePath\en-US -ItemType Directory -Force
New-ModuleManifest -Path $modulePath\test.psd1 -RootModule test.psm1
Set-Content -Path $modulePath\test.psm1 -Value "function foo{}"
Set-Content -Path $modulePath\en-US\about_testhelp.help.txt -Value "Hello" -NoNewline
}

AfterAll {
Remove-Item $modulePath -Recurse -Force
}

It "Get-Help should return help text and not multiple HelpInfo objects when help is under `$pshome path" {

$help = Get-Help about_testhelp
$help.count | Should Be 1
$help | Should BeExactly "Hello"
}
}