Patch: update documentation for gcj-eclipse merge

Gerald Pfeifer gerald@pfeifer.com
Sat Jan 6 01:17:00 GMT 2007


On Fri, 5 Jan 2007, Tom Tromey wrote:
> This patch also documents the various prerequisites, new configure
> flags, etc.

Some quick comments: Why do you remove all references to jacks?

I believe sourceware.org should be used as the canonical name of the 
machine in the new script.

> +If you wish to modify @file{.java} files in libjava, you will need to
> +configure with @code{--enable-java-maintainer-mode}, and you will 
need
                  ^^^^^
@option

> +to have executables named @code{ecj1} and @code{gjavah} on your path.

@command instead of @code (also later in this paragraph)

> +The @code{ecj1} executable should run the Eclipse Java compiler via
> +the GCC-specific entry point.  You can download a suitable jar from
> +@uref{ftp://sources.redhat.com/pub/java/}, or by running the script

Canonical hostname sourcware.org?

> +@file{contrib/download_ecj}.

@command, I believe.

> +@item --enable-java-maintainer-mode
> +By default the @samp{libjava} build will not attempt to compile the
> +@file{.java} source files to @file{.class}.  Instead, it will use the
> +@file{.class} files from the source tree.  If you use this option you
> +must have executables named @samp{ecj1} and @samp{gjavah} in your path

@command{ecj1}, @command{gjavah}

> +modify any @file{.java} files in @samp{libjava}.

I blieve we should use @file{libjava}, unless this is the name of the
library, in which case I'm not sure what would be best, probably 
@code{libjava} from what I have seen elsewhere.  (This also applies
to other parts of the patch.)

> +This option can be used to specify the location of an external ``ecj''
> +jar; that is, the jar file containing the Eclipse Java compiler.

How about "...location of an external jar file containing..."?

> +specially modified version of this compiler is used by @samp{gcj} to

@command

> +If @file{ecj1} is not installed, then the user will have to supply one
> +on his path in order for @samp{gcj} to properly parse @file{.java}

@command

> +source files.  A suitable jar is available from
> +@uref{ftp://sources.redhat.com/pub/java}.

I recommend adding a trailing slash to the URL, in addition to use 
sourceware.org.

The doc portions of this patch are fine modulo the comments above, as
far as I can tell.

Thanks,
Gerald



More information about the Gcc-patches mailing list