Project

General

Profile

Feature #2350

Add configure flag to unconditionally disable doxygen run

Added by pespin 5 months ago. Updated 4 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Target version:
-
Start date:
07/05/2017
Due date:
% Done:

100%

Spec Reference:

Description

Right now in libosmocore, configure.ac checks if doxygen binary is available in the system. If that's the case, it forces the run of doxygen to generate documentation at install time (or make distcheck).

It would be nice to have a configure flag --disable-doxygen or --disable-doc even if it is found on the system. This will speed up compilation times and it's also useful if the user doesn't need documentation.

It's important for instance for osmo-gsm-tester, which copies the uncompressed tarball generated by make distcheck into the sysmobts on every run, and the share/doc directory containing all doxygen output can weight around 40MB nowadays. To avoid that, in osmo-gsmtester we currently rm -rf the share/doc directory, but it would be nice if we could just avoid building them in first place as we don't need them.

Same applies for libosmo-sccp, openbsc, etc.

History

#1 Updated by pespin 5 months ago

  • Status changed from New to Feedback
  • Assignee set to pespin
  • % Done changed from 0 to 80

I found some time to do this during the flight. Patches available in:
https://gerrit.osmocom.org/#/c/3141/
https://gerrit.osmocom.org/#/c/3142/

Next step once it's merged: Use them for osmo-gsm-tester builds.

#2 Updated by laforge 5 months ago

  • Status changed from Feedback to Stalled

patches are merged.

#3 Updated by pespin 4 months ago

  • Status changed from Stalled to Resolved
  • % Done changed from 80 to 100

Patch was applied to osmo-gsm-tester to use the flag and stop removing the files manually.

#4 Updated by laforge 4 months ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF