Open MPI logo

Open MPI Development Mailing List Archives

  |   Home   |   Support   |   FAQ   |   all Development mailing list

Subject: Re: [OMPI devel] "prefix" style guideline
From: Eugene Loh (Eugene.Loh_at_[hidden])
Date: 2009-07-09 14:17:16


Jeff Squyres wrote:

> On Jul 8, 2009, at 2:17 PM, Eugene Loh wrote:
>
>> In https://svn.open-mpi.org/trac/ompi/wiki/CodingStyle , there is
>> mention of "the prefix rule." What is this rule?
>
> In components, you have to prefix all public symbols with
> "<layer>_<framework>_<component>", where <layer> is one of "mca",
> "ompi", "orte", or "opal" ("mca" used to be used, but it has fallen
> out of favor; "ompi", "orte", and "opal" are a bit more common these
> days -- but still the bulk of existing code probably uses "mca").

The wiki said all public symbols and filenames. I assume filenames may
leave off "<layer>_". That is, the file is properly named btl_sm.c
rather than mca_btl_sm.c or ompi_btl_sm.c. Right?

>> P.S. Shouldn't the "prefix rule" be explained in the "coding style"
>> twiki page?
>
> Why?

So that we'd be clear.

> Then we'd be *clear*...

Doh!

> I'd volunteer to add something, but I'm heading out on vacation
> tomorrow afternoon, and have a bagillion things to finish before then
> -- would you mind adding something?

As you have spoken, so has it been done. And, if someone would confirm
the filename issue above, I'll update accordingly. Thanks for all the
answers. Patch for 1962 on its way.