Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [servlet-dev] References to old versions of the Spec

As an example, here's our updated Revision History for the Platform spec that we did for Jakarta EE 8...  Very brief explanation of what type of changes we did for Jakarta EE 8, and we removed all of the old history.

Appendix C: Revision History
C.1. Changes in Final Release Draft
C.1.1. Editorial Changes
• Changed most instances of "Java EE" to "Jakarta EE", except where the previous technology was clearly the target.
• Modified references to OracleTM-related items per the documented guidelines.
• Added "Specification Comparison" appendix.
• Updated “Related Documents" appendix.


---------------------------------------------------
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:        Stuart Douglas <sdouglas@xxxxxxxxxx>
To:        servlet developer discussions <servlet-dev@xxxxxxxxxxx>
Date:        02/03/2020 14:06
Subject:        [EXTERNAL] Re: [servlet-dev] References to old versions of the Spec
Sent by:        servlet-dev-bounces@xxxxxxxxxxx






On Mon, 3 Feb 2020 at 23:18, Mark Thomas <markt@xxxxxxxxxx> wrote:

On 31/01/2020 18:37, Bill Shannon wrote:
> The history / change log should be removed, or rather cleared out and
> added to going forward.

Just to clarify, do you mean this section should be empty or should it
contain a single line (assuming it is the only change) that says that,
compared to Servlet 4.0, the packages have been renamed from javax to
jakarta ?

If the answer to the above question is yes then I guess we'd need
another line for "cosmetic only formatting/layout changes as a result of
importing the specification text"



Do we really want to do that? It has been moved from one system to another, so this would be a huge amount of work for and I don't really see any value in it.
 


Mark


>
> Mark Thomas wrote on 1/30/20 3:20 AM:
>> On 30/01/2020 10:59, Stuart Douglas wrote:
>>> I just started to look at cleaning up the spec document, and the first
>>> thing I noticed is that is contains a lot of references to old versions
>>> of the Servlet spec, e.g things like.
>>>
>>> 'New since version 2.4 of the Java Servlet
>>> specification is the ability to configure filters to be invoked under
>>> request dispatcher _forward()_ and _include()_ calls.'
>>>
>>> Also the full changelog etc.
>>>
>>> Do we need to keep all these references to what had changed in previous
>>> specs?
>>
>> I kept them for EL and WebSocket but I suspect they were shorter and
>> less work to update.
>>  
>>> I think we should make a clean break for a couple of reasons:
>>>
>>> - It makes the spec smaller and easier to maintain
>>> - These historical references no longer really make sense, as this is a
>>> new namespace so largely a new spec
>>> - If anyone is interested in the history they can refer to the old
>>> Servlet 4.0 spec
>>
>> I don't have a strong feeling one way or the other. I'm happy following
>> the majority. If we do drop the history, I do think we should have a
>> pointer to the 4.0 spec somewhere so readers can find it if they
>> need/want to.
>>
>> Mark
>>
>>
>>> Note that I am not saying we should not have a change log for changes
>>> going forward, but just that I don't really see the value in cleaning up
>>> references to history that are not really part of the same spec anymore.
>>>
>>> Stuart
>>>
>>> _______________________________________________
>>> servlet-dev mailing list
>>>
servlet-dev@xxxxxxxxxxx
>>> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
>>>
https://www.eclipse.org/mailman/listinfo/servlet-dev
>>>
>>
>> _______________________________________________
>> servlet-dev mailing list
>>
servlet-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
>>
https://www.eclipse.org/mailman/listinfo/servlet-dev
>>

_______________________________________________
servlet-dev mailing list

servlet-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit

https://www.eclipse.org/mailman/listinfo/servlet-dev_______________________________________________
servlet-dev mailing list
servlet-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/servlet-dev



Back to the top