[m-dev.] for review: Aditi documentation

[Fergus Henderson]

On 21-Jul-1998, Simon Taylor <stayl at cs.mu.OZ.AU> wrote:
>  
> +Some useful predicates are defined in @file{aditi/aditi.m} in the
> + at samp{extras} distribution.

This should be modified as described in my comments last time.

> + at example
> +:- pragma aditi_memo(@var{Name}/@var{Arity}).
> +:- pragma aditi_no_memo(@var{Name}/@var{Arity}).
> + at end example
> +
> +The Aditi deductive database can store the results of procedures within
> +a transaction to avoid unnecessary recomputations. This is unrelated to
> +the type of memoing described in @ref{Tabled evaluation}.
> + at samp{no_memo} is the default.

s/no_memo/aditi_no_memo/

> @@ -170,6 +180,9 @@
>  Files ending in @file{.dep} are automatically-generated Makefile fragments
>  which contain the rules for an entire program.
>  
> +Files ending in @file{.rlo} are Aditi-RL bytecode files, which are
> +executed by the Aditi deductive database system (@pxref{Using Aditi}).

That should be inside `@ifset aditi'.

(Otherwise the cross-reference will be a dangling reference, among other
reasons.  Did you test that `mmake' in the doc directory still works if
aditi is not set?)

> @@ -841,7 +854,7 @@
>  removes the @samp{.int}, @samp{.int0}, @samp{.int2},
>  @samp{.int3}, @samp{.opt}, @samp{.trans_opt},
>  @samp{.date}, @samp{.date0}, @samp{.date3}, @samp{.optdate},
> - at samp{.trans_opt_date},
> + at samp{.trans_opt_date}, @samp{.rlo},
>  @samp{.d}, and @samp{.dep} belonging to one of the modules of the program,
>  and also the various possible executables for the program ---
>  @samp{@var{main-module}},

Ditto.

> +These optimizations are applied to the Aditi-RL code produced
> +for predicates with @samp{:- pragma aditi(...)} declarations

Texinfo has `@dots{}' for `...'.  Please use it here.

> + at sp 1
> + at item --filenames-from-stdin
> +Read then compile a newline terminated module name from the standard input.

The option name says "filenames", but the description says "module name" --
which is it?

Probably it ought to allow either.  If that is in fact the case,
then please s/module name/module name or file name/

> +Repeat this until EOF is reached. This allows a program or user to
> +interactively compile several modules without the overhead of process
> +creation for each one.

I suggest putting the last sentence in parentheses.

Otherwise that looks fine.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
WWW: <http://www.cs.mu.oz.au/~fjh>  |  of excellence is a lethal habit"
PGP: finger fjh at 128.250.37.3        |     -- the last words of T. S. Garp.