JavaMemoryModel: Javadoc terminology for synchronization

From: Bill Pugh (pugh@cs.umd.edu)
Date: Thu Apr 01 2004 - 09:55:21 EST


After talking with Doug, and reviewing the options that have been
suggested,
we are both leaning towards "synchronizes with" for javadoc-level
descriptions
of synchronization semantics.

To avoid the problem that "synchronizes with" sound symmetric, it
should always
be used in a context such as

        ... synchronizes with (a | any | all) (preceding | following) ...

For example,
        A write to a volatile synchronizes with all following reads of that
volatile.

        Interrupting a thread synchronizes with all following events that
        detect that the thread has been interrupted (e.g., the interrupted
        thread throwing an InterruptedException, or a invocation of
interrupted()
        returning true).

Doug and I both felt that terminology such as "makes visible to" or
"is ordered before" wouldn't be well suited towards the target audience
for JavaDoc.

We are still open to suggestions if you come up with a really good one.

        Bill

-------------------------------
JavaMemoryModel mailing list - http://www.cs.umd.edu/~pugh/java/memoryModel



This archive was generated by hypermail 2b29 : Thu Oct 13 2005 - 07:01:02 EDT