Re: [jakartaee-spec-project-leads] Removing version numbers when referen

["Kevin Sutter" <sutter@xxxxxxxxxx>]

Tom,
Within the text
of the specification documents, I would not include the version numbers
of referenced specifications.  For example, in your example PR, the
Transactions specification should not update the text to reference "Jakarta
Enterprise Beans 4.0".  You should leave this as a generic reference
to "Jakarta Enterprise Beans".  Normally, Specifications
will have a "References" section at the end of the document.
 This section could (should?) contain URL references to specific versions.
 

(There may be
exceptions to this rule, but this is the general direction that I have
seen and pursued in other Spec documents.)

---------------------------------------------------
Kevin Sutter 
STSM, MicroProfile and Jakarta EE architect @ IBM
e-mail:  sutter@xxxxxxxxxx     Twitter:  @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)    
LinkedIn: https://www.linkedin.com/in/kevinwsutter



From:
       Scott
Stark <starksm64@xxxxxxxxx>
To:
       JakartaEE
Spec Project Leadership discussions <jakartaee-spec-project-leads@xxxxxxxxxxx>
Date:
       09/28/2020
12:17
Subject:
       [EXTERNAL]
Re: [jakartaee-spec-project-leads] Removing version numbers when referencing
other specifications?
Sent
by:        jakartaee-spec-project-leads-bounces@xxxxxxxxxxx

---

Certainly the version of the spec itself
is needed to identify what it is when released since it can be copied around
and should be self contained. I can't see the change you reference, so
I'm not sure what other places you are asking about a version being used.

On Mon, Sep 28, 2020 at 8:28 AM Tom Jenkinson
<tom.jenkinson@xxxxxxxxxx>
wrote:
Sorry, I missed something in the PR that
I think the expectation is to leave a reference to the version number,
just to remove the repeated use of the version number. I think that is
good.

On Mon, 28 Sep 2020 at 10:25, Tom Jenkinson
<tom.jenkinson@xxxxxxxxxx>
wrote:
Hi,

Does anyone see a problem with removing
the version numbers of the specifications that a specification depends
upon?

I would assume that they may have been
added in case there was a minimal functionality present in the version
referenced but I am not sure. For instance, with the current specifications
maybe this could usefully be described as implying that the specification
requires versions of the spec that have had the Jakarta namespace change?

We have had a pull request with a commit
[1] to update in this manner so I would like to verify if that is inconsistent
with other specifications or whether people are aware of a reason to not
approve it.

Many thanks,
Tom

[1] https://github.com/eclipse-ee4j/jta-api/pull/176/commits/5770d32e95e403a51cc51d2f4b068ba11ef3a56f

_______________________________________________
jakartaee-spec-project-leads mailing list
jakartaee-spec-project-leads@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads_______________________________________________
jakartaee-spec-project-leads mailing list
jakartaee-spec-project-leads@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-spec-project-leads