@SlowPath renaming discussion

[Christian Humer]

On Mon, Sep 29, 2014 at 5:51 PM, Mick Jordan <mick.jordan at oracle.com> wrote:

> On 9/29/14, 3:09 AM, Andreas Woess wrote:
>
>> Isn't this more of a documentation issue than anything else? No matter
>> the name, someone who hasn't used Truffle before most likely doesn't know
>> the meaning of the annotation and when and where to put it. You have to be
>> aware of Truffle's partial evaluation and its entry and exit points.
>>
> I second that. All Truffle annotations should have extensive Javadoc
> describing their semantics, and then the exact form of the name is less
> important. It is generally impossible to come up with succint names that
> convey all the semantics.


I agree. Part of the work will be to provide proper documentation.

The naming discussion also has the purpose of getting an idea how the
documentation should look like. For example if we decide that we name it
 @PlatformCode or something similar, its clear that we wanna hide the fact
that partial evaluation is involved. If we decide to name it @PEBoundary we
should at least link to something that explains partial evaluation.


- Christian Humer