| 1 |
For example the gnome people use the doc use flag to control whether |
| 2 |
gtk-doc gets rebuild using cross references: |
| 3 |
|
| 4 |
16:51 <@leio> as far as I'm concerned the doc USE flag means rebuilding |
| 5 |
documentation to get cross-referencing in docs working |
| 6 |
16:51 <@leio> also the lack of doc USE flag does not mean to not install |
| 7 |
documentation |
| 8 |
16:52 <@leio> it means to not take a long time to build documentation, |
| 9 |
and we are not doing it if doc USE flag is not present |
| 10 |
|
| 11 |
This leads to having tons of gtk-doc installed: |
| 12 |
betelgeuse@pena ~ $ du -sh /usr/share/gtk-doc/html/ |
| 13 |
51M /usr/share/gtk-doc/html/ |
| 14 |
|
| 15 |
In for example Java we use it to control Javadoc installation. Javadoc |
| 16 |
generation rarely takes much time and needs no extra dependencies but |
| 17 |
having Javadocs for everything would consume a lot of space. |
| 18 |
|
| 19 |
My opinion is to make it clear that the doc use flag always controls |
| 20 |
whether or not to install documentation and make it clear in the |
| 21 |
devmanual. For what gnome does, they can then add for example a gtk-doc |
| 22 |
use flag to control the building of the cross references and have the |
| 23 |
doc use flag control the installation of the bundled documentation. |
| 24 |
|
| 25 |
betelgeuse@pena ~ $ euse -i doc |
| 26 |
global use flags (searching: doc) |
| 27 |
************************************************************ |
| 28 |
[- ] doc - Adds extra documentation (API, Javadoc, etc) |
| 29 |
|
| 30 |
INSTALL_MASK is of course a solution to not installing gtk-doc at all |
| 31 |
but it doesn't give me the ability to install it only for individual |
| 32 |
packages. |
| 33 |
|
| 34 |
What do others think? |
| 35 |
|
| 36 |
Regards, |
| 37 |
Petteri |
Archives