RFC: 8247976: Update HotSpot Style Guide for C++14 adoption
Kim Barrett
kim.barrett at oracle.com
Wed Jul 1 17:16:20 UTC 2020
> On Jun 28, 2020, at 8:08 PM, David Holmes <david.holmes at oracle.com> wrote:
>
> Hi Kim,
>
> Updates look good. One minor nit, titles should not use abbreviations that have not yet been defined
>
> e.g.
>
> #### RTTI (Runtime Type Information)
>
> should just be
>
> #### Runtime Type Information
>
> (you don't introduce abbreviations in headings/titles either).
>
> And:
>
> #### Expression SFINAE
>
> also needs fixing - though simply expanding SFINAE doesn't really make sense as it seems to be being used as a verb, which seems odd in itself. I don't know how to rewrite that title in a meaningful way. I suppose one way around this would be to say:
>
> #### Expression "SFINAE"
>
> though even that is a stretch.
I'm going to claim these are not abbreviations in the usual sense, but
rather are well-known terms of art. And this document is not targeted
at an audience unskilled in the art.
That's particularly true for SFINAE; I suspect most people (including
me) have to stop and think about it to correctly recall its expansion,
and nobody actually uses or cares about the expansion. Even more so
for "Expression SFINAE"; one would never say or write "Expression
Substitution Failure...".
Books on C++ (such as Dewhurst's "C++ Common Knowledge") will give the
expansion almost as an aside, but "SFINAE" is the section title and
index entry.
I'm considering going back to always using the "term" in normal text,
with a parenthetical expansion on first use. I find the latest
approach jarring, as the specialized terms are the normal usage.
More information about the hotspot-dev
mailing list