Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakartaee-spec-project-leads] [ee4j-pmc] Preparing for Jakarta EE 8 Release
One way to deal with it is to add a clause like the following at the start of the javadoc so that one knows 

"References in this document to JTA refers to the  Java Transaction API unless otherwise noted.”

In terms of the @since stuff, what Lukas suggested doing by simply deleting the acronym usage as it obvious what spec is being talked about.

On Jul 12, 2019, at 4:07 AM, Tom Jenkinson <tom.jenkinson@xxxxxxxxxx> wrote:



On Fri, 12 Jul 2019 at 11:54, Tom Jenkinson <tom.jenkinson@xxxxxxxxxx> wrote:
I have two questions about this:

On Wed, 3 Jul 2019 at 18:00, Ivar Grimstad <ivar.grimstad@xxxxxxxxx> wrote:
Hi, 

First, a message to all the specification project leads:
You are strongly encouraged to join this mailing list:

We are on a tight schedule to get the Jakarta EE specifications ready for the Jakarta EE 8 Release. I am in the process of creating GitHub issues in the projects that will be followed up here: https://github.com/orgs/eclipse-ee4j/projects/15

If you don't have an issue created for you yet, please feel free to create an issue titled "Prepare Jakarta XXX for the Jakarta EE 8 Release" with the following content in your issue tracker:
-----
### Instructions

- [ ] Update text files

Should we be doing something about acronym usage within the Java source files too. 
For example:
a. @Since doclets such as https://github.com/eclipse-ee4j/jta-api/blob/EE4J_8/src/main/java/javax/transaction/Transactional.java#L55 where we reference JTA 1.2 - personally I think that is fine as it is factual
b. Reference to old acronyms to describe the behaviours in the javadocs. For instance "JTA transaction" in https://github.com/eclipse-ee4j/jta-api/blob/EE4J_8/src/main/java/javax/transaction/Transactional.java#L77 could be changed to "Jakarta Transactions transaction"

I think b) is probably covered by https://jakarta.ee/legal/acronym_guidelines/ and should be changed

It is still not clear to be if a) is right to leave or not. Maybe I should change it from:
@Since JTA 1.2 to @Since Java Transaction API(A trademark of Oracle) API 1.2 or something like that?

Back to the top