Bug 1953601

Summary:	Explore using help2man for man page
Product:	[Fedora] Fedora	Reporter:	Bruno Wolff III <bruno>
Component:	squashfs-tools	Assignee:	Bruno Wolff III <bruno>
Status:	CLOSED RAWHIDE	QA Contact:	Fedora Extras Quality Assurance <extras-qa>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	rawhide	CC:	bruno, katzj, kyle
Target Milestone:	---	Keywords:	FutureFeature
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2022-02-08 23:33:50 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Bruno Wolff III 2021-04-26 13:24:45 UTC

Currently the man pages for squashfs-tools are based on man pages used from Debian. Upstream doesn't provide man pages as part of the project, but the executables provide reasonably detailed help output. So using help2man may provide a more maintainable way to provide man pages.

I probably won't do this until the next squashfs-tools release. Phillip has been doing a lot of clean up work the last few months and I expect it won't be too long before there is another release. One of the changes affects implementing this change. The location of the output of the help option is being changed from stderr to stdout.

Potentially I might play with this before a release so that I can make a new Fedora release sooner after the upstream release. Some of the options have changed, so something will need to be done with the current man pages as part of the Fedora update in any case.

Comment 1 Bruno Wolff III 2021-07-27 12:02:33 UTC

4.5 is out now and the man pages are significantly behind. Early tests of help2man didn't look very good. I doubt a hands off build chain will work.

Comment 2 Bruno Wolff III 2022-01-28 08:49:24 UTC

Phillip has announced that he will add man pages for the next point release which should be out shortly.

Comment 3 Bruno Wolff III 2022-02-08 23:33:50 UTC

Upstream man pages now replace the out of date ones we got from Debian for mksquashfs and unsquashfs. There are different semantics for those programs when they are run as sqfstar or sqfscat, but we don't have man pages for those now. I don't know if thise will be provided for 4.5.1 or if that is something farther in the future. But that is outside the scope of this bugzilla entry.