This is the mail archive of the
java-patches@gcc.gnu.org
mailing list for the Java project.
Patch: FYI: fix gcjh documentation
- From: Tom Tromey <tromey at redhat dot com>
- To: GCJ-patches <java-patches at gcc dot gnu dot org>
- Cc: Gcc Patch List <gcc-patches at gcc dot gnu dot org>
- Date: 26 Mar 2007 19:21:08 -0600
- Subject: Patch: FYI: fix gcjh documentation
- Reply-to: tromey at redhat dot com
I'm checking this in.
This merges in a Classpath patch to add the gcjh documentation, and
also removes the copy from gcc/java. That copy pertained to the old
gcjh implementation, which has been deleted.
This also merges the rmiregistry documentation.
rmic should probably also be merged but there aren't docs for it in
Classpath yet.
Tom
Index: gcc/java/ChangeLog
from Tom Tromey <tromey@redhat.com>
* Make-lang.in (JAVA_MANFILES): Removed grmiregistry.1.
(java.maintainer-clean): Likewise.
(java.install-man): Likewise.
(.INTERMEDIATE): Removed grmiregistry.pod.
(grmiregistry.pod): Removed.
* gcj.texi (Invoking gcjh): Removed.
(Invoking gjnih): Likewise.
(Invoking grmiregistry): Likewise.
(direntry): Updated.
(Top): Likewise.
(which-gcj): Removed.
Index: libjava/classpath/ChangeLog
from Tom Tromey <tromey@redhat.com>
* doc/cp-tools.texinfo (gcjh Tool): Added more text.
(rmid Tool): Likewise.
2007-03-25 Dalibor Topic <robilad@kaffe.org>
* doc/cp-tools.texinfo: Fix node ordering.
2007-03-19 Matthias Klose <doko@ubuntu.com>
* doc/Makefile.am: Build a gcjh(1) man page.
* doc/cp-tools.texinfo: Add documentation for gcjh.
Index: gcc/java/Make-lang.in
===================================================================
--- gcc/java/Make-lang.in (revision 123217)
+++ gcc/java/Make-lang.in (working copy)
@@ -143,7 +143,7 @@
java.html: $(build_htmldir)/java/index.html
JAVA_MANFILES = doc/gcj.1 doc/jcf-dump.1 doc/gij.1 \
- doc/jv-convert.1 doc/grmic.1 doc/grmiregistry.1 \
+ doc/jv-convert.1 doc/grmic.1\
doc/gcj-dbtool.1 doc/gc-analyze.1
java.man: $(JAVA_MANFILES)
@@ -221,7 +221,6 @@
-rm -f $(docobjdir)/gij.1
-rm -f $(docobjdir)/jv-convert.1
-rm -f $(docobjdir)/grmic.1
- -rm -f $(docobjdir)/grmiregistry.1
-rm -f $(docobjdir)/gcj-dbtool.1
-rm -f $(docobjdir)/gc-analyze.1
#
@@ -334,7 +333,7 @@
$(TEXI2HTML) -I $(gcc_docdir)/include -I $(srcdir)/java -o $(@D) $<
.INTERMEDIATE: gcj.pod jcf-dump.pod gij.pod \
- jv-convert.pod grmic.pod grmiregistry.pod gcj-dbtool.pod gc-analyze.pod
+ jv-convert.pod grmic.pod gcj-dbtool.pod gc-analyze.pod
gcj.pod: java/gcj.texi
-$(TEXI2POD) -D gcj < $< > $@
@@ -346,8 +345,6 @@
-$(TEXI2POD) -D jv-convert < $< > $@
grmic.pod: java/gcj.texi
-$(TEXI2POD) -D grmic < $< > $@
-grmiregistry.pod: java/gcj.texi
- -$(TEXI2POD) -D grmiregistry < $< > $@
gcj-dbtool.pod: java/gcj.texi
-$(TEXI2POD) -D gcj-dbtool < $< > $@
gc-analyze.pod: java/gcj.texi
@@ -357,10 +354,10 @@
java.install-man: installdirs \
$(DESTDIR)$(man1dir)/$(JAVA_INSTALL_NAME)$(man1ext) \
$(JAVA_TARGET_INDEPENDENT_BIN_TOOLS:%=doc/%.1) \
- doc/gij.1 doc/jv-convert.1 doc/grmic.1 doc/grmiregistry.1 \
+ doc/gij.1 doc/jv-convert.1 doc/grmic.1 \
doc/gcj-dbtool.1 doc/gc-analyze.1
for tool in $(JAVA_TARGET_INDEPENDENT_BIN_TOOLS) \
- gij jv-convert grmic grmiregistry gcj-dbtool gc-analyze ; do \
+ gij jv-convert grmic gcj-dbtool gc-analyze ; do \
tool_transformed_name=`echo $$tool|sed '$(program_transform_name)'`; \
man_name=$(DESTDIR)$(man1dir)/$${tool_transformed_name}$(man1ext); \
rm -f $$man_name ; \
Index: gcc/java/gcj.texi
===================================================================
--- gcc/java/gcj.texi (revision 123217)
+++ gcc/java/gcj.texi (working copy)
@@ -19,9 +19,6 @@
@c When this manual is copyrighted.
@set copyrights-gcj 2001, 2002, 2003, 2004, 2005, 2006, 2007
-@c Versions
-@set which-gcj GCC-@value{version-GCC}
-
@copying
@c man begin COPYRIGHT
Copyright @copyright{} @value{copyrights-gcj} Free Software Foundation, Inc.
@@ -64,10 +61,6 @@
@dircategory Individual utilities
@direntry
-* gcjh: (gcj)Invoking gcjh.
- Generate header files from Java class files
-* gjnih: (gcj)Invoking gjnih.
- Generate JNI header files from Java class files
* jcf-dump: (gcj)Invoking jcf-dump.
Print information about Java class files
* gij: (gcj)Invoking gij. GNU interpreter for Java bytecode
@@ -77,8 +70,6 @@
Convert file from one encoding to another
* grmic: (gcj)Invoking grmic.
Generate stubs for Remote Method Invocation.
-* grmiregistry: (gcj)Invoking grmiregistry.
- The remote object registry.
* gc-analyze: (gcj)Invoking gc-analyze.
Analyze Garbage Collector (GC) memory dumps.
@end direntry
@@ -118,14 +109,11 @@
How you can share and copy this manual
* Invoking gcj:: Compiler options supported by @command{gcj}
* Compatibility:: Compatibility between gcj and other tools for Java
-* Invoking gcjh:: Generate header files from class files
-* Invoking gjnih:: Generate JNI header files from class files
* Invoking jcf-dump:: Print information about class files
* Invoking gij:: Interpreting Java bytecodes
* Invoking gcj-dbtool:: Tool for manipulating class file databases.
* Invoking jv-convert:: Converting from one encoding to another
* Invoking grmic:: Generate stubs for Remote Method Invocation.
-* Invoking grmiregistry:: The remote object registry.
* Invoking gc-analyze:: Analyze Garbage Collector (GC) memory dumps.
* About CNI:: Description of the Compiled Native Interface
* System properties:: Modifying runtime behavior of the libgcj library
@@ -730,236 +718,6 @@
@end itemize
-@node Invoking gcjh
-@chapter Invoking gcjh
-
-@c man title gcjh generate header files from Java class files
-
-@c man begin DESCRIPTION gcjh
-
-The @code{gcjh} program is used to generate header files from class
-files. It can generate both CNI and JNI header files, as well as stub
-implementation files which can be used as a basis for implementing the
-required native methods.
-
-@c man end
-
-@ignore
-@c man begin SYNOPSIS gcjh
-gcjh [@option{-stubs}] [@option{-jni}]
- [@option{-force}] [@option{-old}] [@option{-trace}] [@option{-J} @var{option}]
- [@option{-add} @var{text}] [@option{-append} @var{text}] [@option{-friend} @var{text}]
- [@option{-prepend} @var{text}]
- [@option{--classpath}=@var{path}] [@option{--CLASSPATH}=@var{path}]
- [@option{--bootclasspath}=@var{path}]
- [@option{-I}@var{dir}@dots{}] [@option{-d} @var{dir}@dots{}]
- [@option{-o} @var{file}] [@option{-td} @var{dir}]
- [@option{-M}] [@option{-MM}] [@option{-MD}] [@option{-MMD}]
- [@option{--version}] [@option{--help}] [@option{-v}] [@option{--verbose}]
- @var{classname}@dots{}
-@c man end
-@c man begin SEEALSO gcjh
-gcc(1), gcj(1), gij(1), jcf-dump(1), gfdl(7),
-and the Info entries for @file{gcj} and @file{gcc}.
-@c man end
-@end ignore
-
-@c man begin OPTIONS gcjh
-
-@table @gcctabopt
-@item -stubs
-This causes @code{gcjh} to generate stub files instead of header files.
-By default the stub file will be named after the class, with a suffix of
-@samp{.cc}. In JNI mode, the default output file will have the suffix
-@samp{.c}.
-
-@item -jni
-This tells @code{gcjh} to generate a JNI header or stub. By default,
-CNI headers are generated.
-
-@item -force
-This option forces @code{gcjh} to write the output file.
-
-@item -old
-This option is accepted but ignored for compatibility.
-
-@item -trace
-This option is accepted but ignored for compatibility.
-
-@item -J @var{option}
-This option is accepted but ignored for compatibility.
-
-@item -add @var{text}
-Inserts @var{text} into the class body. This is ignored in JNI mode.
-
-@item -append @var{text}
-Inserts @var{text} into the header file after the class declaration.
-This is ignored in JNI mode.
-
-@item -friend @var{text}
-Inserts @var{text} into the class as a @code{friend} declaration.
-This is ignored in JNI mode.
-
-@item -prepend @var{text}
-Inserts @var{text} into the header file before the class declaration.
-This is ignored in JNI mode.
-
-@item --classpath=@var{path}
-@itemx --CLASSPATH=@var{path}
-@itemx --bootclasspath=@var{path}
-@itemx -I@var{directory}
-@itemx -d @var{directory}
-@itemx -o @var{file}
-These options are all identical to the corresponding @command{gcj} options.
-
-@item -o @var{file}
-Sets the output file name. This cannot be used if there is more than
-one class on the command line.
-
-@item -td @var{directory}
-Sets the name of the directory to use for temporary files.
-
-@item -M
-Print all dependencies to stdout; suppress ordinary output.
-
-@item -MM
-Print non-system dependencies to stdout; suppress ordinary output.
-
-@item -MD
-Print all dependencies to stdout.
-
-@item -MMD
-Print non-system dependencies to stdout.
-
-@item --help
-Print help about @code{gcjh} and exit. No further processing is done.
-
-@item --version
-Print version information for @code{gcjh} and exit. No further
-processing is done.
-
-@item -v, --verbose
-Print extra information while running.
-@end table
-
-All remaining options are considered to be names of classes.
-
-@c man end
-
-@node Invoking gjnih
-@chapter Invoking gjnih
-
-@c man title gjnih generate JNI header files from Java class files
-
-@c man begin DESCRIPTION gjnih
-
-The @code{gjnih} program is used to generate JNI header files from class
-files. Running it is equivalent to running @code{gcjh -jni}.
-
-@c man end
-
-@ignore
-@c man begin SYNOPSIS gjnih
-gjnih [@option{-stubs}] [@option{-jni}]
- [@option{-force}] [@option{-old}] [@option{-trace}] [@option{-J} @var{option}]
- [@option{-add} @var{text}] [@option{-append} @var{text}] [@option{-friend} @var{text}]
- [@option{-prepend} @var{text}]
- [@option{--classpath}=@var{path}] [@option{--CLASSPATH}=@var{path}]
- [@option{--bootclasspath}=@var{path}]
- [@option{-I}@var{dir}@dots{}] [@option{-d} @var{dir}@dots{}]
- [@option{-o} @var{file}] [@option{-td} @var{dir}]
- [@option{-M}] [@option{-MM}] [@option{-MD}] [@option{-MMD}]
- [@option{--version}] [@option{--help}] [@option{-v}] [@option{--verbose}]
- @var{classname}@dots{}
-@c man end
-@c man begin SEEALSO gjnih
-gcc(1), gcj(1), gcjh(1), gij(1), jcf-dump(1), gfdl(7),
-and the Info entries for @file{gcj} and @file{gcc}.
-@c man end
-@end ignore
-
-@c man begin OPTIONS gjnih
-
-@table @gcctabopt
-@item -stubs
-This causes @code{gjnih} to generate stub files instead of header files.
-By default the stub file will be named after the class, with a suffix of
-@samp{.c}.
-
-@item -jni
-This option specifies the default behavior which is to generate a JNI
-header or stub.
-
-@item -force
-This option forces @code{gjnih} to write the output file.
-
-@item -old
-This option is accepted but ignored for compatibility.
-
-@item -trace
-This option is accepted but ignored for compatibility.
-
-@item -J @var{option}
-This option is accepted but ignored for compatibility.
-
-@item -add @var{text}
-Inserts @var{text} into the class body. This is ignored in by
-@code{gjnih}.
-
-@item -append @var{text}
-Inserts @var{text} into the header file after the class declaration.
-This is ignored in by @code{gjnih}.
-
-@item -friend @var{text}
-Inserts @var{text} into the class as a @code{friend} declaration.
-This is ignored by @code{gjnih}.
-
-@item -prepend @var{text}
-Inserts @var{text} into the header file before the class declaration.
-This is ignored in by @code{gjnih}.
-
-@item --classpath=@var{path}
-@itemx --CLASSPATH=@var{path}
-@itemx --bootclasspath=@var{path}
-@itemx -I@var{directory}
-@itemx -d @var{directory}
-@itemx -o @var{file}
-These options are all identical to the corresponding @command{gcj} options.
-
-@item -o @var{file}
-Sets the output file name. This cannot be used if there is more than
-one class on the command line.
-
-@item -td @var{directory}
-Sets the name of the directory to use for temporary files.
-
-@item -M
-Print all dependencies to stdout; suppress ordinary output.
-
-@item -MM
-Print non-system dependencies to stdout; suppress ordinary output.
-
-@item -MD
-Print all dependencies to stdout.
-
-@item -MMD
-Print non-system dependencies to stdout.
-
-@item --help
-Print help about @code{gjnih} and exit. No further processing is done.
-
-@item --version
-Print version information for @code{gjnih} and exit. No further
-processing is done.
-
-@item -v, --verbose
-Print extra information while running.
-@end table
-
-All remaining options are considered to be names of classes.
-
-@c man end
-
@node Invoking jcf-dump
@chapter Invoking jcf-dump
@@ -1378,42 +1136,6 @@
@c man end
-@node Invoking grmiregistry
-@chapter Invoking grmiregistry
-
-@c man title grmiregistry Remote object registry
-
-@c man begin SYNOPSIS grmiregistry
-@command{grmic} [@option{OPTION}] @dots{} [@var{port}]
-@ignore
- [@option{--help}]
- [@option{--version}]
-@end ignore
-@c man end
-
-@c man begin DESCRIPTION grmiregistry
-
-@command{grmiregistry} starts a remote object registry on the current
-host. If no port number is specified, then port 1099 is used.
-
-@c FIXME: Add real information here.
-@c This really isn't much more than the --help output.
-
-@c man end
-
-@c man begin OPTIONS grmiregistry
-
-@table @gcctabopt
-@item --help
-Print a help message, then exit.
-
-@item --version
-Print version information, then exit.
-@end table
-
-@c man end
-
-
@node Invoking gc-analyze
@chapter Invoking gc-analyze
Index: libjava/classpath/doc/Makefile.am
===================================================================
--- libjava/classpath/doc/Makefile.am (revision 123217)
+++ libjava/classpath/doc/Makefile.am (working copy)
@@ -23,6 +23,7 @@
gjar.1 \
gjarsigner.1 \
gjavah.1 \
+ gcjh.1 \
gkeytool.1 \
gnative2ascii.1 \
gorbd.1 \
@@ -55,7 +56,7 @@
.INTERMEDIATE: gappletviewer.pod gjarsigner.pod gjar.pod gjavah.pod \
gkeytool.pod gnative2ascii.pod gorbd.pod grmid.pod grmiregistry.pod \
- gserialver.pod gtnameserv.pod
+ gserialver.pod gtnameserv.pod gcjh.pod
gappletviewer.pod: $(srcdir)/cp-tools.texinfo
-$(TEXI2POD) -D gappletviewer < $< > $@
@@ -66,6 +67,9 @@
gjar.pod: $(srcdir)/cp-tools.texinfo
-$(TEXI2POD) -D gjar < $< > $@
+gcjh.pod: $(srcdir)/cp-tools.texinfo
+ -$(TEXI2POD) -D gcjh < $< > $@
+
gjavah.pod: $(srcdir)/cp-tools.texinfo
-$(TEXI2POD) -D gjavah < $< > $@
Index: libjava/classpath/doc/cp-tools.texinfo
===================================================================
--- libjava/classpath/doc/cp-tools.texinfo (revision 123217)
+++ libjava/classpath/doc/cp-tools.texinfo (working copy)
@@ -1,7 +1,7 @@
\input texinfo @c -*-texinfo-*-
@c %**start of header
-@setfilename tools.info
+@setfilename cp-tools.info
@settitle GNU Classpath Tools Guide
@c %**end of header
@@ -22,7 +22,7 @@
This file documents the Tools included in a standard distribution of the GNU
Classpath project deliverables.
-Copyright (C) 2006 Free Software Foundation, Inc.
+Copyright (C) 2006, 2007 Free Software Foundation, Inc.
@ifnotplaintext
@dircategory GNU Libraries
@@ -127,6 +127,7 @@
* jar Tool:: Archive tool for Java archives
* javah Tool:: A java header compiler
+* gcjh Tool:: A java header compiler (old version)
* native2ascii Tool:: An encoding converter
* orbd Tool:: An object request broker daemon
* serialver Tool:: A serial version command
@@ -1215,12 +1216,13 @@
@chapter Other Tools
This is a list of currently undocumented classpath tools: @b{jar},
-@b{javah}, @b{native2ascii}, @b{orbd}, @b{serialver}, @b{rmid}, @b{rmiregistry}
+@b{javah}, @b{gcjh}, @b{native2ascii}, @b{orbd}, @b{serialver}, @b{rmid}, @b{rmiregistry}
and @b{tnameserv}.
@menu
* jar Tool:: Archive tool for Java archives
* javah Tool:: A java header compiler
+* gcjh Tool:: A java header compiler (old version)
* native2ascii Tool:: An encoding converter
* orbd Tool:: An object request broker daemon
* serialver Tool:: A serial version command
@@ -1324,7 +1326,7 @@
@comment ----------------------------------------------------------------------
-@node javah Tool, native2ascii Tool, jar Tool, Other Tools
+@node javah Tool, gcjh Tool, jar Tool, Other Tools
@comment node-name, next, previous, up
@section The @command{javah} Tool
@c man title gjavah - generate header files from Java class files
@@ -1407,8 +1409,74 @@
@comment ----------------------------------------------------------------------
-@node native2ascii Tool, orbd Tool, javah Tool, Other Tools
+@node gcjh Tool, native2ascii Tool, javah Tool, Other Tools
@comment node-name, next, previous, up
+@section The @command{gcjh} Tool
+@c man title gcjh - generate header files from Java class files
+
+@c man begin DESCRIPTION gcjh
+
+The @code{gcjh} program is used to generate header files from class
+files. It can generate both CNI and JNI header files, as well as stub
+implementation files which can be used as a basis for implementing the
+required native methods. It is similar to @code{javah} but has
+slightly different command line options, and defaults to CNI.
+
+@c man end
+
+@ignore
+@c man begin SYNOPSIS gcjh
+gcjh [@var{OPTIONS}]@dots{} @var{CLASS}@dots{}
+@c man end
+@end ignore
+
+@c man begin OPTIONS gcjh
+
+See @code{javah} for a full description; this page only lists the
+additional options provided by @code{gcjh}.
+
+CNI text options
+@table @gcctabopt
+@item -add @var{text}
+Insert @var{text} into class body.
+@item -append @var{text}
+Append @var{text} after class declaration.
+@item -friend @var{text}
+Insert @var{text} as a @code{friend} declaration.
+@item -prepend @var{text}
+Insert @var{text} before start of class.
+@end table
+
+Compatibility options (unused)
+@table @gcctabopt
+@item -td @var{DIR}
+@itemx -M
+@itemx -MM
+@itemx -MD
+@itemx -MMD
+Unused compatibility option.
+@end table
+
+
+Standard options:
+@table @gcctabopt
+@item -help
+Print help text, then exit.
+@item -version
+Print version number, then exit.
+@item -J@var{OPTION}
+Pass argument to the Java runtime.
+@end table
+@c man end
+
+@c man begin SEEALSO gcjh
+javac(1), javah(1), @dots{}
+@c man end
+
+@comment ----------------------------------------------------------------------
+
+@node native2ascii Tool, orbd Tool, gcjh Tool, Other Tools
+@comment node-name, next, previous, up
@section The @command{native2ascii} Tool
@c man title gnative2ascii - An encoding converter
@@ -1553,7 +1621,8 @@
@c man begin DESCRIPTION grmid
-To be written @dots{}
+@command{rmiregistry} starts a remote object registry on the current
+host. If no port number is specified, then port 1099 is used.
@c man end