| 1 |
begin quote |
| 2 |
On Sun, 22 Aug 2004 04:34:38 +0200 |
| 3 |
Karl Trygve Kalleberg <karltk@g.o> wrote: |
| 4 |
|
| 5 |
> |
| 6 |
> In java, we have many libraries that are a few hundred kb, that come |
| 7 |
> with multiple megabytes of generated documentation, that you will only |
| 8 |
> need if you're a Java developer, and usually not even then. |
| 9 |
|
| 10 |
|
| 11 |
> Also, as javadoc is a memory hog, generating the documentation may be |
| 12 |
> prohibitive on older machines. |
| 13 |
|
| 14 |
Actually, you just describe the reason we implemented the "doc" useflag. |
| 15 |
Its not meant for enduser documentation in that sense, but for more |
| 16 |
massive, developer oriented documentation that is autogenerated in some |
| 17 |
ways. okay, its misnamed, I realized that afterwards, too late. |
| 18 |
|
| 19 |
it was basically there to stop packages from pulling in t1, tetex, |
| 20 |
openjade, ghostscript and the rest, just to parse some .h headers with a |
| 21 |
perl script and generate documentation in multitudes of formats. |
| 22 |
|
| 23 |
|
| 24 |
So, the documentation / javadoc, are best off covered by the USE="doc" |
| 25 |
flag, whereas examples should probably be split up a bit further. |
| 26 |
(examplecode !) |
| 27 |
|
| 28 |
Its fairly important that we don't start to misuse such a flag for |
| 29 |
example configurations, which should be considered necessary base level |
| 30 |
documentation for users, not "examples" in the sense we are talking |
| 31 |
about here. |
| 32 |
|
| 33 |
(for a typical "example" app, freepascal is an example ;) |
| 34 |
|
| 35 |
|
| 36 |
//Spider |
| 37 |
|
| 38 |
|
| 39 |
|
| 40 |
|
| 41 |
-- |
| 42 |
begin .signature |
| 43 |
Tortured users / Laughing in pain |
| 44 |
See Microsoft KB Article Q265230 for more information. |
| 45 |
end |
Archives