From owner-freebsd-doc@FreeBSD.ORG Fri Apr 2 05:17:15 2004 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 7F3AA16A4CE; Fri, 2 Apr 2004 05:17:15 -0800 (PST) Received: from arabica.esil.univ-mrs.fr (arabica.esil.univ-mrs.fr [139.124.41.108]) by mx1.FreeBSD.org (Postfix) with ESMTP id 6DB8643D2D; Fri, 2 Apr 2004 05:17:14 -0800 (PST) (envelope-from herve.quiroz@esil.univ-mrs.fr) Received: from arabica.esil.univ-mrs.fr (localhost.esil.univ-mrs.fr [127.0.0.1])i32DHDDN078832; Fri, 2 Apr 2004 15:17:13 +0200 (CEST) (envelope-from herve.quiroz@esil.univ-mrs.fr) Received: (from rv@localhost)i32DHCMw078831; Fri, 2 Apr 2004 15:17:12 +0200 (CEST) (envelope-from herve.quiroz@esil.univ-mrs.fr) X-Authentication-Warning: arabica.esil.univ-mrs.fr: rv set sender to herve.quiroz@esil.univ-mrs.fr using -f Date: Fri, 2 Apr 2004 15:17:12 +0200 From: Herve Quiroz To: Manfred Riem Message-ID: <20040402131712.GA78675@arabica.esil.univ-mrs.fr> Mail-Followup-To: Manfred Riem , freebsd-java@freebsd.org, freebsd-doc@freebsd.org References: <20040401184525.52DB18C6C@svbcf02.win.tue.nl> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20040401184525.52DB18C6C@svbcf02.win.tue.nl> User-Agent: Mutt/1.4.2.1i cc: freebsd-doc@freebsd.org cc: freebsd-java@freebsd.org Subject: Re: Documentation proposal X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 02 Apr 2004 13:17:15 -0000 Manfred, On Thu, Apr 01, 2004 at 08:45:22PM +0200, Manfred Riem wrote: > Hi there, > > I want to try to make the Java documentation on the FreeBSD website > a bit more usable. Currently the bits are a bit scattered around. That's a good thing. I just posted a message to this list (in the Tomcat thread IIRC) regarding my plan of filling the Java section of the porter's handbook. > - Removing "Creating Ports" as currently not a real standard has > been set. Follow up on the discussion recently held on the > mailinglist. Actually, the first two points are now "official" because some macros are provided by bsd.java.mk: The JAVAJARDIR macro is the location for the JAR files from Java libraries, and JAVASHAREDIR is the prefix for Java applications. Many ports do not use them yet, probably because their maintainer don't know (yet) about them. That's another good reason to update the Java documentation. However, in practice, the third point is not official. Most of the Java ports I know of use directly DOCSDIR as for any other (non-Java) port. IMHO, this approach (DOCSDIR) is the correct one. I think the best place to explain Java porter's practice is the Java section of the porter's handbook. As I said above, I will try to fill it as soon as bsd.java.mk 2.0 is commited (so information is up-to-date). Ernst has already written a quite complete manual for porting Java applications/libraries with bsd.java.mk 1.0 and I have built (based on Ernst's work) a similar documentation regarding bsd.java.mk 2.0. So putting it in the porter's handbook won't be too complex. FYI: - Ernst's web page (he is maintaining bsd.java.mk): http://people.freebsd.org/~znerd/ Unfortunately, some of the documentation is not up-to-date... and some other is on www.metaverse.nl which seems to be offline for the moment. - Documentation about bsd.java.mk 2.0: http://www.esil.univ-mrs.fr/~hquiroz/freebsd/bsd.java.mk-2.0.html (Not relevant for now, but will be the reference documentation when version 2.0 is commited) If you want, I will handle everything that is related to Java porting as you will already have a lot of work with the remaining points ;) > - A more clear definition for newbies on how to install Java from > the sources (eg. tell them about the linux bootstrap). That would be nice. Having the most common issues resolved on a web page is better for end-users. Indeed they won't have to subscribe to the list to get a simple, common problem solved. Herve PS: hum... I realize that I reply to the freebsd-doc list, to which I am not even registered. Please forgive me for this bad practice. It's for the good cause, and I will subscribe to it probably in the near future anyway ;)