GCJ manual changed

[Nic Ferrier]

Firstly, thanks for your proof reading. It's really useful.


"Joseph S. Myers" <jsm28@cam.ac.uk> writes:

> Diffs are generally preferred.  You also attached it as 
> application/texinfo; for text attachments, text/whatever types should be 
> used. 

Ok. I didn't know what the mime type was for texinfo.


> > @code{gcj} uses the same compiler technology as @code{g++} (the GNU 
>  
> Use @command to mark up command names. 

I have not changed these. This is what was already in the file. I'll
send a diff next time so you can see that's true.

I am not going to change things like this till the file is checked in
and we can get useful diffs from my changes.


> > You write CNI code as a regular C++ source file.  (You do have to use 
> > a Java/CNI-aware C++ compiler, specifically a recent version of @code{G++}.) 
>  
> @code{G++} is never appropriate; if it's a command, it's @command{g++}; if 
> not, G++ with no markup. 

Ok. As above. But I have changed this reference because it should be
"G++" not "@command{g++}".


> > And then must include one header file for each Java class it uses, eg: 
>  
> "eg" with no punctuation is not a proper spelling; it should be
> "e.g.". 

I have changed all the "eg"s to "e.g."s.


> > allows the program text to refer to @var{class-name} as a shorthand for  
> > the fully qualified name: @var{package-name}.@var{class-name}. 
>  
> You probably want @code{@var{package-name}.@var{class-name}} to get the 
> dot in the correct font. 

Done.


> > refered to only by it's class-name within the program text. 
>  
> The possessive is "its"; "it's" means "it is" or "it has". 

Done.

  
> > characters and booleans (and also the void type). C++ has it's own 
>  
> Two spaces after full stops in Texinfo input. 

Done.


> > When refering to a Java type You should always use these C++ typenames (e.g. @code{jint}) 
>  
> Full stops following lowercase letters not at the end of sentences must be 
> followed by @: or other punctuation, so you want "e.g.@:" or "e.g.,"
> here. 

Done.


> > The Gcj compiler inserts calls to @code{JvInitClass} at appropriate places to ensure that a 
>  
> You're using "Gcj" here, earlier you used "GCJ".  Be consistent.  (The 
> distinction between "GCJ" and "@command{gcj}" is that the first refers to 
> the Java compiler in general and the other specifically to the compilation 
> command.) 

Done.

 
> > insert these calls automatically - it is the programmer's 
>  
> TeX dashes - "---" with no spaces around it. 

Done.

 
> > Referencing a Java array in C++ code is done using the 
> > JArray template, which as defined as follows: 
>  
> I think this should be @code{JArray}. 

Done.

>  
> > @example 
> > JvNewBooleanArray 
> > @end example 
> >  
> > can be used to create an array of Java primitive boolean types. 
>  
> If this partial paragraph gets indented in the DVI output, you should 
> precede it by @noindent so that it doesn't. 

Done.


> > @deftypefun jbooleanArray JvNewBooleanArray (jint @var{length}) 
> > Create's an array @code{length} indices long. 
>  
> @var{length} (strictly, @code{@var{length}}). 

According to the texinfo manual this should be:

  @var{length}

which I've changed it to.

 
> > @deftypefun jstring JvNewStringUTF (const char* @var{bytes}) 
> > Returns a @code{String} which is made up of the UTF encoded characters 
>  
> You say "UTF", which UTF (there are several, e.g., UTF-8, UTF-16,
> UTF-32)? 

It should be obvious to a Java programmer. This is the same text as
the old CNI manual.


> > Normally, GNU C++ will automatically detect when you are writing C++ 
>  
> "GNU C++" is the name of the GNU language dialect rather than an 
> implementation; see codingconventions.html.  You probably want to say G++ 
> here. 

Done.


> > extern void bar();    // is implemented in Java and may throw exceptions 
>  
> Comments in examples, here and above, should be in @r{}. 

Done.


> > >From C++, it makes sense to use a destructor to release a lock. 
>  
> Anyone checking in this patch had better make sure the version they have 
> doesn't have the >From there.  Sending a proper patch rather than a new 
> version of the file would avoid >From problems. 

Ok. All you have to do is ask.


> > might become this C++ code: 
>  
> @noindent, as noted above, may be necessary here and elsewhere. 

Done.


> > Reflection is possible with CNI code, it functions similarly to how it 
> > functions with JNI. 
> >  
> > @c clean this up... I mean, what are the types jfieldID and jmethodID in JNI? 
> > The types @code{jfieldID} and @code{jmethodID} 
> > are as in JNI. 
>  
> @. for full stops at ends of sentences preceded by capital letters. 

Done.


  
I have attached the patch file with these changes in it.

If no one objects I will check this in so that we can then start
patching it.


Nic

-------------- next part --------------
A non-text attachment was scrubbed...
Name: gcj.texi.diff
Type: text/x-patch
Size: 29323 bytes
Desc: diff for gcj info manual
URL: <http://gcc.gnu.org/pipermail/java-patches/attachments/20020130/9ca40b3b/attachment.bin>