[m-rev.] For review: update the documentation for the Java grade

[Fergus Henderson]

On 11-Feb-2004, James Goddard <goddardjames at yahoo.com> wrote:
> Estimated hours taken: 0.2
> Branches: main
> 
> Update documentation for Java grade.
> 
> README.Java:
> 	Update the list of implemented modules.  Include list of
> 	incompletely implemented predicates.
> 
> 
> Index: README.Java
> ===================================================================
> RCS file: /home/mercury1/repository/mercury/README.Java,v
> retrieving revision 1.3
> diff -u -d -r1.3 README.Java
> --- README.Java	10 Feb 2004 12:43:20 -0000	1.3
> +++ README.Java	11 Feb 2004 04:09:33 -0000
> @@ -131,14 +131,31 @@
>  
>  A. The following standard library modules are completely unimplemented:
>  
> -	benchmarking
>  	construct
>  	deconstruct
> -	store
>  	type_desc
>  
>     Type classes are not yet fully supported, nor are Mercury-level debugging
>     and profiling for the Java back-end.
> +
> +   In addition, the following individual procedures are incompletely
> +   implemented:
> +
> +	benchmarking.report_stats/0:
> +	benchmarking.report_full_memory_stats/0:
> +		Memory usage statistics are not yet available, and cpu time
> +		is obtained via native code as per time.m.
> +
> +	store.arg_ref/5:
> +	store.new_arg_ref/5:
> +		Due to the absence of RTTI, type-checking is missing for these
> +		predicates.  They should be used with care.

s/type-checking/dynamic type checking/

> +	time.clock/3:
> +	time.clocks_per_sec/0:
> +	time.times/7:
> +	time.clk_tck/0:
> +		Currently use native code, sacrificing some portability.

Here I think it is important to explain where the blame lies -- the problem
is Java's fault, not ours.  So I suggest 

	Because the current Java APIs do not provide any way of
	implementing these procedures in pure Java, we have implemented
	them using a native code library implemented in C and accessed
	via JNI.  This approach sacrifices some portability.


Otherwise that looks good, thanks.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------