[Fwd: Re: policy proposition for javadoc installation]

[Michael Gratton <mike@vee.net>]

Erm, this should have gone to the list..

--
Mike Gratton <mike@vee.net>
  Leader in leachate production and transmission since 1976.
  <http://web.vee.net/>

--- Begin Message ---

• To: Guillaume Rousse <rousse@ccr.jussieu.fr>
• Subject: Re: policy proposition for javadoc installation
• From: Mike Gratton <mike@vee.net>
• Date: Sun, 04 Nov 2001 17:13:33 +1030
• Message-id: <3BE4E395.6050502@vee.net>
• References: <[🔎] 20011103140437.1D61649F5@silbermann.snv.jussieu.fr>

Guillaume Rousse wrote:

We propose instead to install it under a distinct subdirectory under a new /usr/share/apidoc top-level directory. Advantages:

- distinction with standard documentation

Erm, but isn't that the whole point of the standard? So that everything is always in the same place, regardless of what platform, OS, etc.

Someone new to Java, but who knows UNIX will think to look in /usr/[share/]doc/[packagename] for any docs, but no one will think to look in /usr/share/apidoc.

- would allow to link generated javadoc versus already-installed one

Surely something like:

/usr/share/doc/[packagename]/javadoc
/usr/share/doc/[packagename]/javadoc-generated

would do.

- name 'apidoc' is not specificaly related to java, could also be used by other languages

Again, it is bad because it is counter-intuitative.


I don't think it is agood idea.

Mike.

--
Mike Gratton <mike@vee.net>
"Every motive escalate."
 Blatant self-promotion: <http://web.vee.net/>

--- End Message ---