Subject: Re: DirectC: C layer - naming convention
From: Michael Rohleder (michael.rohleder@motorola.com)
Date: Wed Jan 15 2003 - 01:15:46 PST
Andrzej, Doug, Swapnajit,
thanks for this attempt to provide a consistent and nice API with proper namings. I think this is nasty, but important.
My humble opinion on this is simple:
. Motorola has spent man years of discussion in its internal standardization efforts and other work on such topics; there is still
debate and it comes up whenever there are new members in a working group.
. At the end of the day one naming conventions is as good as the other; it is and will always be a matter of taste.
. My take on this are two simple requirements:
- the naming convention should be documented for further reference
- the naming convention should be used consistently throughout at least each work package (DirectC, AssAPI, CovAPI)
Besides all this each convention has its pro's and cons' and I would like to ask Swapnajit whether it is possible to call for a
simple vote on the personal preferences and then end any discussion on this. I am sorry, but I am really tired (from my history
within my company) about such discussions.
-Michael
Andrzej Litwiniuk wrote:
> > This proposal sounds fine to me.
> > I like the idea of staying consistent with VPI.
> > It doesn't seem like it would be distracting or take
> > anything away from our DirectC API.
> >
> > Regards,
> > Doug
>
> It will come with a price: an increased length.
> Compare the two versions of the function name:
>
> svPutBitArrElemVec32
> vs.
> sv_put_bit_arr_elem_vec32
>
> Besides, svLeft is more similar to $Left than sv_left is.
>
> Guys, what do you prefer?
>
> Andrzej
>
> > > -----Original Message-----
> > > From: Andrzej Litwiniuk [mailto:Andrzej.Litwiniuk@synopsys.com]
> > > Subject: DirectC: C layer - naming convention
> > >
> > > Joao's document on assertions API specifies the naming convention:
> > >
> > > 1. all names will be prefixed by ...
> > > 2. type name will start with ... followed by Capitalized words
> > > with no separators, eg vpiAssertCheck
> > > 3. all function names will start with ... followed by
> > > all lowercase
> > > words separated by '_', eg vpi_get_assert_info()
> > >
> > > (there is no convention for macros and #defined
> > > symbolic constants)
> > >
> > > Shall we follow similar convention for DirectC C Layer?
--NOTE: The content of this message may contain personal views which are not neccessarily the views of Motorola, unless specifically stated.
___________________________________________________ | | _ | Michael Rohleder Tel: +49-89-92103-259 | _ / )| Software Technologist Fax: +49-89-92103-680 |( \ / / | Motorola, Semiconductor Products, System Design | \ \ _( (_ | _ Schatzbogen 7, D-81829 Munich, Germany _ | _) )_ (((\ \>|_/ > < \_|</ /))) (\\\\ \_/ / mailto:Michael.Rohleder@motorola.com \ \_/ ////) \ /_______________________________________________\ / \ _/ \_ / / / \ \
The information contained in this email has been classified as: Motorola General Business Information (x) Motorola Internal Use Only ( ) Motorola Confidential Proprietary ( )
*** This note may contain Motorola Confidential Proprietary or Motorola Internal Use Only Information and is intended to be reviewed by only the individual or organization named above. If you are not the intended recipient or an authorized representative of the intended recipient, you are hereby notified that any review, dissemination or copying of this email and its attachments, if any, or the information contained herein is prohibited. If you have received this email in error, please immediately notify the sender by return email and delete this email from your system. Thank you! ***
This archive was generated by hypermail 2b28 : Wed Jan 15 2003 - 01:16:44 PST