Bug 114831 – Gentoo Java Developer Guide links to undocumented java-pkg_dohtml function

• Product: [OLD] Docs-developer
• Status: RESOLVED FIXED

[Description Timothy Bergeron 2005-12-07 22:29:21 UTC]

The Gentoo Java Developer Guide contains an internal link from    
java-pkg_dohtml to the java-pkg.eclass section of the documentation. The   
problem is that the java-pkg_dohtml function is not defined in that part of   
the documentation. In fact, I couldn't find any documentation until I looked   
at the source of the eclass and saw that it basically just called dohtml   
(which I was able to find). Since dohtml is repackaged as java-pkg_dohtml it  
should be documented in the Gentoo Java Developer Guide. 

Reproducible: Always
Steps to Reproduce:
1.
2.
3.

[Comment 1 Flammie Pirinen (RETIRED) 2005-12-07 23:42:39 UTC]

Project space docs are not for docs-team, reassigning to java.

[Comment 2 Wiktor Wandachowicz 2005-12-27 11:51:34 UTC]

Some initial documentation is already written. See section
"4.1 The java-pkg eclass" at:

http://dev.gentoo.org/~karltk/projects/java/java-policy-draft.txt

This original draft has been last updated 2004-06-20.
Looks like someone just omitted accidentally the corresponding part.

Two notes:
* java-pkg_dohtml takes a list of directories, similarly to java-pkg_dojar
  which takes a list of jar files (probably a similar description may be used)
* java-pkg_dohtml is often called with "-r" parameter in ebuilds, so it's
  probably wise to document that too

HTH

[Comment 3 Ernst de Haan 2005-12-27 12:00:37 UTC]

Perhaps slightly irrelevant, but should 'java-pkg_dohtml' not be deprecated in favor of the generic 'dohtml' ?

[Comment 4 Petteri Räty (RETIRED) 2007-02-10 12:48:19 UTC]

(In reply to comment #3)
> Perhaps slightly irrelevant, but should 'java-pkg_dohtml' not be deprecated in
> favor of the generic 'dohtml' ?
> 

http://www.gentoo.org/proj/en/java/java-devel.xml#func_install

Nowawadays it's documented in the developer guide and yes dohtml is deprecated in favor of dohtml.