[m-dev.] for review: update c_coding_guidelines.html

[Fergus Henderson]

On 09-Feb-2000, Zoltan Somogyi <zs at cs.mu.OZ.AU> wrote:
> 
> > > > +<pre>
> > > > +	typedef struct Directory_Entry_Struct {
> > > > +		...
> > > > +	} DirectoryEntry;
> > > > +</pre>
> > > > +<font color="#000000">
> > > 
> > > This, and the other examples, should be changed to have an MR_ prefix.
> > 
> > The need for `MR_' or `ML_' prefixes is mentioned separately
> > (in section 4.5).
> 
> Yes, I know. However, that does not justify misleading examples.

But our coding guidelines only require `MR_' or `ML_' prefixes for
symbols that are exported.  If the `DirectoryEntry' type above is
defined in a `.c' file rather than a header file, then no prefix
is needed.  So the example is quite valid.

-- 
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.
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions:          mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------