Skip to content
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.

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

build(doc): generate manpages only with -DGENERATE_MANPAGES=1 #27

Merged
merged 1 commit into from
Jun 10, 2024

Conversation

cjp256
Copy link
Collaborator

@cjp256 cjp256 commented Jun 6, 2024

As pointed out by Noah in #15, Debian packaging lints issues in the
generated manpage due to formatting emitted by older versions of pandoc:
jgm/pandoc#9020

While changes in recent versions of pandoc have improved the output,
let's just take the generated output from pandoc 3.2 as a starting point
and maintain it manually for the time being. This reduces friction for
packaging and gives us flexibility if we wanted to do something in the
manpage that pandoc doesn't support.

Allow manpages to be generated at build-time with -DGENERATE_MANPAGES=1
which will make it easy to sync.

@cjp256
Copy link
Collaborator Author

cjp256 commented Jun 6, 2024

@chewi @nmeyerhans @jepio thoughts?

@chewi
Copy link
Collaborator

chewi commented Jun 6, 2024

Gentoo doesn't have 3.2 yet, but we don't lint for this, so I don't mind either way. @nmeyerhans' suggestion is good.

@cjp256 cjp256 force-pushed the drop-pandoc branch 9 times, most recently from 69aa2c2 to 8167cac Compare June 6, 2024 20:36
@cjp256 cjp256 changed the title build(doc): drop pandoc generation of manpage build(doc): generate manpages only with -DGENERATE_MANPAGES=1 Jun 6, 2024
@cjp256 cjp256 requested a review from nmeyerhans June 6, 2024 20:37
As pointed out by Noah in Azure#15, Debian packaging lints issues in the
generated manpage due to formatting emitted by older versions of pandoc:
jgm/pandoc#9020

While changes in recent versions of pandoc have improved the output,
let's just take the generated output from pandoc 3.2 as a starting point
and maintain it manually for the time being.  This reduces friction for
packaging and gives us flexibility if we wanted to do something in the
manpage that pandoc doesn't support.

Allow manpages to be generated at build-time with -DGENERATE_MANPAGES=1
which will make it easy to sync.

Signed-off-by: Chris Patterson <[email protected]>
Copy link
Collaborator

@nmeyerhans nmeyerhans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ship it

@cjp256 cjp256 merged commit 2c9651e into Azure:main Jun 10, 2024
5 checks passed
@cjp256 cjp256 deleted the drop-pandoc branch June 10, 2024 21:34
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.

3 participants