[m-dev.] documentation for pragma fact_table

Fergus Henderson fjh at cs.mu.oz.au
Tue Mar 4 19:43:14 AEDT 1997


David Matthew OVERTON, you wrote:
> 
> Added documentation for `pragma fact_table's to the user guide and
> reference manual.  The additions are commented out at the moment.
> 
> doc/reference_manual.texi:
> 	Added a new (commented out) section describing the
> 	`fact_table' pragma.  

My view is that `pragma fact_table' should not be part of the language,
but should instead be considered as an implementation-specific extension.
Hence, it should be documented in the user's guide, not in the language
reference manual.

However, the language reference manual should be modified to say that
implementations may add implementation-specific pragmas.

> + at c * Large Tables of Facts		Large tables of facts can be compiled
> + at c				using a different algorithm that is
> + at c				more efficient and produces more
> + at c				efficient code.
>  * Obsolescence::		Library developers can declare old versions

You need a `::' after the menu entry.

> + at c @sp 1
> + at c @item --fact-table-hash-percent-full @var{percentage}
> + at c Specify how full the @samp{pragma fact_table} hash tables should be
> + at c allowed to get.  Given as an integer percentage (valid range: 1 to 100,
> + at c default: 90).

You should explain the advantages/disadvantages of a higher/lower setting.

-- 
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.



More information about the developers mailing list