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

retire custom manpage generator #4561

Merged
merged 2 commits into from
Aug 11, 2023

Conversation

elliefm
Copy link
Contributor

@elliefm elliefm commented Aug 7, 2023

Previously: #4555

Switches our docs build to use the stock sphinx manpage generator, rather than the custom one that keeps getting broken by new sphinx releases (thanks @rjbs), and then removes the parts we're no longer using.

I think I've removed everything that needed removing, but it shouldn't hurt if I've missed stuff.

Reviewers: please test this -- it works fine for me, but does it work for you?

  1. Assuming you usually have all the dependencies for docs generation, run configure as you usually would
  2. make man -- should exit success. There will be a bunch of warnings ("duplicate term", "glob pattern didn't match", "document isn't included in any doctree") but these can be ignored, unless they're different from what I've listed.
  3. It should have created the man pages in the man/ directory. ls -l man/* | wc -l gives 84 for me. Check that they're not empty! Also check a couple of them to ensure they look okay: man man/imapd.conf.5 etc.
  4. Clean your repo however you usually would (I use git clean -xfd, though n.b. this will trash uncommitted files)
  5. Change into the docsrc directory
  6. Run make man in here -- you do not need to have run configure for this!
  7. Expect slightly different terminal output, but same warnings as before
  8. Generated man pages will be docsrc/build/man, check those too as per step 3.

@elliefm elliefm force-pushed the v39/retire-custom-manpage-generator branch from bf96543 to 43256e7 Compare August 9, 2023 01:25
@elliefm elliefm marked this pull request as ready for review August 9, 2023 01:43
Copy link
Contributor

@ksmurchison ksmurchison left a comment

Choose a reason for hiding this comment

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

Works for me

@rjbs rjbs self-requested a review August 9, 2023 15:08
Copy link
Collaborator

@rjbs rjbs left a comment

Choose a reason for hiding this comment

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

I didn't find any nasty traces!

@elliefm elliefm added backport-to-3.6 for PRs that are to be backported to 3.6 backport-to-3.4 for PRs that are to be backported to 3.4 backport-to-3.2 for PRs that are to be backported to 3.2 backport-to-3.8 for PRs that are to be backported to 3.8 labels Aug 11, 2023
rjbs and others added 2 commits August 11, 2023 13:21
Why is the current one broken with newer libraries?

I don't know!  But we also no longer know why we had a custom builder,
either.  At first glance, the output without the custom code seems fine.
We should inspect it more, and then we can decide if we can go forward
with this and also delete the custom code!
@elliefm elliefm force-pushed the v39/retire-custom-manpage-generator branch from 43256e7 to d6b2c08 Compare August 11, 2023 03:21
@elliefm elliefm merged commit de94b64 into cyrusimap:master Aug 11, 2023
1 check passed
@elliefm elliefm deleted the v39/retire-custom-manpage-generator branch August 11, 2023 03:21
@elliefm elliefm removed backport-to-3.8 for PRs that are to be backported to 3.8 backport-to-3.6 for PRs that are to be backported to 3.6 backport-to-3.4 for PRs that are to be backported to 3.4 backport-to-3.2 for PRs that are to be backported to 3.2 labels Aug 14, 2023
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