Bug 476946 – java-*.eclass - Update documentation of the eclass to be compliant with eclass-manpages; that way, people can benefit from the manpages and the devmanual instead of using doxygen, the ebuild or the (outdated) project pages.

• Status: RESOLVED FIXED
• Product: Gentoo Linux

[Description Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:55:28 UTC]

The eclass reference in the devmanual and the output of the eclass-manpages are lacking documents for several eclasses because their documentation markup isn't compatible (or migrated) to the one the eclass-to-manpages.awk script expects.
This makes it hard for developers to find and use the existing functions.

Attached are patches for the java eclasses java-ant-2, java-mvn-src, java-osgi, java-pkg-simple and java-utils-2 (changes are documentation-only).

[Comment 1 Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:55:40 UTC]

Created attachment 353364 [details, diff]
Patch for the java-ant-2.eclass

[Comment 2 Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:55:56 UTC]

Created attachment 353366 [details, diff]
Patch for the java-mvn-src.eclass

[Comment 3 Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:56:13 UTC]

Created attachment 353368 [details, diff]
Patch for the java-osgi.eclass

[Comment 4 Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:56:26 UTC]

Created attachment 353370 [details, diff]
Patch for the java-pkg-simple.eclass

[Comment 5 Johann Schmitz (ercpe) (RETIRED) 2013-07-15 16:56:38 UTC]

Created attachment 353372 [details, diff]
Patch for the java-utils-2.eclass

[Comment 6 Johann Schmitz (ercpe) (RETIRED) 2013-07-16 06:10:27 UTC]

Created attachment 353410 [details, diff]
Patch for the ant-tasks.eclass

[Comment 7 Johann Schmitz (ercpe) (RETIRED) 2013-08-28 08:19:25 UTC]

Patch files, generated man pages and man2html output can be found at http://dev.gentoo.org/~ercpe/java-eclasses/

[Comment 8 Vlastimil Babka (Caster) (RETIRED) 2013-10-05 09:29:47 UTC]

*** Bug 210723 has been marked as a duplicate of this bug. ***

[Comment 9 Vlastimil Babka (Caster) (RETIRED) 2013-10-05 14:10:43 UTC]

ant-tasks and java-ant-2 done

[Comment 10 Vlastimil Babka (Caster) (RETIRED) 2013-10-06 14:38:47 UTC]

java-utils-2 done. Still could use some polishing though, and moving e.g. JAVA_PKG_FORCE_ANT_TASKS to java-ant-2 eclass

[Comment 11 Patrice Clement 2015-10-16 15:19:36 UTC]

There are only two classes left that need to be dealt with to close this ticket: java-pkg-simple.eclass and java-osgi.eclass. I will send a PR with the documentation in question and have Chewi approve it.

[Comment 12 Patrice Clement 2015-10-19 14:56:00 UTC]

PR sent: https://github.com/gentoo/gentoo/pull/264. Chewi pls do your deed. :)

[Comment 13 Patrice Clement 2015-10-19 21:52:31 UTC]

Aforementioned PR has been merged.