Page MenuHomeFreeBSD

security/gnupg: rebuild man pages
ClosedPublic

Authored by asomers on Wed, Nov 20, 11:26 PM.

Details

Summary

security/gnupg: rebuild man pages

gnupg ships its man pages as texinfo files, precompiled into info files.
This patch rebuilds those info files. There are two reasons:

  • Rebuilding them automatically corrects several Linuxisms in paths (e.g. /etc => /usr/local/etc).
  • Rebuilding them is a neccessary precondition for making any local changes that will affect the content of the man pages, which I intend to do in a future patch.

Diff Detail

Repository
rP FreeBSD ports repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

asomers created this revision.Wed, Nov 20, 11:26 PM

This seems tremendously fragile. Unless I'm misunderstanding, these massive patches would have to be regenerated for every update (assuming changes), which---while I appreciate the patch coming down the pipeline---I don't relish the thought of being responsible for.

Can we just rebuild them using texinfo and apply your patches in pre-build? Or can you base your patches against the original so we can run texinfo on it afterwards?

This seems tremendously fragile. Unless I'm misunderstanding, these massive patches would have to be regenerated for every update (assuming changes), which---while I appreciate the patch coming down the pipeline---I don't relish the thought of being responsible for.

Yes, the patches would have to be regenerated for every update that changes the docs. It looks like upstream doesn't always revise the docs with each release, though.

Can we just rebuild them using texinfo and apply your patches in pre-build? Or can you base your patches against the original so we can run texinfo on it afterwards?

Basing my patches against the original .texinfo is what I tried first. We can certainly do that. The downside is running makeinfo during the build will reset the .Dd in the man pages. Effectively, the .Dd date would become the build date of the man pages, not their edit date. If you're ok with that wart, then I'll update the patch to work that way.

I'm fine with a date change in that context.

asomers updated this revision to Diff 64657.Thu, Nov 21, 12:33 AM

Rebuild man pages on every build, rather than try to patch them.

adamw accepted this revision.Thu, Nov 21, 1:00 AM

After updating the DOCS_BUILD_DEPENDS (and also bumping PORTREVISION please), feel free to commit this anytime.

security/gnupg/Makefile
48 ↗(On Diff #64657)

This should be makeinfo:print/texinfo. ${LOCALBASE}/bin is implied.

This revision is now accepted and ready to land.Thu, Nov 21, 1:00 AM

FYI, the DR already contained a PORTREVISION bump. You were probably just looking at the second item in the history, instead of the whole diff.

security/gnupg/Makefile
48 ↗(On Diff #64657)

Ok. I saw it done both ways in existing ports.

This revision was automatically updated to reflect the committed changes.