man pages didn't cleaned after crc cleanup

[lilyLuLiu]

Test case CRC start usecase failed on windows and darwin-arm64

Both platform failed on the second check of man -P cat crc. Expecting fail but success.

@rohanKanojia mentioned that It shouldn't be running on windows.

[rohanKanojia]

I will add a step to skip this if the underlying operating system is windows.

I'm facing a strange issue with MacOS. It seems there is already another tool with the name crc that has manpage already loaded: https://core.tcl-lang.org/akupries/soft/trf/trf_cmds.html

_____

NAME
       crc - Message digest "crc"

SYNOPSIS
       package require Tcl  ?8.2?

       package require Trf  ?2.1.4?

       crc ?options...? ?data?

Once I manually configure manpath to look into the location where manpages are generated, it works as expected.

Maybe we should just verify that man pages are generated the the folder rather than relying on this behavior.

[albfan]

just to mention, man exists on powershell

PS > man man

NAME
    Get-Help

SYNTAX
    Get-Help [[-Name] <string>] [-Path <string>] [-Category {Alias | Cmdlet | Provider | General | FAQ | Glossary | HelpFile | ScriptCommand | Function | Filter | ExternalScript | All | DefaultHelp | DscResource | Class | Configuration}] [-Full] [-Component <string[]>] [-Functionality <string[]>] [-Role <string[]>] [<CommonParameters>]

but do not work for man -P cat

Looks like man is some alias like:

Get-Help man | more

So to disable pagination just use:

Get-Help man

[rohanKanojia]

@albfan : At the moment, this feature is not enabled on Windows. GenerateManPages is a NOOP for windows platform:

crc/pkg/crc/manpages/manpages_windows.go

Lines 10 to 13 in 2499dd2

	// GenerateManPages generates man pages for cli
	// This method is a no-operation placeholder, it's used to make project compile.
	func GenerateManPages(_ func(targetDir string) error, _ string) error {
	return nil

I had mistakenly added the man step in the pipeline without noticing it had @windows tag too.

[albfan]

Got it. Looks like we use a go module that creates a markdow which is converted to roff formar

platyps is a project that turns markdown into powershell help:

https://mikefrobbins.com/2023/11/30/generating-powershell-module-documentation-with-platyps/

maybe an option to consider

[rohanKanojia]

maybe an option to consider

@albfan : Thanks, sounds like something we can add as a follow-up. I've created a new issue #4610 for this enhancement. Please feel free to add anything in case I missed.