Skip to content

Conversation

@jcharaoui
Copy link
Contributor

This improves the facter manpage to fix parsing errors due to the missing short description in the NAME section, makes the formatting consistent with most other manpages, and updates the DESCRIPTION section using the one in the project's README, which is more useful this context.

@jcharaoui jcharaoui requested a review from a team as a code owner February 22, 2023 16:57
@puppetlabs-jenkins
Copy link
Collaborator

Can one of the admins verify this patch?

@jcharaoui
Copy link
Contributor Author

Oh I see there's also an ERB template involved, so this needs some extra work.

@jcharaoui jcharaoui changed the title (maint) improve manpage Draft: (maint) improve manpage Feb 22, 2023
@jcharaoui jcharaoui marked this pull request as draft February 22, 2023 17:27
@joshcooper
Copy link
Contributor

Thanks @jcharaoui Could you update this template https://github.com/puppetlabs/facter/blob/07a7a8c4d8076ba19f4564cfb2d3896bedf515b9/lib/facter/templates/man.erb instead? There's also a rake task to regenerate the man page. Thanks!

@CLAassistant
Copy link

CLAassistant commented Apr 19, 2023

CLA assistant check
All committers have signed the CLA.

@joshcooper
Copy link
Contributor

Hi @jcharaoui could you rebase on main and update the erb template? Also I think we do want to keep the \fBfacter\fR in the name so that it's bold in the man output. Thanks!

This improves the facter manpage to fix parsing errors due to the
missing short description in the NAME section, makes the formatting
consistent with most other manpages, and updates the DESCRIPTION section
using the one in the project's README, which is more useful this context.
@jcharaoui
Copy link
Contributor Author

Hi @jcharaoui could you rebase on main and update the erb template? Also I think we do want to keep the \fBfacter\fR in the name so that it's bold in the man output. Thanks!

Done and done!

@jcharaoui jcharaoui changed the title Draft: (maint) improve manpage (maint) improve manpage Mar 16, 2024
@jcharaoui jcharaoui marked this pull request as ready for review March 16, 2024 23:45
@jcharaoui jcharaoui changed the title (maint) improve manpage (maint) improve and regenerate manpage Mar 16, 2024
@joshcooper joshcooper merged commit 39b48ad into puppetlabs:main Apr 11, 2024
@joshcooper
Copy link
Contributor

Thank you @jcharaoui!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants