Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 205795 - Need new documentation wrt java-osgi eclass
Summary: Need new documentation wrt java-osgi eclass
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Java (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Java team
URL: http://www.gentoo.org/proj/en/java/ja...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-01-14 13:49 UTC by Jean-Noël Rivasseau (RETIRED)
Modified: 2008-01-19 17:21 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jean-Noël Rivasseau (RETIRED) gentoo-dev 2008-01-14 13:49:59 UTC
I have to write documentation describing the OSGi packaging functions (newjar, dojar etc have their equivalent in java-osgi). Need to decide where to put such a documentation first.

Reproducible: Always
Comment 1 Petteri Räty (RETIRED) gentoo-dev 2008-01-14 14:49:18 UTC
Here:
http://www.gentoo.org/proj/en/java/java-devel.xml
Comment 2 Jean-Noël Rivasseau (RETIRED) gentoo-dev 2008-01-18 16:32:31 UTC
I commited the documentation. Can someone briefly review it?

(Note that I also changed to java_dohtml to reflect the fact it is deprecated).
Comment 3 Petteri Räty (RETIRED) gentoo-dev 2008-01-18 20:05:56 UTC
(In reply to comment #2)
> I commited the documentation. Can someone briefly review it?
> 

I improved the grammar.
Comment 4 Petteri Räty (RETIRED) gentoo-dev 2008-01-18 20:06:39 UTC
(In reply to comment #2)
> I commited the documentation. Can someone briefly review it?
> 

You are using quite long lines in the file, might want to make them a little shorter.
Comment 5 Alistair Bush (RETIRED) gentoo-dev 2008-01-19 05:30:46 UTC
Removed another java-pkg_dohtml

In my short hand diff format
 -- HTML documentation should be installed using <uri link="#func_install">java-pkg_dohtml</uri>

 ++ HTML documentation should be installed using <uri link="http://devmanual.gentoo.org/function-reference/install-functions/index.html">dohtml</uri>



and a cvs diff


Index: java-devel.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/java/java-devel.xml,v
retrieving revision 1.31
diff -u -b -B -r1.31 java-devel.xml
--- java-devel.xml      18 Jan 2008 22:43:30 -0000      1.31
+++ java-devel.xml      19 Jan 2008 05:27:22 -0000
@@ -328,7 +328,7 @@
 <body>

 <p>
-If a manual or other extensive documentation is available, it should be installed using the doc USE flag.  If the build system can, you should build javadocs also using the <c>doc</c> USE flag. If it does not, you should consider patching it to do so, and provide the patch upstream. HTML documentation should be installed using <uri link="#func_install">java-pkg_dohtml</uri> and javadocs using <uri link="#func_install">java-pkg_dojavadoc</uri>.
+       If a manual or other extensive documentation is available, it should be installed using the doc USE flag.  If the build system can, you should build javadocs also using the <c>doc</c> USE flag. If it does not, you should consider patching it to do so, and provide the patch upstream. HTML documentation should be installed using <uri link="http://devmanual.gentoo.org/function-reference/install-functions/index.html">dohtml</uri> and javadocs using <uri link="#func_install">java-pkg_dojavadoc</uri>.
 </p>

 <p>
Comment 6 Petteri Räty (RETIRED) gentoo-dev 2008-01-19 17:21:33 UTC
It's documented and reviewed by a couple of devs so let's mark this as fixed.