Skip to content

Conversation

@yadij
Copy link
Contributor

@yadij yadij commented Sep 25, 2025

Use automake to build the cfgman HTML documentation.
This was done as part of the daily snapshot release
which is no longer happening.

This is an optional output which can be built using:

   make -C doc cfgman

Some documentation requires other sources and tools
to already have built or generated their output.
Use automake to build the cfgman documentation.
This was done as part of the daily snapshot release
which is no longer happening.
@yadij yadij added M-cleared-for-merge https://github.com/measurement-factory/anubis#pull-request-labels feature maintainer needs documentation updates for merge S-could-use-an-approval An approval may speed this PR merger (but is not required) backport-to-v7 maintainer has approved these changes for v7 backporting labels Sep 25, 2025
@yadij yadij changed the title Build configuration manual Maintenance: Build configuration manual Sep 25, 2025
@rousskov rousskov added S-waiting-for-author author action is expected (and usually required) and removed M-cleared-for-merge https://github.com/measurement-factory/anubis#pull-request-labels labels Sep 25, 2025
@yadij yadij requested a review from rousskov October 2, 2025 18:24
@yadij yadij added S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box and removed S-waiting-for-author author action is expected (and usually required) labels Oct 2, 2025
@yadij
Copy link
Contributor Author

yadij commented Oct 5, 2025

At most, a question I have is why is this target not built automatically?

I considered that, but it is extra build time for everybody+CI and there are not many uses.

That said, we might want to consider making the whole of doc/ an optional build target.

@kinkie
Copy link
Contributor

kinkie commented Oct 5, 2025

At most, a question I have is why is this target not built automatically?

I considered that, but it is extra build time for everybody+CI and there are not many uses.

The risk with this choices is that potential users might not know it exists, and it might rot.
How about adding and other doc targets as explicit tests in the "slow" CI? We don't really care about speed there

That said, we might want to consider making the whole of doc/ an optional build target.
Might be worth a (different) discussion

@yadij yadij added the M-ignored-by-merge-bots https://github.com/measurement-factory/anubis/blob/master/README.md#pull-request-labels label Nov 25, 2025
@yadij yadij changed the title Maintenance: Build configuration manual Bug 5530: Maintenance: Build configuration manual Dec 10, 2025
@yadij yadij changed the title Bug 5530: Maintenance: Build configuration manual Bug 5530: Build cfgman documentation Dec 10, 2025
@yadij yadij removed the M-ignored-by-merge-bots https://github.com/measurement-factory/anubis/blob/master/README.md#pull-request-labels label Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-to-v7 maintainer has approved these changes for v7 backporting feature maintainer needs documentation updates for merge S-could-use-an-approval An approval may speed this PR merger (but is not required) S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants